# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Toast Discounts API
  version: 1.0.0
extends: openapi/toast-discounts-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['/discounts/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one configured discount
      effect: read
      questions:
      - How do I view the setup of a single discount at a restaurant?
      - What details are stored for one price deduction configured in Toast?
      instructions:
      - text: Get discount {guid} configured at restaurant {restaurant}.
        slots:
          guid: path.guid
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show me how discount {guid} is set up.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/discounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a restaurant's configured discounts
      effect: read
      questions:
      - Which discounts has a restaurant configured?
      - Can I list only discounts created or changed since a date?
      instructions:
      - text: List all discounts configured for restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: List discounts at {restaurant} modified since {since}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          since: query.lastModified
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{orderGuid}/checks/{checkGuid}/appliedDiscounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a discount to a whole check
      effect: write
      questions:
      - How do I add a check-level discount to an existing order?
      - Can I apply more than one discount to an entire check at once?
      instructions:
      - text: Apply a check-level discount to check {check} on order {order}.
        slots:
          check: path.checkGuid
          order: path.orderGuid
      - text: Add a discount to the entire check {check} in order {order}.
        slots:
          check: path.checkGuid
          order: path.orderGuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{orderGuid}/checks/{checkGuid}/selections/{selectionGuid}/appliedDiscounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a discount to one item on a check
      effect: write
      questions:
      - Can I discount a single menu item on a check rather than the whole check?
      - What do I need to add an item-level discount to a selection in an existing order?
      instructions:
      - text: Discount item selection {selection} on check {check} of order {order}.
        slots:
          selection: path.selectionGuid
          check: path.checkGuid
          order: path.orderGuid
      - text: Take a discount off menu item selection {selection} in order {order}, check {check}.
        slots:
          selection: path.selectionGuid
          order: path.orderGuid
          check: path.checkGuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applicableDiscounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Find discounts that apply to an order
      effect: read
      questions:
      - Which discounts would apply to the checks and items in an order before I submit it?
      - Can I check whether a promo code applies to an order?
      instructions:
      - text: Find the discounts that apply to this order at restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: Check which discounts promo code {promo} unlocks for {order}.
        slots:
          promo: requestBody.promoCode
          order: requestBody.order
      method: generated
      generated: '2026-10-01'