# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Tax Codes API
  version: 1.0.0
extends: openapi/conga-tax-codes-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: 7
- target: $.paths['/tax-codes'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax codes
      effect: read
      questions:
      - What tax codes are defined in my CPQ setup?
      - Can I filter and page through tax codes instead of getting them all at once?
      instructions:
      - text: List every tax code.
      - text: List tax codes matching {filter}, sorted by {sort}, page {page}.
        slots:
          filter: query.filter
          sort: query.sort
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tax-codes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create one or more tax codes
      effect: write
      questions:
      - How do I add new tax codes to CPQ?
      - Does creating a tax code give me back a generated ID?
      instructions:
      - text: Create new tax codes from the details I provide.
      - text: Add this batch of tax codes and return their generated IDs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tax-codes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several tax codes at once
      effect: destructive
      questions:
      - Can I delete a list of tax codes in one request, and is there a maximum?
      - Will bulk deleting tax codes tell me which ones succeeded?
      instructions:
      - text: Bulk delete the tax codes in my list of IDs.
      - text: Remove up to 100 tax codes in one request and report each delete status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tax-codes'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several tax codes at once
      effect: write
      questions:
      - Can I change fields on many tax codes together?
      - Which tax code fields can't be changed in a bulk update?
      instructions:
      - text: Bulk update these fields across multiple tax codes.
      - text: Apply my changes to every tax code in this list at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tax-codes/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single tax code
      effect: read
      questions:
      - How can I see the details of one particular tax code?
      - Can I fetch a tax code together with its related entities?
      instructions:
      - text: Get tax code {Id}.
        slots:
          Id: path.Id
      - text: Retrieve tax code {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tax-codes/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one tax code
      effect: destructive
      questions:
      - Can I delete a single tax code by its ID?
      - What's the way to remove one obsolete tax code?
      instructions:
      - text: Delete tax code {Id}.
        slots:
          Id: path.Id
      - text: Remove the tax code with ID {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tax-codes/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one tax code
      effect: write
      questions:
      - Can I edit just one tax code without touching the others?
      - Which call changes the details on a single tax code?
      instructions:
      - text: Update tax code {Id} with these details.
        slots:
          Id: path.Id
      - text: Change the fields on the tax code with ID {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'