# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Close Phone Numbers API
  version: 1.0.0
extends: openapi/close-phone-numbers-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: 5
- target: $.paths['/phone_number/'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search phone numbers
      effect: read
      questions:
      - Which phone numbers does my team have?
      - Can I find the phone numbers assigned to a specific user?
      - Which of our numbers are group numbers?
      instructions:
      - text: List all phone numbers.
      - text: Find phone numbers belonging to user {user_id}.
        slots:
          user_id: query.user_id
      - text: Search for phone number {number}.
        slots:
          number: query.number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/phone_number/request/internal/'].post
  update:
    x-apievangelist-phrasing:
      intent: Rent a new phone number
      effect: write
      questions:
      - How do I get a new phone number in a given country?
      - Can I rent a number with SMS and MMS support and a specific prefix?
      instructions:
      - text: Rent a new phone number in {country}.
        slots:
          country: requestBody.country
      - text: Request a {country} number with prefix {prefix} that supports SMS.
        slots:
          country: requestBody.country
          prefix: requestBody.prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/phone_number/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a phone number
      effect: read
      questions:
      - What are the forwarding and voicemail settings on a specific number?
      - Can I retrieve one phone number by id?
      instructions:
      - text: Fetch phone number {id}.
        slots:
          id: path.id
      - text: Show the settings of phone number {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/phone_number/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a phone number's settings
      effect: write
      questions:
      - Can I set up call forwarding on my number?
      - Is it possible to change the label or voicemail greeting on a phone number?
      instructions:
      - text: Forward calls on number {id} to {forward_to}.
        slots:
          id: path.id
          forward_to: requestBody.forward_to
      - text: Rename phone number {id} to {label}.
        slots:
          id: path.id
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/phone_number/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Release a phone number
      effect: destructive
      questions:
      - Can I get rid of a phone number we no longer need?
      - Who is allowed to delete a group phone number?
      instructions:
      - text: Delete phone number {id}.
        slots:
          id: path.id
      - text: Release number {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'