# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Square Customer Segments API
  version: 1.0.0
extends: openapi/square-customer-segments-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['/v2/customers/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer segments
      effect: read
      questions:
      - What customer segments does my business have?
      - Can I page through all my customer segments?
      instructions:
      - text: List my customer segments.
      - text: Show up to {limit} customer segments.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/customers/segments/{segment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer segment
      effect: read
      questions:
      - What are the details of one customer segment?
      - How do I look up a segment by its ID?
      instructions:
      - text: Get customer segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Show details of segment {segment_id}.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-10-01'