# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Square Refunds API
  version: 1.0.0
extends: openapi/square-refunds-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: 3
- target: $.paths['/v2/refunds'].get
  update:
    x-apievangelist-phrasing:
      intent: List refunds
      effect: read
      questions:
      - Which refunds did we issue last month?
      - Can I filter refunds by status or source type?
      instructions:
      - text: List refunds between {begin_time} and {end_time}.
        slots:
          begin_time: query.begin_time
          end_time: query.end_time
      - text: List refunds with status {status} at location {location_id}.
        slots:
          status: query.status
          location_id: query.location_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/refunds'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund a payment
      effect: write
      questions:
      - How do I refund a customer's card payment?
      - Can I refund just part of a payment?
      - Can I record a refund for a cash payment?
      instructions:
      - text: Refund {amount_money} of payment {payment_id}.
        slots:
          amount_money: requestBody.amount_money
          payment_id: requestBody.payment_id
      - text: Refund {amount_money} on payment {payment_id} because {reason}.
        slots:
          amount_money: requestBody.amount_money
          payment_id: requestBody.payment_id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/refunds/{refund_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a refund
      effect: read
      questions:
      - What is the status of a refund I issued?
      - Can I look up one refund by its ID?
      instructions:
      - text: Get refund {refund_id}.
        slots:
          refund_id: path.refund_id
      - text: Check whether refund {refund_id} has completed.
        slots:
          refund_id: path.refund_id
      method: generated
      generated: '2026-09-26'