# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Square Disputes API
  version: 1.0.0
extends: openapi/square-disputes-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: 9
- target: $.paths['/v2/disputes'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment disputes
      effect: read
      questions:
      - Which chargebacks are currently open against my account?
      - Can I filter disputes by state or location?
      instructions:
      - text: List all disputes.
      - text: List disputes in state {states} at location {location_id}.
        slots:
          states: query.states
          location_id: query.location_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/disputes/{dispute_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dispute
      effect: read
      questions:
      - What is the reason and due date for a specific chargeback?
      - Can I check the current state of one dispute?
      instructions:
      - text: Get dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      - text: Show the reason and deadline for dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/disputes/{dispute_id}/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept the loss on a dispute
      effect: destructive
      questions:
      - What happens to my balance if I accept a chargeback?
      - How do I concede a dispute instead of fighting it?
      instructions:
      - text: Accept dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      - text: Concede dispute {dispute_id} and return the funds to the cardholder.
        slots:
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/disputes/{dispute_id}/evidence'].get
  update:
    x-apievangelist-phrasing:
      intent: List evidence on a dispute
      effect: read
      questions:
      - What evidence have I already attached to a dispute?
      - Can I see all files and text uploaded for one chargeback?
      instructions:
      - text: List evidence for dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      - text: Show everything uploaded as evidence on dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/disputes/{dispute_id}/evidence-files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an evidence file to a dispute
      effect: write
      questions:
      - Which file formats can I upload as dispute evidence?
      - How do I attach a receipt image to fight a chargeback?
      instructions:
      - text: Upload {image_file} as evidence for dispute {dispute_id}.
        slots:
          image_file: requestBody.image_file
          dispute_id: path.dispute_id
      - text: Attach the PDF {image_file} to dispute {dispute_id}.
        slots:
          image_file: requestBody.image_file
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/disputes/{dispute_id}/evidence-text'].post
  update:
    x-apievangelist-phrasing:
      intent: Add text evidence to a dispute
      effect: write
      questions:
      - Can I submit a written explanation or tracking number as dispute evidence?
      - What evidence types can text evidence be tagged with?
      instructions:
      - text: Add text evidence {evidence_text} to dispute {dispute_id}.
        slots:
          evidence_text: requestBody.evidence_text
          dispute_id: path.dispute_id
      - text: Attach {evidence_text} as {evidence_type} evidence on dispute {dispute_id}.
        slots:
          evidence_text: requestBody.evidence_text
          evidence_type: requestBody.evidence_type
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/disputes/{dispute_id}/evidence/{evidence_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one piece of dispute evidence
      effect: read
      questions:
      - Can I download evidence after I upload it to a dispute?
      - What metadata is kept for a single evidence item?
      instructions:
      - text: Get evidence {evidence_id} on dispute {dispute_id}.
        slots:
          evidence_id: path.evidence_id
          dispute_id: path.dispute_id
      - text: Show the metadata for evidence {evidence_id} in dispute {dispute_id}.
        slots:
          evidence_id: path.evidence_id
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/disputes/{dispute_id}/evidence/{evidence_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove evidence from a dispute
      effect: destructive
      questions:
      - How do I take back evidence I uploaded to a dispute by mistake?
      - Is removed evidence still sent to the bank?
      instructions:
      - text: Delete evidence {evidence_id} from dispute {dispute_id}.
        slots:
          evidence_id: path.evidence_id
          dispute_id: path.dispute_id
      - text: Remove evidence item {evidence_id} so it isn't sent for dispute {dispute_id}.
        slots:
          evidence_id: path.evidence_id
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/disputes/{dispute_id}/submit-evidence'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit dispute evidence to the bank
      effect: write
      questions:
      - When I'm done uploading, how do I send my evidence to the cardholder's bank?
      - Can I add more evidence after submitting a dispute challenge?
      instructions:
      - text: Submit evidence for dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      - text: Send all uploaded evidence on dispute {dispute_id} to the bank.
        slots:
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'