# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Spade Universal Enrichment API
  version: 1.0.0
extends: openapi/spade-universal-enrichment-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/transactions/universal/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich a transaction of any type
      effect: write
      questions:
      - Can I enrich aggregator, card and ACH transactions through one endpoint without knowing the type?
      - What's the minimum I need to send to enrich a generic bank transaction description?
      - Can I override the money direction instead of inferring it from the amount sign?
      instructions:
      - text: 'Enrich the transaction "{description}" for user {userId}: {amount} {currencyCode} on {occurredAt}.'
        slots:
          description: requestBody.description
          userId: requestBody.userId
          amount: requestBody.amount
          currencyCode: requestBody.currencyCode
          occurredAt: requestBody.occurredAt
      - text: Run universal enrichment on aggregator transaction {transactionId} with direction {direction}.
        slots:
          transactionId: requestBody.transactionId
          direction: requestBody.direction
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batches/transactions/universal/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a batch of mixed transactions for enrichment
      effect: write
      questions:
      - How do I enrich a large mixed set of bank and card transactions in a single job?
      - Can a universal enrichment batch return results inline for small sets?
      instructions:
      - text: Submit these mixed-type transactions {transactions} as a universal batch and notify {callbackUrl}.
        slots:
          transactions: requestBody.transactions
          callbackUrl: requestBody.callbackUrl
      - text: Universally enrich this microbatch {transactions} with synchronous={synchronous}.
        slots:
          transactions: requestBody.transactions
          synchronous: query.synchronous
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batches/transactions/universal/enrich'].options
  update:
    x-apievangelist-phrasing:
      intent: Check the synchronous cap for universal batches
      effect: read
      questions:
      - What is the current synchronousMax for universal enrichment batches?
      - How many mixed transactions can I enrich inline in one request?
      instructions:
      - text: Fetch the current synchronous item cap for universal batch enrichment.
      - text: Read the metadata for the batch universal enrichment endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batches/{universalEnrichmentBatchId}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results of a universal enrichment batch
      effect: read
      questions:
      - How do I retrieve enriched transactions from a finished universal batch?
      - Where do universal enrichment batch results come back?
      instructions:
      - text: Fetch the enriched results of universal batch {universalEnrichmentBatchId}.
        slots:
          universalEnrichmentBatchId: path.universalEnrichmentBatchId
      - text: Pull the output of universal enrichment job {universalEnrichmentBatchId}.
        slots:
          universalEnrichmentBatchId: path.universalEnrichmentBatchId
      method: generated
      generated: '2026-10-01'