Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Legal Entity Management Business Lines API

5 actions 5 updates phrasing extends openapi/adyen-businesslines-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 5

$.info

$.paths['/businessLines'].post

$.paths['/businessLines/{id}'].get

$.paths['/businessLines/{id}'].delete

$.paths['/businessLines/{id}'].patch

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 Adyen Legal Entity Management Business Lines API
  version: 1.0.0
extends: openapi/adyen-businesslines-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: 4
- target: $.paths['/businessLines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a business line
      effect: write
      questions:
      - How do I register my user's industry and source of funds?
      - Which sales channels can I record on a business line?
      instructions:
      - text: Create a {service} business line for legal entity {le} in industry {industry}.
        slots:
          service: requestBody.service
          le: requestBody.legalEntityId
          industry: requestBody.industryCode
      - text: 'Add a business line for {le}: service {service}, industry {industry}, website {web}.'
        slots:
          service: requestBody.service
          le: requestBody.legalEntityId
          industry: requestBody.industryCode
          web: requestBody.webData
      method: generated
      generated: '2026-09-26'
- target: $.paths['/businessLines/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business line
      effect: read
      questions:
      - What industry and sales channels are on a business line?
      - Can I fetch one business line by its ID?
      instructions:
      - text: Get business line {id}.
        slots:
          id: path.id
      - text: Show the industry and source of funds for business line {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/businessLines/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a business line
      effect: destructive
      questions:
      - What happens to payment methods linked to a business line I delete?
      - Is a deleted business line removed from all merchant accounts?
      instructions:
      - text: Delete business line {id}.
        slots:
          id: path.id
      - text: Remove business line {id} from all linked merchant accounts.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/businessLines/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a business line
      effect: write
      questions:
      - Can I change the industry code on an existing business line?
      - Can I add sales channels to a business line later?
      instructions:
      - text: Change the industry code of business line {id} to {industry}.
        slots:
          id: path.id
          industry: requestBody.industryCode
      - text: Update the sales channels on business line {id} to {channels}.
        slots:
          id: path.id
          channels: requestBody.salesChannels
      method: generated
      generated: '2026-09-26'