# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Customer Voice REST Templates API
  version: 1.0.0
extends: openapi/vendasta-templates-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: 7
- target: $.paths['/reviewRequestTemplates'].get
  update:
    x-apievangelist-phrasing:
      intent: List review request templates for a location
      effect: read
      questions:
      - Which review request templates does a business location have?
      - Can I page through a location's Customer Voice templates?
      instructions:
      - text: List review request templates for business location {location}.
        slots:
          location: query.filter[businessLocation.id]
      - text: Show the first {limit} templates for location {location}.
        slots:
          limit: query.page[limit]
          location: query.filter[businessLocation.id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reviewRequestTemplates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a review request template
      effect: write
      questions:
      - How do I create a new email template for asking customers for reviews?
      - Which substitution variables, like customer name or button URL, can a template use?
      instructions:
      - text: Create a review request template {data}.
        slots:
          data: requestBody.data
      - text: Add a Customer Voice template {data} that greets the customer by first name.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reviewRequestTemplates'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on the templates collection
      effect: read
      questions:
      - Which HTTP verbs does the reviewRequestTemplates collection allow?
      - What does a CORS preflight to the templates list return?
      instructions:
      - text: Send an OPTIONS preflight to the reviewRequestTemplates collection.
      - text: List permitted verbs on the review request templates list endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reviewRequestTemplates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a review request template
      effect: read
      questions:
      - What does a specific review request template currently say?
      - Can I fetch one template's current values by ID?
      instructions:
      - text: Get review request template {id}.
        slots:
          id: path.id
      - text: Show the current content of template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reviewRequestTemplates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a review request template
      effect: destructive
      questions:
      - Can I remove a review request template I no longer use?
      - Is deleting a Customer Voice template permanent?
      instructions:
      - text: Delete review request template {id}.
        slots:
          id: path.id
      - text: Remove template {id} from Customer Voice.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reviewRequestTemplates/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a review request template
      effect: write
      questions:
      - Can I edit the wording of an existing review request template?
      - Do fields I leave out keep their values when updating a template?
      instructions:
      - text: Update review request template {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Change the subject or body of template {id} to {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reviewRequestTemplates/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on one template
      effect: read
      questions:
      - Which verbs can a browser use on a single review request template?
      - Does one template's URL allow DELETE and PATCH cross-origin?
      instructions:
      - text: Run a CORS preflight on template {id}.
        slots:
          id: path.id
      - text: Show allowed HTTP methods for the review request template {id} resource.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'