API Evangelist conversational phrasing for Phone Roles API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Roles API
  version: 1.0.0
extends: openapi/zoom-phone-phone-roles-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['/phone/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone roles
      effect: read
      questions:
      - Which phone admin roles exist in our account?
      - Is there a list of every Zoom Phone role?
      instructions:
      - text: List all phone roles.
      - text: Show me every phone role we have defined.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a phone role
      effect: write
      questions:
      - Can I create a new phone role by copying an existing one?
      - How do I clone a role and give the copy its own name?
      instructions:
      - text: Duplicate phone role {role_id}.
        slots:
          role_id: requestBody.role_id
      - text: Copy phone role {role_id} as a new role called {name}.
        slots:
          role_id: requestBody.role_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles/{roleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a phone role's details
      effect: read
      questions:
      - What does a particular phone role include?
      - Where can I see the name and description of one role?
      instructions:
      - text: Show details for phone role {roleId}.
        slots:
          roleId: path.roleId
      - text: Look up phone role {roleId}.
        slots:
          roleId: path.roleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles/{roleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a phone role
      effect: destructive
      questions:
      - Can I delete a phone role we no longer use?
      - What removes a custom phone role from the account?
      instructions:
      - text: Delete phone role {roleId}.
        slots:
          roleId: path.roleId
      - text: Remove the phone role {roleId} permanently.
        slots:
          roleId: path.roleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles/{roleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a phone role
      effect: write
      questions:
      - How do I rename a phone role?
      - Can I change a role's description?
      instructions:
      - text: Rename phone role {roleId} to {name}.
        slots:
          roleId: path.roleId
          name: requestBody.name
      - text: Set the description of phone role {roleId} to {description}.
        slots:
          roleId: path.roleId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles/{roleId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in or not in a phone role
      effect: read
      questions:
      - Who is assigned to a given phone role?
      - Can I list users who are NOT in a role yet?
      instructions:
      - text: List the members of phone role {roleId}.
        slots:
          roleId: path.roleId
      - text: List users with in-role status {in_role} for role {roleId}.
        slots:
          in_role: query.in_role
          roleId: path.roleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles/{roleId}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users to a phone role
      effect: write
      questions:
      - How do I assign users to a phone role?
      - Can I copy all the members of one role into another?
      instructions:
      - text: Add users {user_ids} to phone role {roleId}.
        slots:
          user_ids: requestBody.user_ids
          roleId: path.roleId
      - text: Add members to role {roleId} by copying from role {role_id}.
        slots:
          roleId: path.roleId
          role_id: requestBody.role_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles/{roleId}/members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove users from a phone role
      effect: destructive
      questions:
      - Can I take users out of a phone role?
      - What removes several members from a role at once?
      instructions:
      - text: Remove users {user_ids} from phone role {roleId}.
        slots:
          user_ids: query.user_ids
          roleId: path.roleId
      - text: Take {user_ids} out of role {roleId}.
        slots:
          user_ids: query.user_ids
          roleId: path.roleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles/{roleId}/targets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the targets a phone role manages
      effect: read
      questions:
      - Which sites or users does a phone role apply to?
      - Can I filter a role's targets by target type or site?
      instructions:
      - text: List the targets of phone role {roleId}.
        slots:
          roleId: path.roleId
      - text: List role {roleId} targets of type {target_type}.
        slots:
          roleId: path.roleId
          target_type: query.target_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles/{roleId}/targets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add targets to a phone role
      effect: write
      questions:
      - How do I scope a phone role to specific sites or users?
      - Can I add targets for one member of a role rather than the default?
      instructions:
      - text: Add targets {targets} to phone role {roleId}.
        slots:
          targets: requestBody.targets
          roleId: path.roleId
      - text: Add targets {targets} to role {roleId} for user {user_id}.
        slots:
          targets: requestBody.targets
          roleId: path.roleId
          user_id: requestBody.user_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/roles/{roleId}/targets'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove targets from a phone role
      effect: destructive
      questions:
      - Can I narrow a phone role by removing some of its targets?
      - What deletes targets from a role for a specific user?
      instructions:
      - text: Remove targets {targets} from phone role {roleId}.
        slots:
          targets: requestBody.targets
          roleId: path.roleId
      - text: Delete role {roleId} targets {targets} for user {user_id}.
        slots:
          targets: requestBody.targets
          roleId: path.roleId
          user_id: requestBody.user_id
      method: generated
      generated: '2026-10-01'