# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Vendasta Marketplace API V1 Endpoints Customer API
  version: 1.0.0
extends: openapi/vendasta-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: 6
- target: $.paths['/customer'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer for a business
      effect: write
      questions:
      - How do I add a new customer contact to a business account?
      - What phone format does a new customer record require?
      instructions:
      - text: Create a customer {first_name} {last_name} with email {email} on account {account_id}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
          account_id: requestBody.account_id
      - text: Add customer with phone {phone} to business {account_id}.
        slots:
          phone: requestBody.phone
          account_id: requestBody.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/list-customers'].post
  update:
    x-apievangelist-phrasing:
      intent: List or search a business's customers
      effect: read
      questions:
      - Can I search a business's customers by name, email or phone?
      - Which sort options are there when listing customers on an account?
      instructions:
      - text: List customers of account {account_id}.
        slots:
          account_id: requestBody.account_id
      - text: Search customers on {account_id} for {search_term}.
        slots:
          account_id: requestBody.account_id
          search_term: requestBody.search_term
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/get-customer'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a customer by vendor customer ID
      effect: read
      questions:
      - Can I fetch one customer using the ID my app assigned to them?
      - What happens if more than one customer shares the same vendor customer ID?
      instructions:
      - text: Get customer {customer_id} on account {account_id}.
        slots:
          customer_id: requestBody.customer_id
          account_id: requestBody.account_id
      - text: Look up the customer my app knows as {customer_id} in business {account_id}.
        slots:
          customer_id: requestBody.customer_id
          account_id: requestBody.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/associate-id'].post
  update:
    x-apievangelist-phrasing:
      intent: Map my app's ID onto an existing customer
      effect: write
      questions:
      - How do I attach my own system's ID to a customer created elsewhere?
      - Can I add a vendor customer ID after the customer already exists?
      instructions:
      - text: Associate vendor customer ID {vendor_customer_id} with customer {customer_id}.
        slots:
          vendor_customer_id: requestBody.vendor_customer_id
          customer_id: requestBody.customer_id
      - text: Map customer {customer_id} on account {account_id} to my ID {vendor_customer_id}.
        slots:
          customer_id: requestBody.customer_id
          account_id: requestBody.account_id
          vendor_customer_id: requestBody.vendor_customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/update-customer'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing customer's details
      effect: write
      questions:
      - Can I change the email or phone on a customer I already created?
      - Is it possible to update whether I have permission to contact a customer?
      instructions:
      - text: Update customer {id} on account {account_id} to email {email}.
        slots:
          id: requestBody.id
          account_id: requestBody.account_id
          email: requestBody.email
      - text: Change the phone of existing customer {id} in {account_id} to {phone}.
        slots:
          id: requestBody.id
          account_id: requestBody.account_id
          phone: requestBody.phone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/delete-customer'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer
      effect: destructive
      questions:
      - How do I remove a customer from a business account?
      - Can I delete a customer by the ID my app gave them?
      instructions:
      - text: Delete customer {customer_id} from account {account_id}.
        slots:
          customer_id: requestBody.customer_id
          account_id: requestBody.account_id
      - text: Remove the customer record {customer_id} on business {account_id}.
        slots:
          customer_id: requestBody.customer_id
          account_id: requestBody.account_id
      method: generated
      generated: '2026-10-01'