# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Accounts API
  version: 1.0.0
extends: openapi/avalara-accounts-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: 13
- target: $.paths['/api/v2/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an AvaTax account by ID
      effect: read
      questions:
      - Can I look up an AvaTax account by its numeric account ID?
      - What settings and subscriptions come back when I fetch an AvaTax account with includes?
      instructions:
      - text: Retrieve AvaTax account {id}.
        slots:
          id: path.id
      - text: Get AvaTax account {id} and include {include}.
        slots:
          id: path.id
          include: query.$include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List all AvaTax accounts
      effect: read
      questions:
      - Which AvaTax accounts can my credentials see?
      - Can I filter the list of accounts with an OData expression?
      instructions:
      - text: List all accounts I have access to.
      - text: List accounts matching {filter}, {top} at a time.
        slots:
          filter: query.$filter
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new customer account via a partner
      effect: write
      questions:
      - How do I sign up a new customer for Avalara through my partner integration?
      - What information is required to register a new customer account as a partner?
      instructions:
      - text: Register a new customer account for {companyName} with email {email}.
        slots:
          companyName: requestBody.companyName
          email: requestBody.email
      - text: Create a partner-referred account for {companyName}, contact {email}, partner code {partnerCode}.
        slots:
          companyName: requestBody.companyName
          email: requestBody.email
          partnerCode: requestBody.partnerCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get partner account details
      effect: read
      questions:
      - Can I check the details of a customer account I registered through the partner program?
      - Where do I see a partner-registered account's details by account ID?
      instructions:
      - text: Get the partner account details for {accountId}.
        slots:
          accountId: path.accountId
      - text: Show the customer account {accountId} I registered as a partner.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/accounts/{id}/resetlicensekey'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset an account's license key
      effect: destructive
      questions:
      - How do I generate a fresh license key if my old one leaked?
      - Does resetting the account license key invalidate the previous one?
      instructions:
      - text: Reset the license key for account {id}.
        slots:
          id: path.id
      - text: Replace the license key on AvaTax account {id} with a new one.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{id}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an account
      effect: write
      questions:
      - How do I activate a new AvaTax account after signing up?
      - Do I have to accept the terms and conditions to activate my account?
      instructions:
      - text: Activate account {id}.
        slots:
          id: path.id
      - text: Accept the terms and activate AvaTax account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{id}/audit'].get
  update:
    x-apievangelist-phrasing:
      intent: Review an account's error audit trail
      effect: read
      questions:
      - Can I see which API calls against my account returned errors?
      - What was sent back and forth on a failed AvaTax call?
      instructions:
      - text: Get the audit history for account {id}.
        slots:
          id: path.id
      - text: Show failed API calls logged for account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{id}/licensekey'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a named license key
      effect: write
      questions:
      - Can I create a separate license key for each of my integrations?
      - How do I add a new named license key to my account?
      instructions:
      - text: Create a new license key for account {id}.
        slots:
          id: path.id
      - text: Add a named license key to AvaTax account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{id}/licensekey/{licensekeyname}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a license key by name
      effect: read
      questions:
      - Can I look up the details of one license key by its name?
      - When was a particular named license key created?
      instructions:
      - text: Get license key {licensekeyname} for account {id}.
        slots:
          licensekeyname: path.licensekeyname
          id: path.id
      - text: Show the license key named {licensekeyname}.
        slots:
          licensekeyname: path.licensekeyname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{id}/licensekey/{licensekeyname}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a named license key
      effect: destructive
      questions:
      - How do I revoke a license key an old integration was using?
      - Can I delete one license key by name and keep the others?
      instructions:
      - text: Delete license key {licensekeyname} from account {id}.
        slots:
          licensekeyname: path.licensekeyname
          id: path.id
      - text: Revoke the license key named {licensekeyname}.
        slots:
          licensekeyname: path.licensekeyname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{id}/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's configuration settings
      effect: read
      questions:
      - Which configuration settings control features on my account?
      - Can I see the current account-level configuration values?
      instructions:
      - text: Get the configuration settings for account {id}.
        slots:
          id: path.id
      - text: Show account {id} configuration.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{id}/configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an account's configuration settings
      effect: write
      questions:
      - How do I turn an account feature on or off through configuration?
      - Can I change account configuration values for my tax software?
      instructions:
      - text: Update configuration settings on account {id}.
        slots:
          id: path.id
      - text: Set new configuration values for AvaTax account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{id}/licensekeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List all license keys on an account
      effect: read
      questions:
      - Which license keys are in use on my account?
      - How many license keys does my account have right now?
      instructions:
      - text: List license keys for account {id}.
        slots:
          id: path.id
      - text: Show every license key on AvaTax account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'