# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Customer Groups API
  version: 1.0.0
extends: openapi/lightspeed-customer-groups-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['/customer_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer groups
      effect: read
      questions:
      - What customer groups like VIP or wholesale do we have?
      - Can I include deleted customer groups in the list?
      instructions:
      - text: List all customer groups.
      - text: 'List customer groups including deleted ones: {deleted}.'
        slots:
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer_groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer group
      effect: write
      questions:
      - How do I create a new customer group for wholesale buyers?
      - What do I need to supply to set up a customer group?
      instructions:
      - text: Create a customer group named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new customer group called {name} with group code {group_id}.
        slots:
          name: requestBody.name
          group_id: requestBody.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer_groups/{customer_group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer group
      effect: read
      questions:
      - How do I look up one customer group by its ID?
      - What are the details of a particular customer group?
      instructions:
      - text: Get customer group {customer_group_id}.
        slots:
          customer_group_id: path.customer_group_id
      - text: Show the details for customer group {customer_group_id}.
        slots:
          customer_group_id: path.customer_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer_groups/{customer_group_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a customer group
      effect: write
      questions:
      - How do I rename an existing customer group?
      - Can I change the name of a customer group I already created?
      instructions:
      - text: Rename customer group {customer_group_id} to {name}.
        slots:
          customer_group_id: path.customer_group_id
          name: requestBody.name
      - text: Update existing customer group {customer_group_id} with the name {name}.
        slots:
          customer_group_id: path.customer_group_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer_groups/{customer_group_id}/customers'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers in a customer group
      effect: read
      questions:
      - Which customers belong to a particular customer group?
      - Can I page through the members of a customer group?
      instructions:
      - text: List the customers in customer group {customer_group_id}.
        slots:
          customer_group_id: path.customer_group_id
      - text: Show members of group {customer_group_id}, {page_size} per page.
        slots:
          customer_group_id: path.customer_group_id
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer_groups/{customer_group_id}/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add customers to a customer group
      effect: write
      questions:
      - How do I add several customers to a group at once?
      - Can I put existing customers into a VIP group?
      instructions:
      - text: Add customers {customer_ids} to customer group {customer_group_id}.
        slots:
          customer_ids: requestBody.customer_ids
          customer_group_id: path.customer_group_id
      - text: Put these customers {customer_ids} into group {customer_group_id}.
        slots:
          customer_ids: requestBody.customer_ids
          customer_group_id: path.customer_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer_groups/{customer_group_id}/customers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove customers from a customer group
      effect: destructive
      questions:
      - How do I take customers out of a group without deleting them?
      - Does removing someone from a customer group delete the customer record?
      instructions:
      - text: Remove customers {customer_ids} from customer group {customer_group_id}.
        slots:
          customer_ids: requestBody.customer_ids
          customer_group_id: path.customer_group_id
      - text: Unlink these customers from group {customer_group_id} but keep their records.
        slots:
          customer_group_id: path.customer_group_id
      method: generated
      generated: '2026-09-26'