Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Management Terminals API

8 actions 8 updates phrasing extends openapi/adyen-terminals-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adyen's API. It is a proposal applied on top of the contract, not a document Adyen publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/terminals'].get
$.paths['/terminals/scheduleActions'].post
$.paths['/terminals/{terminalId}/reassign'].post
$.paths['/terminals/{terminalId}/terminalLogos'].get
$.paths['/terminals/{terminalId}/terminalLogos'].patch
$.paths['/terminals/{terminalId}/terminalSettings'].get
$.paths['/terminals/{terminalId}/terminalSettings'].patch

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 Adyen Management Terminals API
  version: 1.0.0
extends: openapi/adyen-terminals-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/terminals'].get
  update:
    x-apievangelist-phrasing:
      intent: Search my payment terminals
      effect: read
      questions:
      - Which payment terminals can my API credential see?
      - Can I filter terminals by store, merchant, country or model?
      instructions:
      - text: List all my payment terminals.
      - text: Find terminals matching {searchQuery}.
        slots:
          searchQuery: query.searchQuery
      - text: List terminals in store {storeIds} of model {brandModels}.
        slots:
          storeIds: query.storeIds
          brandModels: query.brandModels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/terminals/scheduleActions'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an action on terminals
      effect: write
      questions:
      - How do I push an app install or reboot to many terminals at a set time?
      - Can I schedule a terminal action for every terminal in a store?
      instructions:
      - text: Schedule action {actionDetails} on terminals {terminalIds} at {scheduledAt}.
        slots:
          actionDetails: requestBody.actionDetails
          terminalIds: requestBody.terminalIds
          scheduledAt: requestBody.scheduledAt
      - text: Schedule {actionDetails} for store {storeId}.
        slots:
          actionDetails: requestBody.actionDetails
          storeId: requestBody.storeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/terminals/{terminalId}/reassign'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a terminal to another account or store
      effect: write
      questions:
      - Can I move a payment terminal to a different store?
      - How do I send a terminal back to merchant inventory?
      instructions:
      - text: Reassign terminal {terminalId} to store {storeId}.
        slots:
          terminalId: path.terminalId
          storeId: requestBody.storeId
      - text: Move terminal {terminalId} to merchant {merchantId} inventory {inventory}.
        slots:
          terminalId: path.terminalId
          merchantId: requestBody.merchantId
          inventory: requestBody.inventory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/terminals/{terminalId}/terminalLogos'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the logo on one terminal
      effect: read
      questions:
      - What logo is showing on a single specific terminal?
      - Does the logo come back Base64-encoded for an individual terminal?
      instructions:
      - text: Get the logo configured on terminal {terminalId}.
        slots:
          terminalId: path.terminalId
      - text: Download the screen logo of device {terminalId}.
        slots:
          terminalId: path.terminalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/terminals/{terminalId}/terminalLogos'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change or reset one terminal's logo
      effect: write
      questions:
      - How do I change the logo on just one terminal?
      - Can I restore an individual terminal's logo to the inherited one?
      instructions:
      - text: Set the logo on terminal {terminalId} to {data}.
        slots:
          terminalId: path.terminalId
          data: requestBody.data
      - text: Reset device {terminalId} to its inherited logo.
        slots:
          terminalId: path.terminalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/terminals/{terminalId}/terminalSettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the settings of one terminal
      effect: read
      questions:
      - What settings is a particular terminal running with?
      - Can I check a single device's connectivity and timeout settings?
      instructions:
      - text: Get the settings of terminal {terminalId}.
        slots:
          terminalId: path.terminalId
      - text: Show device {terminalId} configuration.
        slots:
          terminalId: path.terminalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/terminals/{terminalId}/terminalSettings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update settings on one terminal
      effect: write
      questions:
      - How do I change the timeouts on one specific terminal?
      - Can I override tipping on a single terminal only?
      instructions:
      - text: Set timeouts on terminal {terminalId} to {timeouts}.
        slots:
          terminalId: path.terminalId
          timeouts: requestBody.timeouts
      - text: Update gratuities on device {terminalId} to {gratuities}.
        slots:
          terminalId: path.terminalId
          gratuities: requestBody.gratuities
      method: generated
      generated: '2026-09-26'