# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Punchh WiFi Acquisition API
  version: 1.0.0
extends: openapi/punchh-wifi-acquisition-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: 4
- target: $.paths['/api2/wifi/users/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a WiFi guest's email from the captive portal
      effect: read
      questions:
      - Can the WiFi login page check whether a guest's email is already a member?
      - What does the client-signed WiFi look-up return for an unknown email?
      instructions:
      - text: From the WiFi portal, check if {email} is already a member.
        slots:
          email: requestBody.email
      - text: Look up email {email} for WiFi sign-up using app client {client}.
        slots:
          email: requestBody.email
          client: requestBody.client
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/wifi/users/'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a guest from the WiFi captive portal
      effect: write
      questions:
      - How does a guest who logs into store WiFi join the eClub from the portal?
      - Can the WiFi portal's signed enrollment record which store the guest was in?
      instructions:
      - text: From the WiFi portal, enroll {user} in the eClub.
        slots:
          user: requestBody.user
      - text: Sign up WiFi guest {user} at location {location_id} through the portal.
        slots:
          user: requestBody.user
          location_id: requestBody.location_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/wifi/users'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a WiFi guest by email or phone as an admin
      effect: read
      questions:
      - Using an admin key, can I check if a phone number already belongs to a member?
      - Does the admin WiFi guest look-up need an email or a phone?
      instructions:
      - text: With the admin key, check if phone {phone} is a member.
        slots:
          phone: query.phone
      - text: As an admin, look up whether {email} already exists before WiFi enrollment.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/wifi/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll WiFi guests into eClub as an admin
      effect: write
      questions:
      - Can a WiFi vendor enroll guests into the eClub with a business admin key?
      - Which wins if I send both a location ID and a store number when enrolling WiFi guests?
      instructions:
      - text: Using the admin key, enroll {user} into eClub from store {store_number}.
        slots:
          user: requestBody.user
          store_number: requestBody.store_number
      - text: Admin-enroll WiFi guest {user} with WiFi as the acquisition channel.
        slots:
          user: requestBody.user
      method: generated
      generated: '2026-10-01'