# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST Users API
  version: 1.0.0
extends: openapi/cvent-event-cloud-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: 7
- target: $.paths['/account-user-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List account user groups
      effect: read
      questions:
      - What user groups exist in my Cvent account?
      - Can I filter the account user groups by name?
      instructions:
      - text: List the account user groups.
      - text: Show user groups matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account user group
      effect: write
      questions:
      - How do I create a new user group in my account?
      - Can I give a user group a description when I create it?
      instructions:
      - text: Create a user group named {name}.
        slots:
          name: requestBody.name
      - text: Create user group {name} with ID {groupId} and description {description}.
        slots:
          name: requestBody.name
          groupId: requestBody.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one account user group
      effect: read
      questions:
      - What are the details of a specific user group?
      - Can I look up a user group by ID?
      instructions:
      - text: Get user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      - text: Show the name and description of user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account user group
      effect: write
      questions:
      - Can I rename an existing user group?
      - What changes a user group's description?
      instructions:
      - text: Rename user group {userGroupId} to {name}.
        slots:
          userGroupId: path.userGroupId
          name: requestBody.name
      - text: Change the description of existing user group {userGroupId} to {description}.
        slots:
          userGroupId: path.userGroupId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account user group
      effect: destructive
      questions:
      - How do I delete a user group I no longer need?
      - Can I remove an entire user group from the account?
      instructions:
      - text: Delete user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      - text: Remove the whole account user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}/users/{userId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a user group
      effect: write
      questions:
      - How do I put a user into an account user group?
      - Can I associate one user with a group by ID?
      instructions:
      - text: Add user {userId} to user group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      - text: Associate user {userId} with group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a user group
      effect: destructive
      questions:
      - How do I take a user out of a group without deleting the group?
      - Can I remove one member from an account user group?
      instructions:
      - text: Remove user {userId} from user group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      - text: Take member {userId} out of group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'