# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Khoros Ai Customer API
  version: 1.0.0
extends: openapi/khoros-ai-customer-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['/customer/bestmatch'].post
  update:
    x-apievangelist-phrasing:
      intent: Find the best-matching customer from social info
      effect: read
      questions:
      - How do I match a social profile to an existing customer record?
      - Can I find a customer using their email, phone or order number?
      instructions:
      - text: Find the best customer match for screen name {screenName}.
        slots:
          screenName: requestBody.screenName
      - text: Match a customer using email {email} and order numbers {orderNumbers}.
        slots:
          email: requestBody.email
          orderNumbers: requestBody.orderNumbers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer record
      effect: write
      questions:
      - How do I add a new customer record in Khoros?
      - Can I set custom searchable fields when creating a customer?
      instructions:
      - text: Create a customer with searchable field one set to {customSearchableCustomerFieldOne}.
        slots:
          customSearchableCustomerFieldOne: requestBody.customSearchableCustomerFieldOne
      - text: Add a new customer with non-searchable field one {customNonSearchableCustomerFieldOne}.
        slots:
          customNonSearchableCustomerFieldOne: requestBody.customNonSearchableCustomerFieldOne
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer by ID
      effect: read
      questions:
      - How do I pull up a specific customer's details?
      - What info is stored on a customer record?
      instructions:
      - text: Get customer {id}.
        slots:
          id: path.id
      - text: Show the profile details for customer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's details
      effect: write
      questions:
      - Can I change the custom fields on an existing customer?
      - How do I update a customer record I already created?
      instructions:
      - text: Update customer {id} searchable field two to {customSearchableCustomerFieldTwo}.
        slots:
          id: path.id
          customSearchableCustomerFieldTwo: requestBody.customSearchableCustomerFieldTwo
      - text: Patch customer {id} with non-searchable field two {customNonSearchableCustomerFieldTwo}.
        slots:
          id: path.id
          customNonSearchableCustomerFieldTwo: requestBody.customNonSearchableCustomerFieldTwo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/{id}/cases'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's cases
      effect: read
      questions:
      - Which support cases are linked to a customer?
      - How do I see the full case history for one customer?
      instructions:
      - text: List all cases for customer {id}.
        slots:
          id: path.id
      - text: Show the support cases opened by customer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'