# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reputation Net Promoter Score Service API
  version: 1.0.0
extends: openapi/vendasta-netpromoterscoreservice-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: 4
- target: $.paths['/v1/reputation/nps/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a customer's NPS score
      effect: write
      questions:
      - Can I record the 1 to 10 score a customer picked on an NPS request?
      - Is it possible to attach a comment when leaving a Net Promoter Score?
      instructions:
      - text: Leave a score of {score} on NPS request {netPromoterScoreId}.
        slots:
          score: requestBody.score
          netPromoterScoreId: requestBody.netPromoterScoreId
      - text: Submit score {score} with comment {comment} for NPS {netPromoterScoreId}.
        slots:
          score: requestBody.score
          comment: requestBody.comment
          netPromoterScoreId: requestBody.netPromoterScoreId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reputation/nps/get-details'].post
  update:
    x-apievangelist-phrasing:
      intent: Get redirect details for an NPS record
      effect: read
      questions:
      - Where should a customer be redirected after answering an NPS survey?
      - What details are stored for a single NPS record ID?
      instructions:
      - text: Get the redirect details for NPS record {netPromoterScoreId}.
        slots:
          netPromoterScoreId: requestBody.netPromoterScoreId
      - text: Look up NPS {netPromoterScoreId} and show where it redirects.
        slots:
          netPromoterScoreId: requestBody.netPromoterScoreId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reputation/nps/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an NPS result from an outside system
      effect: write
      questions:
      - Can I bring in NPS survey results collected by another tool?
      - How are duplicate NPS imports prevented for the same review request?
      instructions:
      - text: Import an NPS request for business {accountGroupId}, contact {crmContactId}, external request {externalReviewRequestId}, sent at {requestSentTime}.
        slots:
          accountGroupId: requestBody.accountGroupId
          crmContactId: requestBody.crmContactId
          externalReviewRequestId: requestBody.externalReviewRequestId
          requestSentTime: requestBody.requestSentTime
      - text: Import score {score} from contact {crmContactId} for business {accountGroupId}.
        slots:
          score: requestBody.score
          crmContactId: requestBody.crmContactId
          accountGroupId: requestBody.accountGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reputation/nps/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List NPS feedback for a business
      effect: read
      questions:
      - What NPS feedback has a business received from its customers?
      - Can I hide parent NPS records when listing a location's scores?
      instructions:
      - text: List NPS scores for business {accountGroupId}.
        slots:
          accountGroupId: requestBody.accountGroupId
      - text: Show {pageSize} NPS responses for {accountGroupId} with triggering activity details.
        slots:
          pageSize: requestBody.pageSize
          accountGroupId: requestBody.accountGroupId
      method: generated
      generated: '2026-10-01'