# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Store Connect User Invitations API
  version: 1.0.0
extends: openapi/ios-userinvitations-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: 6
- target: $.paths['/v1/userInvitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending team invitations
      effect: read
      questions:
      - Who have I invited to my App Store Connect team that hasn't accepted yet?
      - Can I find pending invitations by email address or role?
      instructions:
      - text: List all pending user invitations.
      - text: Find invitations sent to {email}.
        slots:
          email: query.filter[email]
      - text: Show pending invitations for the {roles} role.
        slots:
          roles: query.filter[roles]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/userInvitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a user to the team
      effect: write
      questions:
      - How do I invite a new developer to my team with specific roles?
      - Can I limit a new team member's invitation to only certain apps?
      instructions:
      - text: Invite a new user with {data}.
        slots:
          data: requestBody.data
      - text: 'Send a team invitation with this email, name, roles and app access: {data}.'
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/userInvitations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team invitation
      effect: read
      questions:
      - When does a specific pending invitation expire?
      - What roles were granted in one particular invitation?
      instructions:
      - text: Show user invitation {id}.
        slots:
          id: path.id
      - text: Fetch the email, roles and expiry of invitation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/userInvitations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a team invitation
      effect: destructive
      questions:
      - Can I revoke an invitation I sent to the wrong person?
      - Is there a way to cancel a pending invite before it's accepted?
      instructions:
      - text: Cancel user invitation {id}.
        slots:
          id: path.id
      - text: Revoke the pending invite {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/userInvitations/{id}/relationships/visibleApps'].get
  update:
    x-apievangelist-phrasing:
      intent: List app IDs visible to an invited user
      effect: read
      questions:
      - Which app IDs will an invited user be able to see?
      - Can I get only the app references attached to a pending invitation?
      instructions:
      - text: List only the visible app IDs on invitation {id}.
        slots:
          id: path.id
      - text: Return up to {limit} app linkages for invitation {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/userInvitations/{id}/visibleApps'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps an invited user will have access to
      effect: read
      questions:
      - Which apps, by name and bundle ID, will this invitee be able to access?
      - What app access did I grant in a pending invitation?
      instructions:
      - text: Show the full apps visible to invitation {id}.
        slots:
          id: path.id
      - text: List the names and bundle IDs of apps invitation {id} grants access to.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'