API Evangelist conversational phrasing for Gainsight PX REST Engagement API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gainsight PX REST Engagement API
  version: 1.0.0
extends: openapi/gainsight-engagement-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: 8
- target: $.paths['/v1/engagement'].get
  update:
    x-apievangelist-phrasing:
      intent: List in-app engagements
      effect: read
      questions:
      - What in-app guides and dialogs have we built?
      - Can I list only engagements of certain content types or by one creator?
      instructions:
      - text: List engagements of content types {contentTypes}.
        slots:
          contentTypes: query.contentTypes
      - text: Show engagements created by {createdById}.
        slots:
          createdById: query.createdById
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/engagement/env'].put
  update:
    x-apievangelist-phrasing:
      intent: Move an engagement to one environment
      effect: write
      questions:
      - How do I move an engagement from QA to Production?
      - Which environments can a single engagement be set to?
      instructions:
      - text: Move engagement {engagementId} to the {env} environment.
        slots:
          engagementId: requestBody.engagementId
          env: requestBody.env
      - text: Set the environment of engagement {engagementId} to {env} only.
        slots:
          engagementId: requestBody.engagementId
          env: requestBody.env
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/engagement/envs'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign an engagement to several environments
      effect: write
      questions:
      - Can one engagement run in both Stage and Production at once?
      - How do I set a list of environments for an engagement?
      instructions:
      - text: Place engagement {engagementId} in environments {envs}.
        slots:
          engagementId: requestBody.engagementId
          envs: requestBody.envs
      - text: Assign multiple environments {envs} to engagement {engagementId}.
        slots:
          envs: requestBody.envs
          engagementId: requestBody.engagementId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/engagement/extended'].get
  update:
    x-apievangelist-phrasing:
      intent: List engagements with rule custom events
      effect: read
      questions:
      - Which custom events does each engagement's audience rule depend on?
      - Can I see engagements together with the custom events used in their targeting?
      instructions:
      - text: List engagements with the custom events used in their audience rules.
      - text: Show extended engagement data for content types {contentTypes}.
        slots:
          contentTypes: query.contentTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/engagement/metadata/survey'].get
  update:
    x-apievangelist-phrasing:
      intent: Get survey metadata for an engagement
      effect: read
      questions:
      - What survey metadata is recorded for a given engagement?
      - Can I pull the survey view details behind one engagement?
      instructions:
      - text: Get survey metadata for engagement {engagementId}.
        slots:
          engagementId: query.engagementId
      - text: Show the survey view data of engagement {engagementId}.
        slots:
          engagementId: query.engagementId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/engagement/state'].put
  update:
    x-apievangelist-phrasing:
      intent: Start or pause an engagement
      effect: write
      questions:
      - How do I pause a guide that's showing to users?
      - Can I start an engagement only in the Stage environment?
      instructions:
      - text: Set engagement {engagementId} to state {state}.
        slots:
          engagementId: requestBody.engagementId
          state: requestBody.state
      - text: Start engagement {engagementId} ({state}) in environments {envs}.
        slots:
          engagementId: requestBody.engagementId
          state: requestBody.state
          envs: requestBody.envs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/engagement/{engagementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app engagement
      effect: read
      questions:
      - How do I look up one engagement's configuration?
      - Can I retrieve an engagement by its ID?
      instructions:
      - text: Get engagement {engagementId}.
        slots:
          engagementId: path.engagementId
      - text: Show the configuration of engagement {engagementId}.
        slots:
          engagementId: path.engagementId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/engagement/{engagementId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an in-app engagement
      effect: destructive
      questions:
      - Can I delete an engagement I no longer need?
      - How is an in-app engagement removed permanently?
      instructions:
      - text: Delete engagement {engagementId}.
        slots:
          engagementId: path.engagementId
      - text: Remove in-app engagement {engagementId}.
        slots:
          engagementId: path.engagementId
      method: generated
      generated: '2026-09-26'