API Evangelist conversational phrasing for Cvent REST Housing API

# 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-registration-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 housing event
      effect: write
      questions:
      - How does an integration partner get authorized to a Passkey housing event?
      - 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 Passkey event with owner-supplied code {accessCode}.
        slots:
          accessCode: header.Cvent-Access-Code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/summaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List the housing events I can access
      effect: read
      questions:
      - Which housing events does my integration have access to?
      - Where do I find housing event IDs for the other housing calls?
      instructions:
      - text: List summaries of the housing events my integration can access.
      - text: Show 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 a housing event's details
      effect: read
      questions:
      - What are the dates and attendee types for a housing event?
      - Can I see the configuration of a specific housing event?
      instructions:
      - text: Get details for housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show the name, dates and attendee types of 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 a housing event?
      - Can I get the hotel list in a particular language?
      instructions:
      - text: List the hotels in housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show housing event {housingEventId}'s block 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 and description of a specific hotel in my event's block?
      - Can I fetch localized details for a single housing hotel?
      instructions:
      - text: Get hotel {hotelId} in housing event {housingEventId}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Show the full details of hotel {hotelId} 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 which nights a hotel has rooms
      effect: read
      questions:
      - Which nights still have rooms available at a hotel in my block?
      - Can I filter hotel availability by attendee type or date range?
      instructions:
      - text: Show available room nights at hotel {hotelId} in housing event {housingEventId}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Check hotel {hotelId} availability for housing 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 a hotel's room types for an event
      effect: read
      questions:
      - What room types, like king or double queen, does a block hotel offer?
      - Can I filter a hotel's room types for the housing event?
      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 housing 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 specific room type include and what does it look like?
      - Can I get images and a description for one room type?
      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 of room type {roomTypeId}, hotel {hotelId}, housing 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 a given type have been picked up each night?
      - What's the remaining inventory by date for one 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 rooms picked up versus remaining per date 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}/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated inventory for a housing event
      effect: read
      questions:
      - What's the overall room pickup across every hotel in my housing event?
      - Can I see a high-level, date-sorted inventory for the whole event block?
      instructions:
      - text: Show aggregated inventory across all hotels for housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Get the event-wide room block inventory by date for housing 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 rooms in my housing event?
      - Can I list housing reservations changed after a certain date?
      instructions:
      - text: List reservations for housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show housing event {housingEventId} reservations modified 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 a registrant into the hotel booking flow with their details prefilled?
      - Does a reservation request give back a guest-specific booking link?
      instructions:
      - text: Create a reservation request in housing event {housingEvent} for guests {guests}.
        slots:
          housingEvent: requestBody.housingEvent
          guests: requestBody.guests
      - text: Start a hotel booking request for {guests} in housing event {housingEvent} as attendee type {attendeeTypeCode}.
        slots:
          guests: requestBody.guests
          housingEvent: requestBody.housingEvent
          attendeeTypeCode: requestBody.attendeeTypeCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reservation request's details
      effect: read
      questions:
      - What's the booking site URL for a guest's reservation request?
      - Has a reservation been linked to a given reservation request yet?
      instructions:
      - text: Get reservation request {reservationRequestsId}.
        slots:
          reservationRequestsId: path.reservationRequestsId
      - text: Show the guest details and booking link for reservation 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 of its current details?
      instructions:
      - text: Update the 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 reservation request as cancelled?
      instructions:
      - text: Cancel reservation request {reservationRequestsId}.
        slots:
          reservationRequestsId: path.reservationRequestsId
      - text: Set reservation request {reservationRequestsId} to cancelled, leaving any linked booking 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 directly with the hotel; can I tie that booking to their request?
      - How do I connect 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 off-flow booking {reservationId} to guest 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 in its place?
      instructions:
      - text: Unlink reservation {reservationId} from reservation request {reservationRequestsId}.
        slots:
          reservationId: path.reservationId
          reservationRequestsId: path.reservationRequestsId
      - text: Detach booking {reservationId} from guest request {reservationRequestsId} so another can be linked.
        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 instead of sending them a booking link?
      - What do I need, like hotel and room type, to create a reservation in a housing event?
      instructions:
      - text: Book a room at hotel {hotel} in housing event {housingEvent} from {startDate} to {endDate}.
        slots:
          hotel: requestBody.hotel
          housingEvent: requestBody.housingEvent
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Create a {roomType} reservation at hotel {hotel} for {guests} in housing event {housingEvent}.
        slots:
          roomType: requestBody.roomType
          hotel: requestBody.hotel
          guests: requestBody.guests
          housingEvent: requestBody.housingEvent
      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:
      - What are the stay dates and room for a reservation from a Passkey callback?
      - Can I look up a single hotel booking by its reservation ID?
      instructions:
      - text: Get reservation {reservationId}.
        slots:
          reservationId: path.reservationId
      - text: Show the guest, dates and hotel for booking {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 hotel booking that already exists?
      - Do I need to send the whole reservation when modifying it?
      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 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 a reservation also cancel its reservation request?
      instructions:
      - text: Cancel reservation {reservationId}.
        slots:
          reservationId: path.reservationId
      - text: Cancel the hotel booking {reservationId} but keep its guest request open.
        slots:
          reservationId: path.reservationId
      method: generated
      generated: '2026-09-26'