# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Square Transactions API
  version: 1.0.0
extends: openapi/square-transactions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v2/locations/{location_id}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a location's transactions
      effect: read
      questions:
      - How do I see sales and refund transactions for one location?
      - Can I list transactions within a specific date range?
      instructions:
      - text: List transactions at location {location_id}.
        slots:
          location_id: path.location_id
      - text: Show transactions at {location_id} between {begin_time} and {end_time}.
        slots:
          location_id: path.location_id
          begin_time: query.begin_time
          end_time: query.end_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/locations/{location_id}/transactions/{transaction_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction
      effect: read
      questions:
      - What are the tenders and refunds on one specific transaction?
      - How do I look up a single transaction at a location?
      instructions:
      - text: Get transaction {transaction_id} at location {location_id}.
        slots:
          transaction_id: path.transaction_id
          location_id: path.location_id
      - text: Show details of transaction {transaction_id} from {location_id}.
        slots:
          transaction_id: path.transaction_id
          location_id: path.location_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/locations/{location_id}/transactions/{transaction_id}/capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture a delayed-capture transaction
      effect: write
      questions:
      - How do I capture a charge I authorized with delayed capture?
      - Can I finalize a held transaction at a location?
      instructions:
      - text: Capture transaction {transaction_id} at location {location_id}.
        slots:
          transaction_id: path.transaction_id
          location_id: path.location_id
      - text: Complete the authorized charge {transaction_id} at {location_id}.
        slots:
          transaction_id: path.transaction_id
          location_id: path.location_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/locations/{location_id}/transactions/{transaction_id}/void'].post
  update:
    x-apievangelist-phrasing:
      intent: Void a delayed-capture transaction
      effect: destructive
      questions:
      - How do I cancel an authorized charge before it's captured?
      - Can a delayed-capture transaction be voided instead of captured?
      instructions:
      - text: Void transaction {transaction_id} at location {location_id}.
        slots:
          transaction_id: path.transaction_id
          location_id: path.location_id
      - text: Cancel the uncaptured charge {transaction_id} at {location_id}.
        slots:
          transaction_id: path.transaction_id
          location_id: path.location_id
      method: generated
      generated: '2026-09-26'