Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Online Ordering and SSO Check User Balance API

5 actions 5 updates phrasing extends openapi/punchh-check-user-balance-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['/api/auth/checkins/balance'].get

$.paths['/api/auth/rewards'].get

$.paths['/api/auth/users/balance'].get

$.paths['/api/auth/balance_timelines'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Online Ordering and SSO Check User Balance API
  version: 1.0.0
extends: openapi/punchh-check-user-balance-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['/api/auth/checkins/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a guest's points and credit totals
      effect: read
      questions:
      - What is a guest's points balance and membership level?
      - Can I see pending points and total credits for a signed-in guest?
      instructions:
      - text: Show the account balance for token {auth_token}.
        slots:
          auth_token: requestBody.authentication_token
      - text: Get my points balance, pending points and membership level.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/rewards'].get
  update:
    x-apievangelist-phrasing:
      intent: List rewards available to a guest
      effect: read
      questions:
      - Which rewards or offers can a guest use right now?
      - How many rewards does a signed-in guest have available?
      instructions:
      - text: List available rewards for token {auth_token}.
        slots:
          auth_token: requestBody.authentication_token
      - text: Show the rewards I can redeem.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/users/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get balance with redemptions, badges and notices
      effect: read
      questions:
      - Can I get a guest's active redemptions and badges with their balance?
      - Which call returns notifications and badges alongside the guest balance?
      instructions:
      - text: Fetch the user balance summary for token {auth_token}.
        slots:
          auth_token: requestBody.authentication_token
      - text: Show my active redemptions, badges and notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/balance_timelines'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a guest's balance over time
      effect: read
      questions:
      - How has a signed-in guest's balance changed over time?
      - Is there a timeline view of a guest's loyalty balance?
      instructions:
      - text: Get the balance timeline for token {auth_token}.
        slots:
          auth_token: requestBody.authentication_token
      - text: Show how my balance has moved over time.
      method: generated
      generated: '2026-10-01'