# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara AvaTax Ava File Forms API
  version: 1.0.0
extends: openapi/avalara-avafileforms-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['/api/v2/avafileforms'].get
  update:
    x-apievangelist-phrasing:
      intent: Search AvaFile return forms
      effect: read
      questions:
      - Which tax return forms does the returns team support?
      - Can I filter and page through the AvaFile forms list?
      instructions:
      - text: Search AvaFile forms.
      - text: List the supported return forms, sorted and paged.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/avafileforms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create AvaFile return forms
      effect: write
      questions:
      - How do I add a new form to the supported returns forms list?
      - Can I create several AvaFile forms in one call?
      instructions:
      - text: Create new AvaFile forms.
      - text: Add a return form definition to AvaFile.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/avafileforms/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one AvaFile form
      effect: read
      questions:
      - Can I look up a single return form by its ID?
      - What details are stored on a particular AvaFile form?
      instructions:
      - text: Get AvaFile form {id}.
        slots:
          id: path.id
      - text: Show the definition of return form {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/avafileforms/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an AvaFile form
      effect: write
      questions:
      - How do I change the details of an existing return form?
      - Does updating an AvaFile form replace every field on it?
      instructions:
      - text: Update AvaFile form {id}.
        slots:
          id: path.id
      - text: Replace the data on return form {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/avafileforms/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AvaFile form
      effect: destructive
      questions:
      - Can I remove a return form from the supported list?
      - What happens to an AvaFile form when it is deleted?
      instructions:
      - text: Delete AvaFile form {id}.
        slots:
          id: path.id
      - text: Mark return form {id} as deleted.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'