# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Antavo Transactions API
  version: 1.0.0
extends: openapi/antavo-transactions-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: 6
- target: $.paths['/customers/{customer_id}/transactions/-/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a customer's transactions by status
      effect: read
      questions:
      - Can I find a member's transactions that are in a particular status?
      - Can I query one customer's transactions by ID using URL parameters?
      instructions:
      - text: Search customer {customer_id}'s transactions with status {status}.
        slots:
          customer_id: path.customer_id
          status: query.status
      - text: Find transaction {id} for customer {customer_id} using the search query.
        slots:
          id: query.id
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/transactions/-/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-search a customer's transactions
      effect: read
      questions:
      - Can I search a customer's transactions for many IDs at once in a request body?
      - What's the high-volume way to search a member's transactions?
      instructions:
      - text: Run a bulk transaction search for customer {customer_id} on IDs {id}.
        slots:
          customer_id: path.customer_id
          id: requestBody.id
      - text: Bulk-search customer {customer_id}'s transactions in status {status} via the request body.
        slots:
          customer_id: path.customer_id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/transactions/{transaction_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List the events of one transaction
      effect: read
      questions:
      - Which checkout and update events make up a single transaction?
      - Can I filter one transaction's events by action type?
      instructions:
      - text: List the events for transaction {transaction_id} of customer {customer_id}.
        slots:
          transaction_id: path.transaction_id
          customer_id: path.customer_id
      - text: Show {action} events on customer {customer_id}'s transaction {transaction_id}.
        slots:
          action: query.action
          customer_id: path.customer_id
          transaction_id: path.transaction_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/transactions/{transaction_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one customer transaction
      effect: read
      questions:
      - Can I get the full breakdown of one specific purchase for a member?
      - Can I choose which fields come back for a single transaction?
      instructions:
      - text: Get transaction {transaction_id} for customer {customer_id}.
        slots:
          transaction_id: path.transaction_id
          customer_id: path.customer_id
      - text: Show only fields {fields} of customer {customer_id}'s transaction {transaction_id}.
        slots:
          fields: query.fields
          customer_id: path.customer_id
          transaction_id: path.transaction_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer's transaction history (legacy)
      effect: read
      questions:
      - Where do I find the event ID that created a given transaction?
      - Is there an older transaction history endpoint without filter and sort expressions?
      instructions:
      - text: Retrieve the older-style transaction history for customer {customer_id}, {limit} at a time.
        slots:
          customer_id: path.customer_id
          limit: query.limit
      - text: Look up transaction {id} in customer {customer_id}'s history to get the event that created it.
        slots:
          id: query.id
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/customers/{customer_id}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's purchase transactions
      effect: read
      questions:
      - How do I see a member's transactions with their items and points earned?
      - Can I filter a customer's transactions by status or checkout date?
      - What points were burned or earned on each of a customer's purchases?
      instructions:
      - text: List the transactions for customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show customer {customer_id}'s transactions matching {filter}, sorted by {sort}.
        slots:
          customer_id: path.customer_id
          filter: query.filter
          sort: query.sort
      method: generated
      generated: '2026-10-01'