# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Survey API
  version: 1.0.0
extends: openapi/birdeye-survey-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['/v1/survey/{survey_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a survey
      effect: read
      questions:
      - Can I fetch a survey's content in a particular language?
      - What does a specific survey contain?
      instructions:
      - text: Get survey {survey_id} for business {businessId}.
        slots:
          survey_id: path.survey_id
          businessId: query.businessId
      - text: Show survey {survey_id} in language {lang} for {businessId}.
        slots:
          survey_id: path.survey_id
          lang: query.lang
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/survey/{survey_id}/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a survey response
      effect: write
      questions:
      - Can I submit a survey response through the API?
      - Can responses collected elsewhere be posted into a Birdeye survey?
      instructions:
      - text: Submit a response to survey {survey_id} for business {businessId}.
        slots:
          survey_id: path.survey_id
          businessId: query.businessId
      - text: Post a completed answer set to survey {survey_id} on {businessId}.
        slots:
          survey_id: path.survey_id
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/survey/ext/list/responses/{survey_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: List responses to a survey
      effect: read
      questions:
      - Can I list all responses to a survey for a date range?
      - Can survey responses include linked ticket IDs?
      instructions:
      - text: List responses to survey {survey_id} for enterprise {businessNumber}.
        slots:
          survey_id: path.survey_id
          businessNumber: query.businessNumber
      - text: Get responses for survey {survey_id} under {businessNumber} from {startDate} to {endDate}.
        slots:
          survey_id: path.survey_id
          businessNumber: query.businessNumber
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/survey/business/{business_id}/all'].get
  update:
    x-apievangelist-phrasing:
      intent: List a business's surveys
      effect: read
      questions:
      - Which surveys does my business have?
      - Can I search my surveys by name and sort by response count?
      instructions:
      - text: List all surveys for business {business_id}.
        slots:
          business_id: path.business_id
      - text: Find surveys named {searchStr} for {business_id}.
        slots:
          searchStr: query.searchStr
          business_id: path.business_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/survey/external/create/{businessId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a survey
      effect: write
      questions:
      - Can I create a new survey for a business?
      - Is it possible to set up a survey through the API?
      instructions:
      - text: Create a survey for business {businessId}.
        slots:
          businessId: path.businessId
      - text: Set up a new survey on {businessId}.
        slots:
          businessId: path.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/survey/{surveyId}/settings/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a survey's settings
      effect: write
      questions:
      - Can I change a survey's settings or who can access it?
      - Is it possible to restrict access to an existing survey?
      instructions:
      - text: Update settings of survey {surveyId} for {businessId} to {surveySettings}.
        slots:
          surveyId: path.surveyId
          businessId: query.businessId
          surveySettings: requestBody.surveySettings
      - text: Change access control of survey {surveyId} on {businessId} to {accessControl}.
        slots:
          surveyId: path.surveyId
          businessId: query.businessId
          accessControl: requestBody.accessControl
      method: generated
      generated: '2026-09-26'