Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Migration API

5 actions 5 updates phrasing extends openapi/punchh-migration-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Punchh's API. It is a proposal applied on top of the contract, not a document Punchh publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api2/mobile/verify_token'].put
$.paths['/api2/mobile/verify_token'].post
$.paths['/api2/mobile/migration_lookup'].get
$.paths['/api2/mobile/migration_lookup'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mobile Migration API
  version: 1.0.0
extends: openapi/punchh-migration-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/mobile/verify_token'].put
  update:
    x-apievangelist-phrasing:
      intent: Verify a migration one-time password
      effect: write
      questions:
      - How do I confirm the OTP a guest received during account migration?
      - Which verification modes does the migration OTP check accept?
      instructions:
      - text: Verify migration OTP {token} via {mode}.
        slots:
          token: requestBody.token
          mode: requestBody.verification_mode
      - text: Confirm my one-time code {token} sent by {mode}.
        slots:
          token: requestBody.token
          mode: requestBody.verification_mode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/verify_token'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a migration one-time password
      effect: write
      questions:
      - Can I email a guest a one-time password to move their old loyalty account?
      - What starts the secure migration flow for a guest?
      instructions:
      - text: Generate and email a migration OTP for app client {client}.
        slots:
          client: requestBody.client
      - text: Send me a one-time password to migrate my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/migration_lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a guest is in migration data
      effect: read
      questions:
      - Is a guest present in the business's imported migration data?
      - Can I check migration eligibility by email or phone alone?
      instructions:
      - text: Check whether {email} exists in the migration data.
        slots:
          email: requestBody.email
      - text: See if phone {phone} has a migrated account.
        slots:
          phone: requestBody.phone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/migration_lookup'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a guest's migrated account details
      effect: read
      questions:
      - What details were imported for a guest from the old loyalty program?
      - Can I find a migrated guest by their old card number?
      instructions:
      - text: Get migrated account details for card number {card_number}.
        slots:
          card_number: requestBody.card_number
      - text: Return the migration record for {first_name} {last_name} with email {email}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
      method: generated
      generated: '2026-10-01'