# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Sign Virtual Room API
  version: 1.0.0
extends: openapi/conga-virtualroom-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: 8
- target: $.paths['/v1/cs-packages/{packageId}/virtual-room/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's virtual room settings
      effect: read
      questions:
      - How do I check whether a transaction has a virtual room with video enabled?
      - What virtual room configuration is set on a package?
      instructions:
      - text: Get the virtual room configuration for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Show the video and host settings of package {packageId}'s virtual room.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/virtual-room/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure a package's virtual room
      effect: write
      questions:
      - How do I turn on video recording for a virtual room signing session?
      - Can I schedule the start time and host of a virtual room?
      instructions:
      - text: Enable video recording {videoRecording} for package {packageId}'s virtual room.
        slots:
          videoRecording: requestBody.videoRecording
          packageId: path.packageId
      - text: Set the virtual room for package {packageId} to start at {startDatetime} hosted by {hostUid}.
        slots:
          packageId: path.packageId
          startDatetime: requestBody.startDatetime
          hostUid: requestBody.hostUid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/virtual-room/config/masked-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List masked fields in a virtual room
      effect: read
      questions:
      - Which fields are hidden from other signers in a virtual room transaction?
      - How do I see the masked field list for a package?
      instructions:
      - text: List masked fields for package {packageId}'s virtual room.
        slots:
          packageId: path.packageId
      - text: Show which fields are masked from other signers in package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/virtual-room/config/masked-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define the set of masked fields
      effect: write
      questions:
      - Can I define the whole list of fields to mask in a virtual room at once?
      - How do I set up field masking for a virtual room transaction?
      instructions:
      - text: Define the masked fields for package {packageId}'s virtual room.
        slots:
          packageId: path.packageId
      - text: Set the full masked-field list on package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/virtual-room/config/masked-fields/{maskedFieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Mask one more field in a virtual room
      effect: write
      questions:
      - How do I add a single field to the masked list of a virtual room?
      - Can I hide one specific field from other signers?
      instructions:
      - text: Mask field {maskedFieldId} in package {packageId}'s virtual room.
        slots:
          maskedFieldId: path.maskedFieldId
          packageId: path.packageId
      - text: Add field {maskedFieldId} to the masked fields of package {packageId}.
        slots:
          maskedFieldId: path.maskedFieldId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/virtual-room/config/masked-fields/{maskedFieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unmask a field in a virtual room
      effect: destructive
      questions:
      - How do I stop masking a field so other signers can see it?
      - Can I remove one field from the masked list?
      instructions:
      - text: Remove field {maskedFieldId} from the masked fields of package {packageId}.
        slots:
          maskedFieldId: path.maskedFieldId
          packageId: path.packageId
      - text: Unmask field {maskedFieldId} in package {packageId}'s virtual room.
        slots:
          maskedFieldId: path.maskedFieldId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-virtual-room-video/{packageId}/download-recording/{recordingUid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a virtual room recording
      effect: read
      questions:
      - How do I download the video of a virtual room session?
      - Can I fetch a specific recording file by its ID?
      instructions:
      - text: Download recording {recordingUid} for package {packageId}.
        slots:
          recordingUid: path.recordingUid
          packageId: path.packageId
      - text: Fetch the video file {recordingUid} from package {packageId}'s virtual room.
        slots:
          recordingUid: path.recordingUid
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-virtual-room-video/{packageId}/recordings'].get
  update:
    x-apievangelist-phrasing:
      intent: List virtual room recordings
      effect: read
      questions:
      - What session recordings are available for a virtual room transaction?
      - How do I find the recording IDs for a package?
      instructions:
      - text: List virtual room recordings for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Show the available session videos for package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'