# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform Functions Redemptions API
  version: 1.0.0
extends: openapi/punchh-redemptions-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/dashboard/redemptions'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a redemption code
      effect: read
      questions:
      - Is a guest's redemption code valid, and what does it unlock?
      - Can I search a redemption code at a particular location?
      instructions:
      - text: Search for redemption code {redemption_code}.
        slots:
          redemption_code: query.redemption_code
      - text: Check code {redemption_code} at location {location_id}.
        slots:
          redemption_code: query.redemption_code
          location_id: query.location_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/redemptions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark a redemption code as processed
      effect: write
      questions:
      - How do I mark a redemption as used once the guest has received the item?
      - Can a redemption be processed by store number?
      instructions:
      - text: Process redemption code {redemption_code} at location {location_id}.
        slots:
          redemption_code: requestBody.redemption_code
          location_id: requestBody.location_id
      - text: Mark code {redemption_code} as redeemed at store {store_number}.
        slots:
          redemption_code: requestBody.redemption_code
          store_number: requestBody.store_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/redemptions/force_redeem'].post
  update:
    x-apievangelist-phrasing:
      intent: Force-redeem an offer for a guest
      effect: write
      questions:
      - Can a manager override the normal flow and redeem an offer for a guest?
      - When would support staff force a redemption on someone's behalf?
      instructions:
      - text: Force redeem {redemption} for user {user_id}.
        slots:
          redemption: requestBody.redemption
          user_id: requestBody.user_id
      - text: Override and redeem the offer for guest {user_id}.
        slots:
          user_id: requestBody.user_id
      method: generated
      generated: '2026-10-01'