# 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 Registrar API
  version: 1.0.0
extends: openapi/avalara-registrar-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: 11
- target: $.paths['/api/v2/accounts/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account as registrar
      effect: write
      questions:
      - How does a registrar admin replace an account's details?
      - Can registrar users edit any account object?
      instructions:
      - text: Update account {id}.
        slots:
          id: path.id
      - text: Replace the account object for account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account and everything in it
      effect: destructive
      questions:
      - What gets removed when a whole account is deleted?
      - Who is allowed to delete an account?
      instructions:
      - text: Delete account {id}.
        slots:
          id: path.id
      - text: Remove account {id} along with its companies, users and license keys.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account as registrar
      effect: write
      questions:
      - How does a registrar admin create a new account?
      - Can I attach subscriptions and users while creating an account?
      instructions:
      - text: Create a new account.
      - text: Create an account with its initial subscriptions and users.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/notifications/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a notification
      effect: write
      questions:
      - Can an admin rewrite a notification that was already posted?
      - How do I change the text of an existing notification?
      instructions:
      - text: Update notification {id}.
        slots:
          id: path.id
      - text: Replace notification {id} with new content.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/notifications/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification
      effect: destructive
      questions:
      - How do I permanently remove a notification?
      - Is deleting a notification different from dismissing it?
      instructions:
      - text: Delete notification {id}.
        slots:
          id: path.id
      - text: Remove notification {id} entirely.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/notifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification
      effect: write
      questions:
      - How do I post a new notification to users?
      - Can invited admins publish a notification message?
      instructions:
      - text: Create a new notification.
      - text: Post a notification message to customers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{accountId}/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add subscriptions to an account
      effect: write
      questions:
      - How does a registrar attach a licensed service to an account?
      - Can I add several service subscriptions to an account at once?
      instructions:
      - text: Create subscriptions for account {accountId}.
        slots:
          accountId: path.accountId
      - text: Attach new licensed services to account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{accountId}/subscriptions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account subscription
      effect: write
      questions:
      - How do I change the dates or settings of an account's subscription?
      - Can a registrar replace a subscription object?
      instructions:
      - text: Update subscription {id} on account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      - text: Replace subscription {id} for account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{accountId}/subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account subscription
      effect: destructive
      questions:
      - How do I remove a service subscription from an account?
      - Who can delete subscriptions on an account?
      instructions:
      - text: Delete subscription {id} from account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      - text: Remove service subscription {id} on account {accountId}.
        slots:
          id: path.id
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/servicetypes/servicetypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List all supported subscription types
      effect: read
      questions:
      - What subscription types does the platform support?
      - Which features can be added to an account as a service type?
      instructions:
      - text: List every supported service type.
      - text: Show all available subscription types.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/passwords/{userId}/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a user's password as admin
      effect: write
      questions:
      - How does a registrar admin reset another user's password?
      - Can a system admin set a new password for any user?
      instructions:
      - text: Reset the password for user {userId}.
        slots:
          userId: path.userId
      - text: Set a new password on user {userId} as an administrator.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'