# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Punchh Check In API
  version: 1.0.0
extends: openapi/punchh-check-in-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['/api/auth/checkins/online_order'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a pending online order check-in
      effect: write
      questions:
      - How do I change the details of an online order check-in that's still pending?
      - Do I resend the whole order or just the changes when updating a check-in?
      instructions:
      - text: Update pending check-in {external_uid} to a receipt amount of {receipt_amount}.
        slots:
          external_uid: requestBody.external_uid
          receipt_amount: requestBody.receipt_amount
      - text: Resend the full order for pending check-in {external_uid} with items {menu_items}.
        slots:
          external_uid: requestBody.external_uid
          menu_items: requestBody.menu_items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/checkins/online_order'].post
  update:
    x-apievangelist-phrasing:
      intent: Award loyalty for an online order
      effect: write
      questions:
      - How does a signed-in guest earn points for an online order?
      - Can an online order check-in be created in a pending state and committed later?
      instructions:
      - text: 'Check in online order {transaction_no} ({external_uid}) at store {store_number}: {receipt_amount}, paid {payable}, at {receipt_datetime}.'
        slots:
          external_uid: requestBody.external_uid
          store_number: requestBody.store_number
          transaction_no: requestBody.transaction_no
          receipt_amount: requestBody.receipt_amount
          payable: requestBody.payable
          receipt_datetime: requestBody.receipt_datetime
      - text: Grant points for online order {transaction_no} at store {store_number} in state {state}.
        slots:
          transaction_no: requestBody.transaction_no
          store_number: requestBody.store_number
          state: requestBody.state
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/checkins'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a check-in by its external ID
      effect: read
      questions:
      - How do I retrieve a loyalty check-in using the ID my ordering system assigned?
      - Can I see the details of a check-in I created earlier?
      instructions:
      - text: Fetch the check-in with external ID {external_uid}.
        slots:
          external_uid: requestBody.external_uid
      - text: Show me check-in {external_uid}.
        slots:
          external_uid: requestBody.external_uid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/checkins'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a guest in by store number (legacy)
      effect: write
      questions:
      - Is there an older endpoint that checks a guest in using only a store number?
      - Which check-in endpoint is deprecated in favor of the receipt-based one?
      instructions:
      - text: Use the old check-in endpoint to check in the guest at store {store_number}.
        slots:
          store_number: requestBody.store_number
      - text: Create a legacy store-number check-in at {store_number} for user token {access_token}.
        slots:
          store_number: requestBody.store_number
          access_token: requestBody.access_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/checkins'].delete
  update:
    x-apievangelist-phrasing:
      intent: Void a pending loyalty check-in
      effect: destructive
      questions:
      - How do I cancel a pending check-in when an online order is abandoned?
      - Can a pending loyalty check-in be voided by its external ID?
      instructions:
      - text: Void pending check-in {external_uid}.
        slots:
          external_uid: requestBody.external_uid
      - text: Cancel the loyalty check-in {external_uid} before it's committed.
        slots:
          external_uid: requestBody.external_uid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/checkins'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a check-in without the guest's token
      effect: write
      questions:
      - How can I award points for a future-dated order when I don't have the guest's access token?
      - Can I identify the guest by email or phone when creating a check-in from the back end?
      instructions:
      - text: 'Admin check-in for {email}: order {transaction_no} at store {store_number}, {receipt_amount}, paid {payable}, {receipt_datetime}, ref {external_uid}.'
        slots:
          email: requestBody.email
          transaction_no: requestBody.transaction_no
          store_number: requestBody.store_number
          receipt_amount: requestBody.receipt_amount
          payable: requestBody.payable
          receipt_datetime: requestBody.receipt_datetime
          external_uid: requestBody.external_uid
      - text: From the dashboard, award user {user_id} for order {transaction_no} at store {store_number}.
        slots:
          user_id: requestBody.user_id
          transaction_no: requestBody.transaction_no
          store_number: requestBody.store_number
      method: generated
      generated: '2026-10-01'