Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Configuration Alternate Payment Types API

3 actions 3 updates phrasing extends openapi/toast-alternate-payment-types-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Toast's API. It is a proposal applied on top of the contract, not a document Toast publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/alternatePaymentTypes/{guid}'].get

$.paths['/alternatePaymentTypes'].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 Configuration Alternate Payment Types API
  version: 1.0.0
extends: openapi/toast-alternate-payment-types-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: 2
- target: $.paths['/alternatePaymentTypes/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one alternate payment type
      effect: read
      questions:
      - How do I see the details of a single non-standard tender, like a house account, configured at a restaurant?
      - What information is stored for one alternate form of payment in Toast?
      instructions:
      - text: Get alternate payment type {guid} for restaurant {restaurant}.
        slots:
          guid: path.guid
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show me the alternate tender {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alternatePaymentTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a restaurant's alternate payment types
      effect: read
      questions:
      - Which alternate forms of payment has a restaurant set up?
      - Can I list only the alternate payment types changed since a certain date?
      instructions:
      - text: List all alternate payment types for restaurant {restaurant}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
      - text: List alternate payment types for {restaurant} modified since {since}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          since: query.lastModified
      method: generated
      generated: '2026-10-01'