API Evangelist conversational phrasing for Twilio - Conversations 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 - Conversations Users API
  version: 1.0.0
extends: openapi/twilio-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: 9
- target: $.paths['/v1/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversation users
      effect: read
      questions:
      - Which users exist in my default Conversations service?
      - Can I page through every chat user on my account?
      instructions:
      - text: List all conversation users in my default service.
      - text: Show {page_size} Conversations users per page.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Users'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a conversation user
      effect: write
      questions:
      - How do I create a chat user with my own application identity?
      - Can I give a new conversation user a role and custom attributes when I add them?
      instructions:
      - text: Create a conversation user with identity {identity}.
        slots:
          identity: requestBody.Identity
      - text: Add user {identity} named {friendly_name} with role {role_sid}.
        slots:
          identity: requestBody.Identity
          friendly_name: requestBody.FriendlyName
          role_sid: requestBody.RoleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Users/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one conversation user
      effect: read
      questions:
      - What attributes and role does a particular chat user have?
      - Can I look up a conversation user by identity rather than SID?
      instructions:
      - text: Get conversation user {sid}.
        slots:
          sid: path.Sid
      - text: Show the profile and role of chat user {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Users/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a conversation user
      effect: write
      questions:
      - Can I change the role of an existing conversation user?
      - How do I update the display name or attributes of a chat user?
      instructions:
      - text: Change the role of existing user {sid} to {role_sid}.
        slots:
          sid: path.Sid
          role_sid: requestBody.RoleSid
      - text: Rename conversation user {sid} to {friendly_name}.
        slots:
          sid: path.Sid
          friendly_name: requestBody.FriendlyName
      - text: Set the attributes of chat user {sid} to {attributes}.
        slots:
          sid: path.Sid
          attributes: requestBody.Attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Users/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a conversation user
      effect: destructive
      questions:
      - How can I delete a chat user from my default service?
      - Can I suppress webhooks when I remove a conversation user?
      instructions:
      - text: Delete conversation user {sid}.
        slots:
          sid: path.Sid
      - text: Remove chat user {sid} with webhooks enabled set to {webhook_enabled}.
        slots:
          sid: path.Sid
          webhook_enabled: header.X-Twilio-Webhook-Enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Users/{UserSid}/Conversations/{ConversationSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's view of one conversation
      effect: read
      questions:
      - How many unread messages does a user have in a specific conversation?
      - What notification level has a user set for one conversation?
      instructions:
      - text: Get user {user_sid}'s membership in conversation {conversation_sid}.
        slots:
          user_sid: path.UserSid
          conversation_sid: path.ConversationSid
      - text: Show read status for user {user_sid} in conversation {conversation_sid}.
        slots:
          user_sid: path.UserSid
          conversation_sid: path.ConversationSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Users/{UserSid}/Conversations/{ConversationSid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a user's settings in a conversation
      effect: write
      questions:
      - Can I mute notifications for a user in one conversation?
      - How do I mark messages as read up to a certain point for a user?
      instructions:
      - text: Set notification level {notification_level} for user {user_sid} in conversation {conversation_sid}.
        slots:
          notification_level: requestBody.NotificationLevel
          user_sid: path.UserSid
          conversation_sid: path.ConversationSid
      - text: Mark conversation {conversation_sid} read up to message index {last_read_message_index} for user {user_sid}.
        slots:
          conversation_sid: path.ConversationSid
          last_read_message_index: requestBody.LastReadMessageIndex
          user_sid: path.UserSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Users/{UserSid}/Conversations/{ConversationSid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a conversation
      effect: destructive
      questions:
      - How do I take a user out of one conversation without deleting the user?
      - Can I drop a single conversation from a user's list?
      instructions:
      - text: Remove user {user_sid} from conversation {conversation_sid}.
        slots:
          user_sid: path.UserSid
          conversation_sid: path.ConversationSid
      - text: Delete the user conversation link between {user_sid} and {conversation_sid}.
        slots:
          user_sid: path.UserSid
          conversation_sid: path.ConversationSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Users/{UserSid}/Conversations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's conversations
      effect: read
      questions:
      - Which conversations is a particular user part of?
      - Can I show a user every conversation they belong to, with unread counts?
      instructions:
      - text: List every conversation user {user_sid} belongs to.
        slots:
          user_sid: path.UserSid
      - text: Show all conversations for chat user {user_sid}.
        slots:
          user_sid: path.UserSid
      method: generated
      generated: '2026-09-26'