API Evangelist conversational phrasing for Avalara Nexus API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Nexus API
  version: 1.0.0
extends: openapi/avalara-nexus-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: 15
- target: $.paths['/api/v2/companies/{companyId}/nexus'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's nexus declarations
      effect: read
      questions:
      - Which states have I declared nexus in?
      - Can I filter my company's nexus declarations?
      instructions:
      - text: List nexus for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show nexus declarations for company {companyId} matching {filter}.
        slots:
          companyId: path.companyId
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyId}/nexus'].post
  update:
    x-apievangelist-phrasing:
      intent: Declare nexus for a company
      effect: write
      questions:
      - How do I declare that my company has nexus in a new state?
      - Can I add nexus declarations to a company?
      instructions:
      - text: Declare nexus for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Add a new nexus declaration to company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyId}/nexus/{nexusId}/parameters'].get
  update:
    x-apievangelist-phrasing:
      intent: List the parameters set on a nexus
      effect: read
      questions:
      - Which tax-affecting parameters, like remote seller status, are attached to my nexus?
      - Can I see every parameter defined on one nexus declaration?
      instructions:
      - text: List the parameters on nexus {nexusId} for company {companyId}.
        slots:
          nexusId: path.nexusId
          companyId: path.companyId
      - text: Show all nexus parameters attached to nexus {nexusId}.
        slots:
          nexusId: path.nexusId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/{nexusId}/parameters'].post
  update:
    x-apievangelist-phrasing:
      intent: Add parameters to a nexus
      effect: write
      questions:
      - How do I flag a nexus as a remote seller with a parameter?
      - Can I attach several tax-affecting parameters to one nexus at once?
      instructions:
      - text: Add parameters to nexus {nexusId} in company {companyId}.
        slots:
          nexusId: path.nexusId
          companyId: path.companyId
      - text: Attach a remote seller parameter to nexus {nexusId}.
        slots:
          nexusId: path.nexusId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/{nexusId}/parameters'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove every parameter from a nexus
      effect: destructive
      questions:
      - How do I clear all the parameters off a nexus in one call?
      - Is there a way to wipe a nexus back to having no parameters?
      instructions:
      - text: Delete all parameters from nexus {nexusId} in company {companyId}.
        slots:
          nexusId: path.nexusId
          companyId: path.companyId
      - text: Clear every parameter on nexus {nexusId}.
        slots:
          nexusId: path.nexusId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/byaddress'].post
  update:
    x-apievangelist-phrasing:
      intent: Declare nexus for the jurisdictions at an address
      effect: write
      questions:
      - Can AvaTax work out and declare every nexus that applies to a street address?
      - How do I extend the effective date on nexus I already declared for an address?
      instructions:
      - text: Declare all applicable nexus for company {companyId} from a list of addresses.
        slots:
          companyId: path.companyId
      - text: Add nexus by address for company {companyId} over a date range.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single nexus declaration
      effect: read
      questions:
      - What are the details of one specific nexus declaration?
      - Can I look up a nexus record by its ID to check its effective dates?
      instructions:
      - text: Get nexus {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Show the nexus declaration with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing nexus declaration
      effect: write
      questions:
      - Can I change the end date on a nexus I already declared?
      - What happens to the fields I leave out when I replace a nexus record?
      instructions:
      - text: Update nexus {id} in company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Replace nexus declaration {id} with new effective dates.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a nexus declaration
      effect: destructive
      questions:
      - How do I remove a nexus I declared by mistake?
      - Can I stop collecting tax in a state by deleting its nexus?
      instructions:
      - text: Delete nexus {id} from company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Mark nexus declaration {id} as deleted.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/{nexusId}/parameters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one nexus parameter
      effect: read
      questions:
      - What value is set on a single parameter of my nexus?
      - Can I fetch one nexus parameter by its own ID?
      instructions:
      - text: Get parameter {id} on nexus {nexusId} for company {companyId}.
        slots:
          id: path.id
          nexusId: path.nexusId
          companyId: path.companyId
      - text: Show nexus parameter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/{nexusId}/parameters/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one nexus parameter
      effect: write
      questions:
      - Can I change the value of a single parameter on a nexus?
      - How do I correct one nexus parameter without touching the others?
      instructions:
      - text: Update parameter {id} on nexus {nexusId} in company {companyId}.
        slots:
          id: path.id
          nexusId: path.nexusId
          companyId: path.companyId
      - text: Change the value of nexus parameter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/{nexusId}/parameters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one nexus parameter
      effect: destructive
      questions:
      - How do I remove just one parameter from a nexus and keep the rest?
      - Can I drop a single remote seller flag from a nexus?
      instructions:
      - text: Delete parameter {id} from nexus {nexusId} in company {companyId}.
        slots:
          id: path.id
          nexusId: path.nexusId
          companyId: path.companyId
      - text: Remove nexus parameter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/byform/{formCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: List nexus tied to a tax form
      effect: read
      questions:
      - Which of my nexus declarations relate to a particular tax return form?
      - Can I find the nexus I need before filing a given form code?
      instructions:
      - text: List nexus for company {companyId} related to form {formCode}.
        slots:
          companyId: path.companyId
          formCode: path.formCode
      - text: Show the nexus behind tax form {formCode}.
        slots:
          formCode: path.formCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/nexus/byTaxTypeGroup/{taxTypeGroup}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's nexus for one tax type group
      effect: read
      questions:
      - Where do I have nexus for sales and use tax only?
      - Can I narrow my nexus list to a single tax type group like lodging?
      instructions:
      - text: List nexus for company {companyId} in tax type group {taxTypeGroup}.
        slots:
          companyId: path.companyId
          taxTypeGroup: path.taxTypeGroup
      - text: Show only {taxTypeGroup} nexus declarations.
        slots:
          taxTypeGroup: path.taxTypeGroup
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/nexus'].get
  update:
    x-apievangelist-phrasing:
      intent: Search nexus across all companies
      effect: read
      questions:
      - Which nexus declarations exist across every company in my account?
      - Can I query nexus without picking a single company first?
      instructions:
      - text: List nexus declarations across all my companies.
      - text: Query nexus for every company in the account.
      method: generated
      generated: '2026-10-01'