# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Spade Transfer Enrichment API
  version: 1.0.0
extends: openapi/spade-transfer-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: 5
- target: $.paths['/transactions/transfers/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich a single ACH or wire transfer
      effect: write
      questions:
      - How do I identify who's behind an ACH deposit or wire transfer description?
      - Which transfer types like ACH_DEPOSIT or ACH_RETURN can I enrich?
      - Can I pass a memo or alternate description to improve transfer enrichment?
      instructions:
      - text: 'Enrich the {transactionType} transfer "{description}" for user {userId}: {amount} {currencyCode} on {occurredAt}.'
        slots:
          transactionType: requestBody.transactionType
          description: requestBody.description
          userId: requestBody.userId
          amount: requestBody.amount
          currencyCode: requestBody.currencyCode
          occurredAt: requestBody.occurredAt
      - text: Enrich wire transfer {transactionId} with memo {memo} on account {accountId}.
        slots:
          transactionId: requestBody.transactionId
          memo: requestBody.memo
          accountId: requestBody.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batches/transactions/transfers/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a batch of transfers for enrichment
      effect: write
      questions:
      - How do I enrich a large file of ACH and wire transfers in one job?
      - Can a transfer batch notify my server when it completes?
      - Can small transfer batches come back inline instead of as a job?
      instructions:
      - text: Submit these transfers {transactions} as an enrichment batch and call {callbackUrl} when finished.
        slots:
          transactions: requestBody.transactions
          callbackUrl: requestBody.callbackUrl
      - text: Enrich this microbatch of transfers {transactions} with synchronous set to {synchronous}.
        slots:
          transactions: requestBody.transactions
          synchronous: query.synchronous
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batches/transactions/transfers/enrich'].options
  update:
    x-apievangelist-phrasing:
      intent: Check the synchronous cap for transfer batches
      effect: read
      questions:
      - What is the current synchronousMax for enriching transfer batches inline?
      - How many transfers fit in one synchronous microbatch?
      instructions:
      - text: Fetch the current synchronous item cap for transfer batch enrichment.
      - text: Read the metadata for the batch transfer enrichment endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batches/{transferEnrichmentBatchId}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results of a transfer enrichment batch
      effect: read
      questions:
      - How do I download the enriched transfers once my batch job is done?
      - Where do the results of a transfer enrichment batch come back?
      instructions:
      - text: Fetch the enriched results of transfer batch {transferEnrichmentBatchId}.
        slots:
          transferEnrichmentBatchId: path.transferEnrichmentBatchId
      - text: Pull the output of transfer enrichment job {transferEnrichmentBatchId}.
        slots:
          transferEnrichmentBatchId: path.transferEnrichmentBatchId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batches/{transferEnrichmentBatchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a transfer enrichment batch
      effect: read
      questions:
      - Is my transfer enrichment batch still processing?
      - How can I poll the progress of a transfer batch I submitted?
      instructions:
      - text: Check whether transfer batch {transferEnrichmentBatchId} has finished.
        slots:
          transferEnrichmentBatchId: path.transferEnrichmentBatchId
      - text: Show the job status for transfer enrichment batch {transferEnrichmentBatchId}.
        slots:
          transferEnrichmentBatchId: path.transferEnrichmentBatchId
      method: generated
      generated: '2026-10-01'