API Evangelist conversational phrasing for Twilio - Trusthub End 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 Twilio - Trusthub End Users API
  version: 1.0.0
extends: openapi/twilio-end-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/EndUsers'].get
  update:
    x-apievangelist-phrasing:
      intent: List regulatory end users
      effect: read
      questions:
      - Which end users have I registered for regulatory compliance bundles?
      - Can I see every individual and business end user on my account?
      instructions:
      - text: List all end users on my account.
      - text: Show every compliance end user I have created.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/EndUsers'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an end user for compliance
      effect: write
      questions:
      - How do I register the person or business that will use a regulated phone number?
      - Does an end user have to be either an individual or a business?
      instructions:
      - text: Create a {type} end user named {name}.
        slots:
          type: requestBody.Type
          name: requestBody.FriendlyName
      - text: Register {type} end user {name} with attributes {attributes}.
        slots:
          type: requestBody.Type
          name: requestBody.FriendlyName
          attributes: requestBody.Attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/EndUsers/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one end user
      effect: read
      questions:
      - What details are stored for a specific compliance end user?
      - Can I check the type and attributes of one end user?
      instructions:
      - text: Show end user {end_user}.
        slots:
          end_user: path.Sid
      - text: Get the attributes recorded for end user {end_user}.
        slots:
          end_user: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/EndUsers/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an end user's details
      effect: write
      questions:
      - Can I correct the address or name on an end user I already registered?
      - Is it possible to rename an existing end user?
      instructions:
      - text: Replace the attributes of existing end user {end_user} with {attributes}.
        slots:
          end_user: path.Sid
          attributes: requestBody.Attributes
      - text: Rename end user {end_user} to {name}.
        slots:
          end_user: path.Sid
          name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/EndUsers/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an end user
      effect: destructive
      questions:
      - How do I remove an end user I registered by mistake?
      - What happens when I delete a compliance end user?
      instructions:
      - text: Delete end user {end_user}.
        slots:
          end_user: path.Sid
      - text: Remove the mistaken end user record {end_user}.
        slots:
          end_user: path.Sid
      method: generated
      generated: '2026-09-26'