# 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 Customers API
  version: 1.0.0
extends: openapi/lightspeed-customers-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: 5
- target: $.paths['/customers'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers
      effect: read
      questions:
      - How do I list all the customers in my store?
      - Can I include deleted customers when listing them?
      instructions:
      - text: List my customers, {page_size} per page.
        slots:
          page_size: query.page_size
      - text: 'List customers including deleted ones: {deleted}.'
        slots:
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new customer
      effect: write
      questions:
      - How do I add a new customer record with their email and phone?
      - Can I enroll a new customer in loyalty when I create them?
      instructions:
      - text: Create a customer named {first_name} {last_name} with email {email}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
      - text: Add new customer {first_name} {last_name} to group {customer_group_id} with loyalty enabled {enable_loyalty}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          customer_group_id: requestBody.customer_group_id
          enable_loyalty: requestBody.enable_loyalty
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{customer_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single customer
      effect: read
      questions:
      - How do I look up a customer's full record by ID?
      - What contact details do we have for a specific customer?
      instructions:
      - text: Get customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show the contact details for customer {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{customer_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's details
      effect: write
      questions:
      - How do I change an existing customer's email or phone number?
      - Can I opt an existing customer out of marketing emails?
      instructions:
      - text: Update existing customer {customer_id} named {first_name} {last_name} with mobile {mobile}.
        slots:
          customer_id: path.customer_id
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          mobile: requestBody.mobile
      - text: Set do-not-email to {do_not_email} on customer {customer_id}.
        slots:
          do_not_email: requestBody.do_not_email
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{customer_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer
      effect: destructive
      questions:
      - How do I delete a customer record?
      - Can I remove a duplicate customer from the store?
      instructions:
      - text: Delete customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Remove the duplicate customer record {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-26'