# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST Appointments API
  version: 1.0.0
extends: openapi/cvent-event-cloud-appointments-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: 16
- target: $.paths['/appointment-attendees'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment attendees
      effect: read
      questions:
      - Who is taking part in appointments at my events?
      - Can I filter appointment attendees with a query filter?
      instructions:
      - text: List appointment attendees.
      - text: List appointment attendees matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-attendees/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one appointment attendee
      effect: read
      questions:
      - What are the details of a specific appointment attendee?
      - How do I look up an appointment attendee by ID?
      instructions:
      - text: Get appointment attendee {id}.
        slots:
          id: path.id
      - text: Show the details of appointment attendee {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-availability-times'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment availability times
      effect: read
      questions:
      - When have hosts and attendees said they're available for appointments?
      - Can I filter appointment availability windows?
      instructions:
      - text: List appointment availability times.
      - text: List appointment availability times matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-availability-times/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one appointment availability time
      effect: read
      questions:
      - What does a specific availability time slot contain?
      - How do I fetch a single appointment availability record?
      instructions:
      - text: Get appointment availability time {id}.
        slots:
          id: path.id
      - text: Show availability slot {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment events
      effect: read
      questions:
      - Which of my events have appointment scheduling set up?
      - Can I page through appointment events with a filter?
      instructions:
      - text: List appointment events.
      - text: List appointment events matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one appointment event
      effect: read
      questions:
      - What are the settings of a particular appointment event?
      - How do I retrieve an appointment event by ID?
      instructions:
      - text: Get appointment event {id}.
        slots:
          id: path.id
      - text: Show details for appointment event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointment-available-times'].get
  update:
    x-apievangelist-phrasing:
      intent: Find open times to book an appointment
      effect: read
      questions:
      - What time slots and locations are still open for booking appointments?
      - When can I schedule a meeting in a given appointment event?
      instructions:
      - text: Show open appointment times in appointment event {id}.
        slots:
          id: path.id
      - text: Find bookable times and locations in appointment event {id} matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointment-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment types for an appointment event
      effect: read
      questions:
      - What kinds of appointments can be booked in an appointment event?
      - Which appointment type ID do I need to create an appointment?
      instructions:
      - text: List appointment types for appointment event {id}.
        slots:
          id: path.id
      - text: Show the appointment types available in appointment event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointments'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an appointment
      effect: write
      questions:
      - How do I book a meeting between hosts and attendees at an event?
      - Can I create an appointment without sending notification emails?
      instructions:
      - text: Book an appointment of type {appointmentTypeId} in appointment event {id} from {startTime} to {endTime}.
        slots:
          appointmentTypeId: requestBody.appointmentTypeId
          id: path.id
          startTime: requestBody.startTime
          endTime: requestBody.endTime
      - text: 'Create a {appointmentTypeId} appointment in event {id} with attendees {attendees}, suppressing notifications: {suppressNotifications}.'
        slots:
          appointmentTypeId: requestBody.appointmentTypeId
          id: path.id
          attendees: requestBody.attendees
          suppressNotifications: query.suppressNotifications
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointments/{apptId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scheduled appointment
      effect: write
      questions:
      - How do I change an appointment that's already booked?
      - Can I update an appointment quietly without notifying participants?
      instructions:
      - text: Update appointment {apptId} in appointment event {id}.
        slots:
          apptId: path.apptId
          id: path.id
      - text: 'Modify appointment {apptId} in event {id} without notifications: {suppressNotifications}.'
        slots:
          apptId: path.apptId
          id: path.id
          suppressNotifications: query.suppressNotifications
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointments/{apptId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an appointment
      effect: destructive
      questions:
      - How do I cancel a booked appointment?
      - Can I cancel an appointment without emailing the participants?
      instructions:
      - text: Cancel appointment {apptId} in appointment event {id}.
        slots:
          apptId: path.apptId
          id: path.id
      - text: 'Cancel appointment {apptId} in event {id} silently: {suppressNotifications}.'
        slots:
          apptId: path.apptId
          id: path.id
          suppressNotifications: query.suppressNotifications
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment locations
      effect: read
      questions:
      - Where can appointments take place in an appointment event?
      - Which meeting rooms or tables are set up for appointments?
      instructions:
      - text: List appointment locations in appointment event {id}.
        slots:
          id: path.id
      - text: Show the meeting locations for appointment event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-meeting-interests'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendees' meeting interests
      effect: read
      questions:
      - Who do attendees want to meet with at my events?
      - Can I list meeting interests submitted for appointments?
      instructions:
      - text: List appointment meeting interests.
      - text: List meeting interests matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-meeting-interests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one attendee's meeting interests
      effect: read
      questions:
      - What meeting interests did a particular attendee submit?
      - How do I look up a meeting interest record by its ID?
      instructions:
      - text: Get meeting interest {id}.
        slots:
          id: path.id
      - text: Show the meeting interests in record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointments'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointments
      effect: read
      questions:
      - What appointments have been booked across my events?
      - Can I list appointments scheduled after a certain date?
      instructions:
      - text: List all appointments.
      - text: List appointments matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one appointment
      effect: read
      questions:
      - What are the time, location and participants of a specific appointment?
      - How do I fetch an appointment by ID?
      instructions:
      - text: Get appointment {id}.
        slots:
          id: path.id
      - text: Show the details of appointment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'