API Evangelist conversational phrasing for Sigma Computing Members API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sigma Computing Members API
  version: 1.0.0
extends: openapi/sigma-computing-members-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: 12
- target: $.paths['/v2/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the organization (v2)
      effect: read
      questions:
      - How do I find a Sigma user by email address with the original v2 members list?
      - Can the v2 members list include deactivated or archived users?
      instructions:
      - text: Using the v2 members list, find the user with email {email}.
        slots:
          email: query.email
      - text: 'List all users via v2, including inactive ones: {includeInactive}.'
        slots:
          includeInactive: query.includeInactive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a new user
      effect: write
      questions:
      - How do I add a new user to Sigma and send them an invitation?
      - Can I create a user and put them on teams at the same time?
      - Is it possible to add a guest user without emailing an invite?
      instructions:
      - text: Create user {firstName} {lastName} with email {email}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
      - text: Add {email} ({firstName} {lastName}) as a {memberType} and add them to teams {addToTeams}.
        slots:
          email: requestBody.email
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          memberType: requestBody.memberType
          addToTeams: requestBody.addToTeams
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members/{memberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user by member ID
      effect: read
      questions:
      - How do I look up one user's profile by their member ID?
      - What account type is a particular user assigned?
      instructions:
      - text: Get user {memberId}.
        slots:
          memberId: path.memberId
      - text: Show the profile and account type of member {memberId}.
        slots:
          memberId: path.memberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members/{memberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a user
      effect: destructive
      questions:
      - Can a Sigma user be fully deleted, or only deactivated?
      - What happens to a deactivated user's documents?
      instructions:
      - text: Deactivate user {memberId}.
        slots:
          memberId: path.memberId
      - text: Offboard member {memberId} and hand their documents to the API credential owner.
        slots:
          memberId: path.memberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members/{memberId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user's profile or account type
      effect: write
      questions:
      - How do I change a user's account type or email?
      - Can I deactivate someone and reassign their documents to a specific person?
      instructions:
      - text: Change member {memberId}'s account type to {memberType}.
        slots:
          memberId: path.memberId
          memberType: requestBody.memberType
      - text: Mark member {memberId} inactive and transfer their documents to {newOwnerId}.
        slots:
          memberId: path.memberId
          newOwnerId: requestBody.newOwnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members/{memberId}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents a user can access
      effect: read
      questions:
      - Which workbooks and folders can a specific user open?
      - Can I filter a user's accessible files to only data models?
      instructions:
      - text: List the documents and folders member {memberId} can access.
        slots:
          memberId: path.memberId
      - text: Show files of type {typeFilters} accessible to member {memberId}.
        slots:
          typeFilters: query.typeFilters
          memberId: path.memberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members/{memberId}/files/favorites'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's favorite documents
      effect: read
      questions:
      - What documents has a user marked as favorites?
      - How do I see someone's starred workbooks?
      instructions:
      - text: List favorite documents of member {memberId}.
        slots:
          memberId: path.memberId
      - text: Show what user {memberId} has favorited.
        slots:
          memberId: path.memberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members/{memberId}/files/recents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's recent documents
      effect: read
      questions:
      - What has a user opened recently?
      - Can the recent files list include explorations too?
      instructions:
      - text: List recent documents for member {memberId}.
        slots:
          memberId: path.memberId
      - text: 'Show member {memberId}''s recent files including explorations: {includeExplorations}.'
        slots:
          memberId: path.memberId
          includeExplorations: query.includeExplorations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members/{memberId}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a user's OAuth refresh tokens
      effect: destructive
      questions:
      - How do I stop Sigma from issuing new OAuth access tokens for a user?
      - Does revoking a user's tokens end their current session?
      instructions:
      - text: Revoke the OAuth refresh tokens for member {memberId}.
        slots:
          memberId: path.memberId
      - text: Cut off SSO and warehouse token refresh for user {memberId}.
        slots:
          memberId: path.memberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members/{memberId}/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled exports a user owns
      effect: read
      questions:
      - Which scheduled exports does a particular user own across all workbooks?
      - Can an admin see the export schedules belonging to another user?
      instructions:
      - text: List scheduled exports owned by member {memberId}.
        slots:
          memberId: path.memberId
      - text: Show every export schedule user {memberId} owns.
        slots:
          memberId: path.memberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/members/{memberId}/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's teams
      effect: read
      questions:
      - Which teams does a user belong to?
      - How do I check someone's team memberships?
      instructions:
      - text: List the teams member {memberId} is on.
        slots:
          memberId: path.memberId
      - text: Show team memberships for user {memberId}.
        slots:
          memberId: path.memberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2.1/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List users (paginated v2.1)
      effect: read
      questions:
      - Which members endpoint paginates by default?
      - How do I page through all users with the v2.1 API?
      instructions:
      - text: Page through all users with v2.1, {limit} per page.
        slots:
          limit: query.limit
      - text: Look up email {email} using the paginated v2.1 members list.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'