# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Batches API
  version: 1.0.0
extends: openapi/avalara-batches-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: 8
- target: $.paths['/api/v2/companies/{companyId}/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: List import batches for a company
      effect: read
      questions:
      - Which batch imports have been run for my company?
      - Can I check the record count and status of my company's batches?
      instructions:
      - text: List batches for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show batches for company {companyId} matching {filter}.
        slots:
          companyId: path.companyId
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyId}/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new batch for a company
      effect: write
      questions:
      - Can I create a batch to process records in bulk for my company?
      - What batch types can I start for a company?
      instructions:
      - text: Create a batch named {name} for company {companyId}.
        slots:
          name: requestBody.name
          companyId: path.companyId
      - text: Start a {type} batch for company {companyId}.
        slots:
          type: requestBody.type
          companyId: path.companyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyId}/batches/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an in-progress batch
      effect: destructive
      questions:
      - How do I stop a JSON batch that is still waiting or processing?
      - Can I cancel a file batch, or only JSON batches?
      instructions:
      - text: Cancel batch {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Stop in-progress batch {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/batches/transactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a batch of transactions
      effect: write
      questions:
      - How do I submit a large set of transactions to be processed in the background?
      - Can I send transactions to the Batch v2 queue for my company?
      instructions:
      - text: Create a transaction batch for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Queue a set of transactions as a batch for company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/batches/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a batch's status and results
      effect: read
      questions:
      - Has my batch finished processing yet?
      - Where do I get the results of a batch I submitted?
      instructions:
      - text: Get batch {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Check the status of batch {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/batches/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a batch
      effect: destructive
      questions:
      - Does deleting a batch also delete the transactions it imported?
      - How do I remove a batch I no longer need?
      instructions:
      - text: Delete batch {id} from company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Mark batch {id} as deleted.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/batches/{batchId}/files/{id}/attachment'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a batch file
      effect: read
      questions:
      - How do I download the file attached to a batch?
      - Can I retrieve one result file from a processed batch?
      instructions:
      - text: Download file {id} of batch {batchId} for company {companyId}.
        slots:
          id: path.id
          batchId: path.batchId
          companyId: path.companyId
      - text: Get the attachment for batch file {id} in batch {batchId}.
        slots:
          id: path.id
          batchId: path.batchId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: Search batches across all companies
      effect: read
      questions:
      - Which batches have run across every company in my account?
      - Can I query batches without picking a single company?
      instructions:
      - text: List batches across all my companies.
      - text: Query every company's batches in the account.
      method: generated
      generated: '2026-10-01'