API Evangelist conversational phrasing for Twilio - Numbers Hosted Number 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 - Numbers Hosted Number API
  version: 1.0.0
extends: openapi/twilio-hostednumber-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: 10
- target: $.paths['/v2/HostedNumber/AuthorizationDocuments/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a letter of authorization for hosting
      effect: read
      questions:
      - Has the letter of authorization for my hosted numbers been signed yet?
      - Can I look up one authorization document by its SID?
      instructions:
      - text: Fetch authorization document {document_sid}.
        slots:
          document_sid: path.Sid
      - text: Show the signing status of LOA {document_sid}.
        slots:
          document_sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/HostedNumber/AuthorizationDocuments/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an authorization document request
      effect: destructive
      questions:
      - Can I withdraw a letter of authorization I sent out for signing?
      - What cancels a pending authorization document?
      instructions:
      - text: Cancel authorization document {document_sid}.
        slots:
          document_sid: path.Sid
      - text: Withdraw the LOA signing request {document_sid}.
        slots:
          document_sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/HostedNumber/AuthorizationDocuments'].get
  update:
    x-apievangelist-phrasing:
      intent: List authorization documents
      effect: read
      questions:
      - Which letters of authorization are still waiting to be signed?
      - Can I find the authorization documents sent to a particular email?
      instructions:
      - text: List authorization documents with status {status}.
        slots:
          status: query.Status
      - text: List the authorization documents sent to {email}.
        slots:
          email: query.Email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/HostedNumber/AuthorizationDocuments'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a letter of authorization for signing
      effect: write
      questions:
      - How do I get the number owner to sign a letter of authorization for hosting?
      - Can one authorization document cover several hosted number orders?
      instructions:
      - text: Send an LOA to {email} covering orders {order_sids}, for address {address_sid} and contact number {contact_phone}.
        slots:
          email: requestBody.Email
          order_sids: requestBody.HostedNumberOrderSids
          address_sid: requestBody.AddressSid
          contact_phone: requestBody.ContactPhoneNumber
      - text: Create an authorization document for orders {order_sids} signed by {email}, address {address_sid}, phone {contact_phone}, cc {cc_emails}.
        slots:
          order_sids: requestBody.HostedNumberOrderSids
          email: requestBody.Email
          address_sid: requestBody.AddressSid
          contact_phone: requestBody.ContactPhoneNumber
          cc_emails: requestBody.CcEmails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/HostedNumber/Orders/Bulk/{BulkHostingSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk number hosting order
      effect: read
      questions:
      - How far along is my bulk request to host many numbers?
      - Can I see only the failed numbers within a bulk hosting order?
      instructions:
      - text: Fetch bulk hosting order {bulk_sid}.
        slots:
          bulk_sid: path.BulkHostingSid
      - text: Show numbers in bulk hosting order {bulk_sid} with order status {order_status}.
        slots:
          bulk_sid: path.BulkHostingSid
          order_status: query.OrderStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders covered by an authorization document
      effect: read
      questions:
      - Which hosted number orders depend on a given letter of authorization?
      - Can I filter the orders tied to one LOA by phone number or status?
      instructions:
      - text: List the hosted number orders covered by authorization document {document_sid}.
        slots:
          document_sid: path.SigningDocumentSid
      - text: Find the order for {phone_number} under LOA {document_sid}.
        slots:
          phone_number: query.PhoneNumber
          document_sid: path.SigningDocumentSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/HostedNumber/Orders/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a hosted number order
      effect: read
      questions:
      - Where is my request to host a phone number in the verification process?
      - Can I look up a single hosted number order by SID?
      instructions:
      - text: Fetch hosted number order {order_sid}.
        slots:
          order_sid: path.Sid
      - text: Show the current status of hosting order {order_sid}.
        slots:
          order_sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/HostedNumber/Orders/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a hosted number order
      effect: destructive
      questions:
      - Can I cancel a number hosting request after submitting it?
      - At what status is it still possible to cancel a hosted number order?
      instructions:
      - text: Cancel hosted number order {order_sid}.
        slots:
          order_sid: path.Sid
      - text: Withdraw the request to host a number under order {order_sid}.
        slots:
          order_sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/HostedNumber/Orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List hosted number orders
      effect: read
      questions:
      - Which of my number hosting orders are still pending verification?
      - Can I find the hosting order for a specific phone number?
      instructions:
      - text: List my hosted number orders with status {status}.
        slots:
          status: query.Status
      - text: Find the hosting order for phone number {phone_number}.
        slots:
          phone_number: query.PhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/HostedNumber/Orders'].post
  update:
    x-apievangelist-phrasing:
      intent: Host an existing phone number's SMS
      effect: write
      questions:
      - How do I bring SMS for a number I already own onto the platform without porting it?
      - Can I set the SMS webhook URL when I request hosting for a number?
      instructions:
      - text: Host SMS for {phone_number}, owner {email}, contact {contact_phone}, address {address_sid}.
        slots:
          phone_number: requestBody.PhoneNumber
          email: requestBody.Email
          contact_phone: requestBody.ContactPhoneNumber
          address_sid: requestBody.AddressSid
      - text: Request hosting of {phone_number} for owner {email} at address {address_sid}, contact {contact_phone}, sending inbound SMS to {sms_url}.
        slots:
          phone_number: requestBody.PhoneNumber
          email: requestBody.Email
          address_sid: requestBody.AddressSid
          contact_phone: requestBody.ContactPhoneNumber
          sms_url: requestBody.SmsUrl
      method: generated
      generated: '2026-09-26'