# 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 Housing API
  version: 1.0.0
extends: openapi/cvent-housing-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: 21
- target: $.paths['/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect an integration to a Passkey housing event
      effect: write
      questions:
      - How do I authorize my integration for a Passkey event using an access code?
      - What do I need from the event owner before I can call the housing endpoints?
      instructions:
      - text: Create a housing connection using access code {accessCode}.
        slots:
          accessCode: header.Cvent-Access-Code
      - text: Connect my integration to the event the owner shared access code {accessCode} for.
        slots:
          accessCode: header.Cvent-Access-Code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/summaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List housing events my integration can access
      effect: read
      questions:
      - Which housing events does my integration have access to?
      - Where do I find housing event IDs to use in other calls?
      instructions:
      - text: List summaries of the housing events I'm connected to.
      - text: Find housing event summaries matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a housing event
      effect: read
      questions:
      - What dates and attendee types are configured for a housing event?
      - Can I see the full configuration of one housing event?
      instructions:
      - text: Get the details of housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show attendee types and dates for housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels'].get
  update:
    x-apievangelist-phrasing:
      intent: List hotels in a housing event's room block
      effect: read
      questions:
      - Which hotels are in the room block for my housing event?
      - Can I get the hotel list in another language?
      instructions:
      - text: List the hotels in housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show housing event {housingEventId} hotels in locale {locale}.
        slots:
          housingEventId: path.housingEventId
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one hotel's details in a housing event
      effect: read
      questions:
      - What's the address of a specific hotel in my housing block?
      - Can I fetch localized content for one hotel?
      instructions:
      - text: Get hotel {hotelId} in housing event {housingEventId}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Show hotel {hotelId} details for housing event {housingEventId} in {locale}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}/available-nights'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a hotel's available room nights
      effect: read
      questions:
      - Which nights still have rooms available at a hotel in my block?
      - Can I check availability for one attendee type over a date range?
      instructions:
      - text: Show available nights at hotel {hotelId} for housing event {housingEventId}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Check room-night availability at hotel {hotelId}, event {housingEventId}, filtered by {filter}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}/room-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List room types at a hotel
      effect: read
      questions:
      - What room types, like Standard King, does a hotel offer for my event?
      - Can I filter the room categories available at a block hotel?
      instructions:
      - text: List room types at hotel {hotelId} for housing event {housingEventId}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Show hotel {hotelId}'s room categories in event {housingEventId} matching {filter}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}/room-types/{roomTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a room type's description and images
      effect: read
      questions:
      - What does a particular room type look like, with description and photos?
      - Can I get a room type's description in a different language?
      instructions:
      - text: Get room type {roomTypeId} at hotel {hotelId} in housing event {housingEventId}.
        slots:
          roomTypeId: path.roomTypeId
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Show the description and images for room type {roomTypeId}, hotel {hotelId}, event {housingEventId}.
        slots:
          roomTypeId: path.roomTypeId
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}/room-types/{roomTypeId}/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get date-by-date inventory for a room type
      effect: read
      questions:
      - How many rooms of one type have been picked up each night?
      - Can I see rooms remaining by date for a specific room type?
      instructions:
      - text: Show nightly inventory for room type {roomTypeId} at hotel {hotelId}, housing event {housingEventId}.
        slots:
          roomTypeId: path.roomTypeId
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Get pickup and remaining rooms for room type {roomTypeId} at hotel {hotelId} in event {housingEventId}.
        slots:
          roomTypeId: path.roomTypeId
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregate inventory for a housing event
      effect: read
      questions:
      - What's the overall room pickup across all hotels in my block?
      - Can I get a high-level, date-sorted inventory view for the whole housing event?
      instructions:
      - text: Get the aggregate inventory for housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show total rooms and pickup by date across all hotels in event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/reservations'].get
  update:
    x-apievangelist-phrasing:
      intent: List reservations in a housing event
      effect: read
      questions:
      - Who has booked hotel rooms for my event so far?
      - Can I list reservations modified since a certain date?
      instructions:
      - text: List reservations in housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show reservations for event {housingEventId} changed after {after}.
        slots:
          housingEventId: path.housingEventId
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reservation request for a guest
      effect: write
      questions:
      - How do I send an attendee a personalized hotel booking link?
      - Can I prefill guest details before they book a room?
      instructions:
      - text: Create a reservation request in housing event {housingEvent} for guests {guests}.
        slots:
          housingEvent: requestBody.housingEvent
          guests: requestBody.guests
      - text: Start a booking request for {guests} at hotel {hotel} in event {housingEvent}.
        slots:
          guests: requestBody.guests
          hotel: requestBody.hotel
          housingEvent: requestBody.housingEvent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reservation request and its booking link
      effect: read
      questions:
      - What's the booking site URL for a guest's reservation request?
      - Has a reservation been linked to this reservation request yet?
      instructions:
      - text: Get reservation request {reservationRequestsId}.
        slots:
          reservationRequestsId: path.reservationRequestsId
      - text: Show the booking link and linked reservation for request {reservationRequestsId}.
        slots:
          reservationRequestsId: path.reservationRequestsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update guest details on a reservation request
      effect: write
      questions:
      - Can I change a guest's name or email on a reservation request?
      - Does updating a reservation request overwrite all its current fields?
      instructions:
      - text: Update guests on reservation request {reservationRequestsId} to {guests}.
        slots:
          reservationRequestsId: path.reservationRequestsId
          guests: requestBody.guests
      - text: Set the special request on reservation request {reservationRequestsId} to {specialRequest}.
        slots:
          reservationRequestsId: path.reservationRequestsId
          specialRequest: requestBody.specialRequest
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a reservation request
      effect: destructive
      questions:
      - Does cancelling a reservation request also cancel the hotel booking?
      - How do I mark a guest's booking request as cancelled?
      instructions:
      - text: Cancel reservation request {reservationRequestsId}.
        slots:
          reservationRequestsId: path.reservationRequestsId
      - text: Set booking request {reservationRequestsId} to cancelled, leaving any linked reservation alone.
        slots:
          reservationRequestsId: path.reservationRequestsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}/reservations/{reservationId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a reservation to a reservation request
      effect: write
      questions:
      - A guest booked by calling the hotel directly; how do I tie that booking to their request?
      - Can I attach an existing reservation to a reservation request?
      instructions:
      - text: Link reservation {reservationId} to reservation request {reservationRequestsId}.
        slots:
          reservationId: path.reservationId
          reservationRequestsId: path.reservationRequestsId
      - text: Attach the staff-booked reservation {reservationId} to request {reservationRequestsId}.
        slots:
          reservationId: path.reservationId
          reservationRequestsId: path.reservationRequestsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}/reservations/{reservationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a reservation from a reservation request
      effect: destructive
      questions:
      - How do I free up a reservation request after its linked booking was cancelled?
      - Can I detach a reservation so a new one can be linked instead?
      instructions:
      - text: Unlink reservation {reservationId} from reservation request {reservationRequestsId}.
        slots:
          reservationId: path.reservationId
          reservationRequestsId: path.reservationRequestsId
      - text: Detach booking {reservationId} from request {reservationRequestsId} so it can be relinked.
        slots:
          reservationId: path.reservationId
          reservationRequestsId: path.reservationRequestsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations'].post
  update:
    x-apievangelist-phrasing:
      intent: Book a hotel reservation for a guest
      effect: write
      questions:
      - Can I book a hotel room directly for a guest without a booking link?
      - What do I need, like hotel and room type, to create a reservation?
      instructions:
      - text: Book a {roomType} room at hotel {hotel} in housing event {housingEvent} from {startDate} to {endDate}.
        slots:
          roomType: requestBody.roomType
          hotel: requestBody.hotel
          housingEvent: requestBody.housingEvent
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Create a reservation at hotel {hotel} for event {housingEvent} for guests {guests}.
        slots:
          hotel: requestBody.hotel
          housingEvent: requestBody.housingEvent
          guests: requestBody.guests
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations/{reservationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a hotel reservation's details
      effect: read
      questions:
      - A callback gave me a reservation ID; how do I get the full booking?
      - What are the stay dates and guest details on a specific reservation?
      instructions:
      - text: Get reservation {reservationId}.
        slots:
          reservationId: path.reservationId
      - text: Look up the booking details for reservation {reservationId}.
        slots:
          reservationId: path.reservationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations/{reservationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify an existing hotel reservation
      effect: write
      questions:
      - Can I change the dates on a guest's existing hotel booking?
      - Do I have to send the whole reservation object when modifying a booking?
      instructions:
      - text: Change reservation {reservationId} to check in {startDate} and check out {endDate}.
        slots:
          reservationId: path.reservationId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Switch existing booking {reservationId} to room type {roomType}.
        slots:
          reservationId: path.reservationId
          roomType: requestBody.roomType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations/{reservationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a hotel reservation
      effect: destructive
      questions:
      - How do I cancel a guest's hotel booking?
      - Does cancelling the reservation also cancel its reservation request?
      instructions:
      - text: Cancel hotel reservation {reservationId}.
        slots:
          reservationId: path.reservationId
      - text: Cancel the room booking {reservationId} but keep its reservation request.
        slots:
          reservationId: path.reservationId
      method: generated
      generated: '2026-09-26'