# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for stax-api Customer API
  version: 1.0.0
extends: openapi/stax-customer-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: 6
- target: $.paths['/customer'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter customers
      effect: read
      questions:
      - Can I look up customers on my merchant account by name, email or company?
      - Which of my customers live in a particular city or zip code?
      - Can I filter my customer list to those allowed to pay invoices by credit card?
      instructions:
      - text: List all customers on my merchant account.
      - text: Find customers with email {email}.
        slots:
          email: query.email
      - text: Find customers at company {company} in {address_city}.
        slots:
          company: query.company
          address_city: query.address_city
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer record
      effect: write
      questions:
      - How do I add a new customer to my Stax merchant account?
      - Can a new customer be set up with CC emails and SMS numbers for their receipts?
      instructions:
      - text: Create a customer named {firstname} {lastname} with email {email}.
        slots:
          firstname: requestBody.firstname
          lastname: requestBody.lastname
          email: requestBody.email
      - text: Add a new customer for company {company} with phone {phone} and reference {reference}.
        slots:
          company: requestBody.company
          phone: requestBody.phone
          reference: requestBody.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one customer's details
      effect: read
      questions:
      - What contact and address details do I have on file for a specific customer?
      - Can I pull up a single customer record by its ID?
      instructions:
      - text: Show me the details for customer {id}.
        slots:
          id: path.id
      - text: Get the address on file for customer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing customer
      effect: write
      questions:
      - Can I change the email or phone number on a customer I already created?
      - Is it possible to update a customer's billing address after they are set up?
      instructions:
      - text: Change the email on existing customer {id} to {email}.
        slots:
          id: path.id
          email: requestBody.email
      - text: Update customer {id}'s address to {address_1}, {address_city}, {address_state} {address_zip}.
        slots:
          id: path.id
          address_1: requestBody.address_1
          address_city: requestBody.address_city
          address_state: requestBody.address_state
          address_zip: requestBody.address_zip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer
      effect: destructive
      questions:
      - Can I remove a customer from my merchant account?
      - Is deleting a customer permanent, or is it a soft delete?
      instructions:
      - text: Delete customer {id}.
        slots:
          id: path.id
      - text: Soft delete the customer record {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer/{customerId}/payment-method'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's payment methods
      effect: read
      questions:
      - Which cards and bank accounts does a particular customer have saved?
      - Does a customer's list of saved payment methods include deleted ones?
      instructions:
      - text: List the saved payment methods for customer {customerId}.
        slots:
          customerId: path.customerId
      - text: Show every card and bank account on file for customer {customerId}.
        slots:
          customerId: path.customerId
      method: generated
      generated: '2026-09-26'