# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Business REST Customers API
  version: 1.0.0
extends: openapi/vendasta-customers-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: 7
- target: $.paths['/customers'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers of a business location
      effect: read
      questions:
      - Which customers are recorded for one of my business locations?
      - Can I sort the legacy customer list?
      instructions:
      - text: List customers for business location {location}.
        slots:
          location: query.filter[businessLocation.id]
      - text: List customers at {location} sorted by {sort}.
        slots:
          location: query.filter[businessLocation.id]
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer (legacy)
      effect: write
      questions:
      - Can I still create a customer record in Business App with the deprecated customers endpoint?
      - What is required to add a customer to a business location?
      instructions:
      - text: Create a customer record from {data} with the older customers endpoint.
        slots:
          data: requestBody.data
      - text: Add a new customer to a business location in Business App.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on the customers list
      effect: read
      questions:
      - Which HTTP verbs does the customers collection accept for CORS?
      - What does a preflight on the customer list endpoint return?
      instructions:
      - text: Send a CORS preflight to the customers list.
      - text: Show the allowed methods for the customer collection endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer
      effect: read
      questions:
      - How can I fetch the current values for one customer?
      - What does the legacy customers API return for a single customer?
      instructions:
      - text: Get customer {id}.
        slots:
          id: path.id
      - text: Show the stored details of customer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer
      effect: destructive
      questions:
      - Can I delete a customer record from a business location?
      - Is deleting a customer through the legacy API still supported?
      instructions:
      - text: Delete customer {id}.
        slots:
          id: path.id
      - text: Remove customer {id} from Business App.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a customer
      effect: write
      questions:
      - Can I update a few fields on a customer and keep the rest unchanged?
      - What happens to customer fields I omit from an update?
      instructions:
      - text: Update customer {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit customer {id}'s record.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on a single customer
      effect: read
      questions:
      - Which HTTP verbs are allowed on one customer resource?
      - What does a CORS preflight on a specific customer return?
      instructions:
      - text: Run a CORS preflight against customer {id}.
        slots:
          id: path.id
      - text: Show which methods the single-customer endpoint {id} allows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'