API Evangelist conversational phrasing for Avalara AvaTax Users 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 AvaTax Users API
  version: 1.0.0
extends: openapi/avalara-users-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/passwords'].put
  update:
    x-apievangelist-phrasing:
      intent: Change my own password
      effect: write
      questions:
      - How do I change my password through the API?
      - Can I change my password if my account uses SAML sign-in?
      instructions:
      - text: Change my password.
      - text: Update the password for the user I'm signed in as.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{accountId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users on an account
      effect: read
      questions:
      - Who has access to a given account?
      - Can I see every user attached to one account?
      instructions:
      - text: List users for account {accountId}.
        slots:
          accountId: path.accountId
      - text: Show everyone with access to account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{accountId}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite new users to an account
      effect: write
      questions:
      - How do I add a team member to my account?
      - Can I create several users at once?
      instructions:
      - text: Create users on account {accountId}.
        slots:
          accountId: path.accountId
      - text: Invite a new team member to account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{accountId}/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user
      effect: read
      questions:
      - Can I look up a single user's details?
      - What role and settings does a specific user have?
      instructions:
      - text: Get user {id} on account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      - text: Show the profile of user {id} in account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{accountId}/users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user
      effect: write
      questions:
      - How do I change a user's role or contact details?
      - Does updating a user replace every field on the record?
      instructions:
      - text: Update user {id} on account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      - text: Replace the details of user {id} in account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{accountId}/users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - How do I remove someone's access to my account?
      - Which administrators are allowed to delete users?
      instructions:
      - text: Delete user {id} from account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      - text: Revoke access for user {id} on account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{accountId}/users/{id}/entitlements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's entitlements
      effect: read
      questions:
      - Which API calls and companies is a user allowed to use?
      - What access level does a particular user have?
      instructions:
      - text: Get entitlements for user {id} on account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      - text: Show which companies and calls user {id} in account {accountId} can access.
        slots:
          id: path.id
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users'].get
  update:
    x-apievangelist-phrasing:
      intent: Query users across all accounts
      effect: read
      questions:
      - Can I search users across every account I can see?
      - Which accounts does a particular person have a login on?
      instructions:
      - text: Query users across all accounts.
      - text: Search every account's users with a filter.
      method: generated
      generated: '2026-10-01'