Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Loyalty Transfers API

4 actions 4 updates phrasing extends openapi/punchh-loyalty-transfers-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 4

$.info
$.paths['/api2/mobile/loyalty_transfers/points'].post
$.paths['/api2/mobile/loyalty_transfers/currency'].post
$.paths['/api2/mobile/loyalty_transfers/reward'].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 Loyalty Transfers API
  version: 1.0.0
extends: openapi/punchh-loyalty-transfers-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: 3
- target: $.paths['/api2/mobile/loyalty_transfers/points'].post
  update:
    x-apievangelist-phrasing:
      intent: Send loyalty points to another member
      effect: write
      questions:
      - Can a guest give some of their loyalty points to a friend?
      - Does the person receiving transferred points need to be a member already?
      instructions:
      - text: Transfer {points} points to {recipient_email}.
        slots:
          points: requestBody.points_to_transfer
          recipient_email: requestBody.recipient_email
      - text: Send {points} of my points to member {recipient}.
        slots:
          points: requestBody.points_to_transfer
          recipient: requestBody.recipient_identifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/loyalty_transfers/currency'].post
  update:
    x-apievangelist-phrasing:
      intent: Send banked reward currency to another member
      effect: write
      questions:
      - Can a guest share their banked reward dollars with a family member?
      - What does a guest need to confirm before transferring loyalty currency?
      instructions:
      - text: Transfer {amount} of banked currency to {recipient_email}.
        slots:
          amount: requestBody.amount_to_transfer
          recipient_email: requestBody.recipient_email
      - text: Move {amount} reward balance to the member with phone {recipient}.
        slots:
          amount: requestBody.amount_to_transfer
          recipient: requestBody.recipient_identifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/loyalty_transfers/reward'].post
  update:
    x-apievangelist-phrasing:
      intent: Give a loyalty reward to another member
      effect: write
      questions:
      - Can a guest gift one of their earned rewards to someone else?
      - How does a guest pick which reward to transfer?
      instructions:
      - text: Give reward {reward} to {recipient_email}.
        slots:
          reward: requestBody.reward_to_transfer
          recipient_email: requestBody.recipient_email
      - text: Transfer my reward {reward} to member {recipient}.
        slots:
          reward: requestBody.reward_to_transfer
          recipient: requestBody.recipient_identifier
      method: generated
      generated: '2026-10-01'