API Evangelist conversational phrasing for Twilio Safe List API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio Safe List API
  version: 1.0.0
extends: openapi/twilio-safelist-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: 9
- target: $.paths['/v1/SafeList/Numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a number on SafeList (v1 endpoint)
      effect: read
      questions:
      - On the v1 SafeList endpoint, where the number goes in the query string, is a phone number safelisted?
      - Can the older v1 SafeList API tell me whether a number is protected from fraud blocking?
      instructions:
      - text: Using the v1 endpoint, check whether {phone_number} is on SafeList by passing it as a query parameter.
        slots:
          phone_number: query.PhoneNumber
      - text: Query v1 SafeList for number {phone_number}.
        slots:
          phone_number: query.PhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SafeList/Numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a phone number to SafeList (v1 endpoint)
      effect: write
      questions:
      - Is the v1 SafeList endpoint still usable for adding a number?
      - With the v1 API, what do I send to safelist one of my phone numbers?
      instructions:
      - text: Using the v1 endpoint, add {phone_number} to SafeList.
        slots:
          phone_number: requestBody.PhoneNumber
      - text: Safelist number {phone_number} through the v1 SafeList API.
        slots:
          phone_number: requestBody.PhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SafeList/Numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a phone number from SafeList (v1 endpoint)
      effect: destructive
      questions:
      - On the v1 SafeList endpoint, how do I remove a number passed as a query parameter?
      - Can the older v1 SafeList API take a number back off the list?
      instructions:
      - text: Using the v1 endpoint, remove {phone_number} from SafeList by passing it as a query parameter.
        slots:
          phone_number: query.PhoneNumber
      - text: Delete number {phone_number} from the v1 SafeList.
        slots:
          phone_number: query.PhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/SafeList/Numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Safelist a number (legacy unversioned endpoint)
      effect: write
      questions:
      - On the older unversioned path, how do I add a verified caller ID to the account safelist?
      - Can the legacy safelist endpoint still accept new numbers?
      instructions:
      - text: Via the legacy unversioned endpoint, add {phone_number} to the account safelist.
        slots:
          phone_number: requestBody.PhoneNumber
      - text: Using the older safelist path, safelist verified caller ID {phone_number}.
        slots:
          phone_number: requestBody.PhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/SafeList/Numbers/{PhoneNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a safelisted number (legacy endpoint)
      effect: read
      questions:
      - Through the older unversioned path, is a number on the safelist?
      - Can the legacy endpoint tell me whether a caller ID is safelisted?
      instructions:
      - text: Via the legacy unversioned endpoint, check whether {phone_number} is safelisted.
        slots:
          phone_number: path.PhoneNumber
      - text: Using the older safelist path, look up {phone_number}.
        slots:
          phone_number: path.PhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/SafeList/Numbers/{PhoneNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsafelist a number (legacy unversioned endpoint)
      effect: destructive
      questions:
      - Through the older unversioned path, how do I remove a number from the safelist?
      - Can the legacy safelist endpoint delete an entry?
      instructions:
      - text: Via the legacy unversioned endpoint, remove {phone_number} from the safelist.
        slots:
          phone_number: path.PhoneNumber
      - text: Using the older safelist path, delete safelisted number {phone_number}.
        slots:
          phone_number: path.PhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/SafeList/Numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a phone number to SafeList
      effect: write
      questions:
      - How do I protect one of my own numbers from being blocked by fraud guard?
      - Can I add a phone number to SafeList through the v2 endpoint?
      instructions:
      - text: Add {phone_number} to SafeList using the v2 endpoint.
        slots:
          phone_number: requestBody.PhoneNumber
      - text: Put phone number {phone_number} on the v2 SafeList so it is never blocked.
        slots:
          phone_number: requestBody.PhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/SafeList/Numbers/{PhoneNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a number is on SafeList
      effect: read
      questions:
      - Is a given phone number already on my v2 SafeList?
      - Can I confirm a number was safelisted before sending verification to it?
      instructions:
      - text: Check whether {phone_number} is on the v2 SafeList.
        slots:
          phone_number: path.PhoneNumber
      - text: Look up {phone_number} in SafeList with the v2 endpoint.
        slots:
          phone_number: path.PhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/SafeList/Numbers/{PhoneNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a phone number from SafeList
      effect: destructive
      questions:
      - How do I take a number off SafeList with the v2 API?
      - What if a safelisted number should be subject to fraud checks again?
      instructions:
      - text: Remove {phone_number} from SafeList using the v2 endpoint.
        slots:
          phone_number: path.PhoneNumber
      - text: Take phone number {phone_number} off the v2 SafeList.
        slots:
          phone_number: path.PhoneNumber
      method: generated
      generated: '2026-09-26'