# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Teammates API
  version: 1.0.0
extends: openapi/sendgrid-teammates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/v3/teammates'].get
  update:
    x-apievangelist-phrasing:
      intent: List current teammates
      effect: read
      questions:
      - Who are the current teammates on my SendGrid account?
      - Can I page through my teammates with a limit and offset?
      instructions:
      - text: List all current teammates.
      - text: Show {limit} teammates starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/teammates'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a teammate by email
      effect: write
      questions:
      - How do I invite a colleague to my account with specific permissions?
      - Can I invite someone as an admin teammate?
      instructions:
      - text: Invite {email} as a teammate with scopes {scopes}, admin {is_admin}.
        slots:
          email: requestBody.email
          scopes: requestBody.scopes
          is_admin: requestBody.is_admin
      - text: Send a teammate invitation to {email} with admin set to {is_admin} and scopes {scopes}.
        slots:
          email: requestBody.email
          is_admin: requestBody.is_admin
          scopes: requestBody.scopes
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/teammates/{teammate_name}/subuser_access'].get
  update:
    x-apievangelist-phrasing:
      intent: List subusers a teammate can access
      effect: read
      questions:
      - Which subusers can a given teammate reach, and with what scopes?
      - Does an admin teammate see every subuser?
      instructions:
      - text: Show the subusers teammate {teammate_name} can access.
        slots:
          teammate_name: path.teammate_name
      - text: Check whether teammate {teammate_name} can access subuser {username}.
        slots:
          teammate_name: path.teammate_name
          username: query.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/teammates/{username}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a teammate by username
      effect: read
      questions:
      - What permissions does a specific teammate have?
      - Can I look up a single teammate by username?
      instructions:
      - text: Get teammate {username}.
        slots:
          username: path.username
      - text: Show the profile and scopes of teammate {username}.
        slots:
          username: path.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/teammates/{username}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a teammate
      effect: destructive
      questions:
      - Who is allowed to remove a teammate from the account?
      - How do I delete a teammate who has left?
      instructions:
      - text: Delete teammate {username}.
        slots:
          username: path.username
      - text: Remove {username} from my teammates.
        slots:
          username: path.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/teammates/{username}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a teammate's permissions
      effect: write
      questions:
      - Can I promote a teammate to admin?
      - How would I change the scopes an existing teammate has?
      instructions:
      - text: Make teammate {username} an admin by setting admin to {is_admin}, scopes {scopes}.
        slots:
          username: path.username
          is_admin: requestBody.is_admin
          scopes: requestBody.scopes
      - text: Update {username}'s permissions to scopes {scopes} with admin {is_admin}.
        slots:
          username: path.username
          scopes: requestBody.scopes
          is_admin: requestBody.is_admin
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/teammates/pending'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending teammate invitations
      effect: read
      questions:
      - Which teammate invitations are still waiting to be accepted?
      - How long does a pending teammate invite stay valid?
      instructions:
      - text: List all pending teammate invitations.
      - text: Show invites that haven't been accepted yet.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/teammates/pending/{token}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending teammate invite
      effect: destructive
      questions:
      - Can I withdraw a teammate invitation before it's accepted?
      - What's needed to delete a pending invite?
      instructions:
      - text: Delete the pending teammate invite {token}.
        slots:
          token: path.token
      - text: Cancel invitation {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/teammates/pending/{token}/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a teammate invitation
      effect: write
      questions:
      - What do I do if a teammate's invitation expired?
      - Does resending an invite reset its 7-day expiration?
      instructions:
      - text: Resend teammate invitation {token}.
        slots:
          token: path.token
      - text: Send invite {token} again to refresh its expiry.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'