# 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 Groups API
  version: 1.0.0
extends: openapi/square-customer-groups-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: 5
- target: $.paths['/v2/customers/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer groups
      effect: read
      questions:
      - What customer groups exist in my business?
      - Can I page through customer groups a few at a time?
      instructions:
      - text: List all customer groups.
      - text: Show customer groups, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/customers/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer group
      effect: write
      questions:
      - How do I create a new group like Wholesale Buyers?
      - What is required to make a customer group?
      instructions:
      - text: Create customer group {group}.
        slots:
          group: requestBody.group
      - text: Make a new customer group named as in {group}.
        slots:
          group: requestBody.group
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/customers/groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer group
      effect: read
      questions:
      - What is the name of a specific customer group?
      - Can I look up one customer group by ID?
      instructions:
      - text: Get customer group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show details of customer group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/customers/groups/{group_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a customer group
      effect: write
      questions:
      - Can I rename an existing customer group?
      - How do I change a customer group's details?
      instructions:
      - text: Update customer group {group_id} with {group}.
        slots:
          group_id: path.group_id
          group: requestBody.group
      - text: Rename customer group {group_id} using {group}.
        slots:
          group_id: path.group_id
          group: requestBody.group
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/customers/groups/{group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer group
      effect: destructive
      questions:
      - How do I delete a customer group we no longer need?
      - Does deleting a customer group delete its customers?
      instructions:
      - text: Delete customer group {group_id}.
        slots:
          group_id: path.group_id
      - text: Remove the customer group {group_id} entirely.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'