# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Punchh Swag API
  version: 1.0.0
extends: openapi/punchh-swag-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: 5
- target: $.paths['/api2/mobile/user_banking_preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a guest's Save Points for Swag settings
      effect: read
      questions:
      - Has a guest opted in to saving points for swag?
      - How many points has a guest saved toward swag so far?
      instructions:
      - text: Show my Save Points for Swag settings.
      - text: Get the swag points threshold and saved total for device {device}.
        slots:
          device: header.punchh-app-device-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/user_banking_preferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Opt a guest in or out of saving points for swag
      effect: write
      questions:
      - Can a guest stop points from auto-converting so they can save for merch?
      - What threshold can a guest set for saving swag points?
      instructions:
      - text: Turn save points for swag to {enabled}.
        slots:
          enabled: requestBody.save_points_for_swag_enabled
      - text: Save my points for swag until I reach {threshold}.
        slots:
          threshold: requestBody.saved_swag_points_threshold
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/swag_redemptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeem saved points for a swag item
      effect: write
      questions:
      - How does a guest trade saved points for branded merchandise?
      - Can swag be shipped home or picked up in store?
      instructions:
      - text: Redeem swag item {swag_id} for {fulfillment_method}.
        slots:
          swag_id: requestBody.swag_id
          fulfillment_method: requestBody.fulfillment_method
      - text: Order swag {swag_id} shipped to {shipping_info}.
        slots:
          swag_id: requestBody.swag_id
          shipping_info: requestBody.shipping_info
      - text: Pick up swag {swag_id} at location {location_id}.
        slots:
          swag_id: requestBody.swag_id
          location_id: requestBody.location_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/user_merch'].get
  update:
    x-apievangelist-phrasing:
      intent: List swag items a guest can redeem
      effect: read
      questions:
      - What branded merch can a guest get with their points?
      - Are out-of-stock swag items shown to guests?
      instructions:
      - text: List the swag I can redeem with my points.
      - text: Show available merch for the guest on device {device}.
        slots:
          device: header.punchh-app-device-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/swag_shipping_details'].get
  update:
    x-apievangelist-phrasing:
      intent: Export shipping details for swag deliveries
      effect: read
      questions:
      - Which swag redemptions need to be shipped this week?
      - Are store pick-up swag orders included in the shipping report?
      instructions:
      - text: Get swag shipping details from {from_date} to {to_date} as {format}.
        slots:
          from_date: requestBody.from_date
          to_date: requestBody.to_date
          format: requestBody.response_format
      - text: Show page {page} of home-delivery swag orders between {from_date} and {to_date} in {format}.
        slots:
          page: requestBody.page
          from_date: requestBody.from_date
          to_date: requestBody.to_date
          format: requestBody.response_format
      method: generated
      generated: '2026-10-01'