API Evangelist conversational phrasing for act.web.api 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 act.web.api Users API
  version: 1.0.0
extends: openapi/act-users-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: 17
- target: $.paths['/api/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user
      effect: read
      questions:
      - How do I look up one Act! user by ID?
      - What details does a single user account show?
      instructions:
      - text: Show user {id}.
        slots:
          id: path.id
      - text: Get the account details for user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - When deleting a user, can I reassign their records to someone else?
      - Can I also remove the user's contact record when I delete them?
      instructions:
      - text: Delete user {id} and reassign their records to {reassignTo}.
        slots:
          id: path.id
          reassignTo: query.reassignTo
      - text: Delete user {id} with removeContact set to {removeContact}.
        slots:
          id: path.id
          removeContact: query.removeContact
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}/contact-info'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user (deprecated contact-info route)
      effect: destructive
      questions:
      - Is there an older endpoint that deletes a user through their contact info?
      - Which legacy call deletes a user via the contact-info path?
      instructions:
      - text: Delete user {id} using the deprecated contact-info endpoint.
        slots:
          id: path.id
      - text: Use the legacy contact-info route to remove user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/analytics/configurations/view-definitions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user analytics view (deprecated)
      effect: write
      questions:
      - Can I still update a user's analytics view definition through the deprecated users route?
      - What legacy call saves a per-user insight view definition?
      instructions:
      - text: Update analytics view definition {id} via the deprecated users endpoint with {definition}.
        slots:
          id: path.id
          definition: requestBody.definition
      - text: Save legacy view definition {id} for user {userId}.
        slots:
          id: path.id
          userId: requestBody.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/analytics/configurations/view-definitions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user analytics view (deprecated)
      effect: destructive
      questions:
      - Can a per-user insight view be removed on the old users endpoint?
      - Which deprecated call deletes a user analytics view definition?
      instructions:
      - text: Delete analytics view definition {id} via the deprecated users route.
        slots:
          id: path.id
      - text: Remove legacy user view definition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users
      effect: read
      questions:
      - Which users are in my database?
      - Can I list every user account at once?
      instructions:
      - text: List all users.
      - text: Show every user account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user
      effect: write
      questions:
      - How do I create a new user with a username and password?
      - Can I force a new user to change their password on first login?
      instructions:
      - text: Create user {username} with role {roleName}.
        slots:
          username: requestBody.username
          roleName: requestBody.roleName
      - text: Create user {username} with password {password} and mustChangePassword {mustChangePassword}.
        slots:
          username: requestBody.username
          password: requestBody.password
          mustChangePassword: requestBody.mustChangePassword
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/accessors'].get
  update:
    x-apievangelist-phrasing:
      intent: List accessors
      effect: read
      questions:
      - Who are the accessors I can grant record access to?
      - Can I filter accessors with an OData query?
      instructions:
      - text: List all accessors.
      - text: Show the accessors available for sharing records.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/analytics/configurations/view-definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List user analytics views (deprecated)
      effect: read
      questions:
      - Where can I list user analytics view definitions on the legacy endpoint?
      - Is the per-user analytics view-definitions list deprecated?
      instructions:
      - text: List analytics view definitions via the deprecated users route.
      - text: Get the legacy per-user insight view definitions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List permissions assignable to users
      effect: read
      questions:
      - What permissions can I assign when setting up a user?
      - Which permissions are available to grant a user account?
      instructions:
      - text: List the permissions available for users.
      - text: Show the assignable user permissions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/analytics/configurations/opportunity-pipeline'].get
  update:
    x-apievangelist-phrasing:
      intent: Get opportunity pipeline settings (deprecated)
      effect: read
      questions:
      - Can I read opportunity pipeline view settings from the old users route?
      - Where are the legacy pipeline view settings kept?
      instructions:
      - text: Get opportunity pipeline view settings via the deprecated users endpoint.
      - text: Show the legacy opportunity pipeline settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/permissions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a permission
      effect: read
      questions:
      - How do I look up a single permission by ID?
      - What does a specific permission grant?
      instructions:
      - text: Show permission {id}.
        slots:
          id: path.id
      - text: Get details for permission {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{userId}/permissions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one permission for a user
      effect: read
      questions:
      - Does a given user have a specific permission?
      - Can I check one permission on one user?
      instructions:
      - text: Get permission {id} for user {userId}.
        slots:
          id: path.id
          userId: path.userId
      - text: Check user {userId}'s permission {id}.
        slots:
          id: path.id
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{userId}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's permissions
      effect: read
      questions:
      - What permissions does a particular user have?
      - Can I list everything one user is allowed to do?
      instructions:
      - text: List permissions for user {userId}.
        slots:
          userId: path.userId
      - text: Show all of user {userId}'s permissions.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all permissions
      effect: read
      questions:
      - What permissions exist in the system overall?
      - Can I see the complete permissions catalog?
      instructions:
      - text: List all permissions.
      - text: Show every permission defined in the system.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contacts/{id}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a contact into a user
      effect: write
      questions:
      - Can I turn an existing contact into a user?
      - What do I need to supply when converting a contact to a user?
      instructions:
      - text: Convert contact {id} to a user with username {username}.
        slots:
          id: path.id
          username: requestBody.username
      - text: Make contact {id} a user with role {roleName}.
        slots:
          id: path.id
          roleName: requestBody.roleName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/analytics/configurations/opportunity-pipeline/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Save opportunity pipeline settings (deprecated)
      effect: write
      questions:
      - Can I still save a user's opportunity pipeline settings on the deprecated route?
      - Which legacy call updates pipeline view settings per user?
      instructions:
      - text: Update opportunity pipeline settings for user {userId} via the deprecated route.
        slots:
          userId: path.userId
      - text: Save legacy pipeline view settings {settingsDefinition} for user {userId}.
        slots:
          userId: path.userId
          settingsDefinition: requestBody.settingsDefinition
      method: generated
      generated: '2026-10-01'