# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mobile Check Ins API
  version: 1.0.0
extends: openapi/punchh-check-ins-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: 6
- target: $.paths['/api2/mobile/checkins/barcode'].post
  update:
    x-apievangelist-phrasing:
      intent: Earn points by scanning a receipt barcode
      effect: write
      questions:
      - How does a guest get points by scanning the barcode on their receipt?
      - Can a guest type in the receipt barcode manually instead of scanning it?
      instructions:
      - text: Check me in with receipt barcode {bar_code}.
        slots:
          bar_code: requestBody.bar_code
      - text: Create a check-in for barcode {bar_code} at location {location_id}.
        slots:
          bar_code: requestBody.bar_code
          location_id: requestBody.location_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/checkins/qrcode'].post
  update:
    x-apievangelist-phrasing:
      intent: Earn points by scanning a QR code
      effect: write
      questions:
      - Can guests earn loyalty points by scanning a QR code in the app?
      - Does a QR check-in record the guest's GPS location?
      instructions:
      - text: Check me in with QR code {qr_decoded}.
        slots:
          qr_decoded: requestBody.qr_decoded
      - text: Create a QR check-in for {qr_decoded} at latitude {latitude}, longitude {longitude}.
        slots:
          qr_decoded: requestBody.qr_decoded
          latitude: requestBody.latitude
          longitude: requestBody.longitude
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/checkins/receipt_image'].post
  update:
    x-apievangelist-phrasing:
      intent: Earn points by uploading a receipt photo
      effect: write
      questions:
      - Can a guest snap a photo of a receipt to get loyalty credit?
      - When are points added for a receipt image check-in?
      instructions:
      - text: Submit receipt image {receipt_url} for a check-in.
        slots:
          receipt_url: requestBody.receipt_url
      - text: Claim points with receipt photo {receipt_url} from location {location_id}.
        slots:
          receipt_url: requestBody.receipt_url
          location_id: requestBody.location_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/checkins'].get
  update:
    x-apievangelist-phrasing:
      intent: List a guest's check-ins
      effect: read
      questions:
      - Where can a guest see all of their past check-ins?
      - Which visits has a guest checked in for?
      instructions:
      - text: List all my check-ins.
      - text: Show every check-in for app client {client}.
        slots:
          client: requestBody.client
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/checkins/account_balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a guest's rewards and banked balance
      effect: read
      questions:
      - What membership level and banked currency does a guest have?
      - Can I see a guest's reward IDs along with their account balance?
      instructions:
      - text: Show my account balance and membership level.
      - text: Get reward and banked currency details for app client {client}.
        slots:
          client: requestBody.client
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/checkins/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one transaction
      effect: read
      questions:
      - How can a guest see what happened on a specific transaction?
      - Can I look up a check-in transaction by its ID?
      instructions:
      - text: Show details of transaction {transaction_id}.
        slots:
          transaction_id: requestBody.transaction_id
      - text: Get what I earned on transaction {transaction_id}.
        slots:
          transaction_id: requestBody.transaction_id
      method: generated
      generated: '2026-10-01'