API Evangelist conversational phrasing for OPERA Cloud Front Desk Configuration Credit Card API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OPERA Cloud Front Desk Configuration Credit Card API
  version: 1.0.0
extends: openapi/oracle-hospitality-credit-card-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: 16
- target: $.paths['/authorizationRule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the credit card authorization rule
      effect: read
      questions:
      - Which credit card authorization rule applies to a reservation?
      - Can I see the authorization rule for a given rate code, room type and guarantee code?
      instructions:
      - text: Get the authorization rule for reservation {reservation} at hotel {hotel}.
        slots:
          reservation: query.reservationId
          hotel: query.hotelId
      - text: Show the card authorization rule for rate code {rate_code} and room type {room_type}.
        slots:
          rate_code: query.rateCode
          room_type: query.roomType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cardReaderDelimiters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get card reader delimiters
      effect: read
      questions:
      - What track delimiters does a card reader device use?
      - Can I look up the delimiter settings for one card reader?
      instructions:
      - text: Get the card reader delimiters for device {device}.
        slots:
          device: query.deviceID
      - text: Show the swipe delimiter configuration for card reader {device}.
        slots:
          device: query.deviceID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/creditCardInfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reservation's card type and expiry
      effect: read
      questions:
      - How do I find the card type and expiration date of the card on a reservation?
      - Does the credit card info lookup ever return the full card number?
      instructions:
      - text: Get the card type and expiry for card {card} at hotel {hotel}.
        slots:
          card: query.cardId
          hotel: query.hotelId
      - text: Show the tokenized card details on reservation {reservation} at hotel {hotel}.
        slots:
          reservation: query.reservationId
          hotel: query.hotelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/creditCardTypes/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Validate a credit card type
      effect: read
      questions:
      - Can I check whether a card number matches the card type entered for a payment?
      - Is this card type valid for the payment method on the reservation?
      instructions:
      - text: Validate card type {card_type} for payment method {payment_method}.
        slots:
          card_type: query.cardType
          payment_method: query.paymentMethod
      - text: Check that card {card} is a valid {card_type} card for reservation {reservation}.
        slots:
          card: query.cardId
          card_type: query.cardType
          reservation: query.reservationID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/creditCards/decode'].get
  update:
    x-apievangelist-phrasing:
      intent: Decode swiped card track data
      effect: read
      questions:
      - How can I turn raw card-swipe track data into card details?
      - What does decoding a swiped card return for a hotel?
      instructions:
      - text: Decode track data {track_data} at hotel {hotel}.
        slots:
          track_data: query.trackData
          hotel: query.hotelId
      - text: Decode the swiped card for hotel {hotel}.
        slots:
          hotel: query.hotelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/creditCards/readerDevices'].get
  update:
    x-apievangelist-phrasing:
      intent: List credit card reader devices
      effect: read
      questions:
      - Which credit card reader devices are set up?
      - Can I see the card readers available to a hotel?
      instructions:
      - text: List the credit card reader devices for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      - text: Show all card reader devices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/creditCards/vaultedId'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a credit card's vaulted unique ID
      effect: read
      questions:
      - How do I get the vaulted unique ID for a credit card?
      - Can I look up a card's token ID from the vault instead of storing the number?
      instructions:
      - text: Get the vaulted unique ID for card {card}.
        slots:
          card: requestBody.creditCardUniqueId
      - text: Fetch the card vault ID for {card}.
        slots:
          card: requestBody.creditCardUniqueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hotels/{hotelId}/interfaces/{interfaceLogoId}/customData'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a hotel interface's custom data
      effect: read
      questions:
      - What custom data is stored for a payment interface at my hotel?
      - Can I read custom data for one interface logo ID?
      instructions:
      - text: Get custom data for interface {interface} at hotel {hotel}.
        slots:
          interface: path.interfaceLogoId
          hotel: path.hotelId
      - text: Show interface {interface} custom data at hotel {hotel} with instructions {fetch}.
        slots:
          interface: path.interfaceLogoId
          hotel: path.hotelId
          fetch: query.fetchInstructions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hotels/{hotelId}/interfaces/{interfaceLogoId}/customData'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a hotel interface's custom data
      effect: write
      questions:
      - How can I change custom data on a hotel's payment interface?
      - Can I update interface custom data for one interface logo ID?
      instructions:
      - text: Update custom data for interface {interface} at hotel {hotel} to {details}.
        slots:
          interface: path.interfaceLogoId
          hotel: path.hotelId
          details: requestBody.details
      - text: Change interface {interface} custom data at hotel {hotel}.
        slots:
          interface: path.interfaceLogoId
          hotel: path.hotelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/prepaidCard'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a prepaid card
      effect: read
      questions:
      - Can I look up a prepaid card's details by card number with a query string?
      - What do I need to retrieve a guest's prepaid card at a hotel?
      instructions:
      - text: Get prepaid card {card_number} at hotel {hotel}.
        slots:
          card_number: query.cardNumber
          hotel: query.hotelId
      - text: Look up prepaid card {card_number} at hotel {hotel} with PIN {pin}.
        slots:
          card_number: query.cardNumber
          hotel: query.hotelId
          pin: query.pin
      method: generated
      generated: '2026-10-01'
- target: $.paths['/prepaidCard/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search for a prepaid card via POST body
      effect: read
      questions:
      - Can I search for a prepaid card by sending the card number in a request body instead of the URL?
      - How do I keep a prepaid card number and PIN out of the query string when looking it up?
      instructions:
      - text: Search prepaid card {card_number} at hotel {hotel} using a POST body.
        slots:
          card_number: requestBody.cardNumber
          hotel: requestBody.hotelId
      - text: Search for prepaid card {card_number} tied to reservation {reservation} at hotel {hotel}.
        slots:
          card_number: requestBody.cardNumber
          reservation: requestBody.reservationId
          hotel: requestBody.hotelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/prepaidCardBalance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a prepaid card's balance
      effect: read
      questions:
      - How much balance is left on a guest's prepaid card?
      - Can I check a prepaid card balance with the card number in the URL?
      instructions:
      - text: Get the balance of prepaid card {card_number} at hotel {hotel}.
        slots:
          card_number: query.cardNumber
          hotel: query.hotelId
      - text: Check the remaining balance on card {card_number} at hotel {hotel} with PIN {pin}.
        slots:
          card_number: query.cardNumber
          hotel: query.hotelId
          pin: query.pin
      method: generated
      generated: '2026-10-01'
- target: $.paths['/prepaidCardBalance/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search a prepaid card balance via POST body
      effect: read
      questions:
      - Can I fetch a prepaid card's balance by posting the card number in the body?
      - Which balance lookup keeps the card number and PIN out of the URL?
      instructions:
      - text: Search the balance of prepaid card {card_number} at hotel {hotel} using a POST body.
        slots:
          card_number: requestBody.cardNumber
          hotel: requestBody.hotelId
      - text: Post a balance search for card {card_number} with PIN {pin} at hotel {hotel}.
        slots:
          card_number: requestBody.cardNumber
          pin: requestBody.pin
          hotel: requestBody.hotelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/prepaidCards'].get
  update:
    x-apievangelist-phrasing:
      intent: List prepaid cards at a hotel
      effect: read
      questions:
      - Which prepaid cards are attached to reservations at my hotel?
      - Can I find prepaid cards by room number or guest name?
      instructions:
      - text: List prepaid cards at hotel {hotel}.
        slots:
          hotel: query.hotelId
      - text: Find prepaid cards for room {room} at hotel {hotel} with card details.
        slots:
          room: query.roomNo
          hotel: query.hotelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/secureApplicationSettings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update secure application settings
      effect: write
      questions:
      - How can I change a secure application setting for card handling?
      - Can I update several secure application settings in one request?
      instructions:
      - text: Update the secure application settings to {settings}.
        slots:
          settings: requestBody.settings
      - text: Change secure application setting {settings} for hotel {hotel}.
        slots:
          settings: requestBody.settings
          hotel: header.x-hotelid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services/creditCard/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the credit card service status
      effect: read
      questions:
      - Is the credit card service responding right now?
      - How can I health-check the credit card API?
      instructions:
      - text: Ping the credit card service.
      - text: Check credit card service status for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-10-01'