API Evangelist conversational phrasing for Avalara Contacts 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 Contacts API
  version: 1.0.0
extends: openapi/avalara-contacts-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['/companies/{companyId}/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's contacts
      effect: read
      questions:
      - Who are the contacts on file for my company?
      - Can I see which contact is marked primary for a company?
      instructions:
      - text: List contacts for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show everyone listed as a contact at company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{companyId}/contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a contact to a company
      effect: write
      questions:
      - Can I add a new person as a contact for my company?
      - Is it possible to set a new contact as the primary one?
      instructions:
      - text: Add {firstName} {lastName} ({email}) as a contact for company {companyId}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
          companyId: path.companyId
      - text: Create a primary contact with email {email} for company {companyId}, primary flag {isPrimary}.
        slots:
          email: requestBody.email
          companyId: path.companyId
          isPrimary: requestBody.isPrimary
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyId}/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's AvaTax v2 contacts
      effect: read
      questions:
      - Which tax filing contacts are assigned to a company in the AvaTax v2 API?
      - Can I filter and page AvaTax company contacts with OData?
      instructions:
      - text: List AvaTax v2 contacts for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show the tax filing contacts assigned to company {companyId} in AvaTax.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create one or more AvaTax v2 contacts
      effect: write
      questions:
      - Can I add several tax filing contacts to a company in a single AvaTax call?
      - How do I designate a person to handle filing responsibilities for a company?
      instructions:
      - text: Create AvaTax v2 contacts for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Add multiple tax filing contacts to company {companyId} at once.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/contacts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single contact
      effect: read
      questions:
      - Can I look up one company contact by ID?
      - What details are stored for a specific tax filing contact?
      instructions:
      - text: Get contact {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Show contact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/contacts/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contact
      effect: write
      questions:
      - How do I change a contact's email or phone number?
      - Does replacing a contact clear the fields I leave out?
      instructions:
      - text: Update contact {id} in company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Replace contact {id} with updated details.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/contacts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact
      effect: destructive
      questions:
      - How do I remove a person who no longer handles our tax filings?
      - Can I delete a contact from a company?
      instructions:
      - text: Delete contact {id} from company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Mark contact {id} as deleted.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search contacts across all companies
      effect: read
      questions:
      - Which contacts exist across every company in my account?
      - Can I query contacts without choosing a single company?
      instructions:
      - text: List contacts across all my companies.
      - text: Query every company's contacts in the account.
      method: generated
      generated: '2026-10-01'