Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Wireless Rate Plans API

6 actions 6 updates phrasing extends openapi/twilio-rate-plans-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v1/RatePlans'].get
$.paths['/v1/RatePlans'].post
$.paths['/v1/RatePlans/{Sid}'].get
$.paths['/v1/RatePlans/{Sid}'].post
$.paths['/v1/RatePlans/{Sid}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio - Wireless Rate Plans API
  version: 1.0.0
extends: openapi/twilio-rate-plans-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['/v1/RatePlans'].get
  update:
    x-apievangelist-phrasing:
      intent: List wireless SIM rate plans
      effect: read
      questions:
      - Which rate plans are available to assign to my IoT SIMs?
      - Can I see all my wireless plans and their data limits?
      instructions:
      - text: List all my SIM rate plans.
      - text: Show every wireless plan with its data and roaming settings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/RatePlans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SIM rate plan
      effect: write
      questions:
      - How do I create a data plan that caps SIMs at a monthly megabyte limit?
      - Can a rate plan allow national roaming but block international data?
      - What metering models are available for a new rate plan?
      instructions:
      - text: Create rate plan {name} with a {limit} MB data limit.
        slots:
          name: requestBody.FriendlyName
          limit: requestBody.DataLimit
      - text: Create a plan {unique_name} with messaging enabled set to {messaging}.
        slots:
          unique_name: requestBody.UniqueName
          messaging: requestBody.MessagingEnabled
      - text: Set up plan {name} allowing international roaming for {services}.
        slots:
          name: requestBody.FriendlyName
          services: requestBody.InternationalRoaming
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/RatePlans/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one rate plan
      effect: read
      questions:
      - What data limit and roaming rules does a specific rate plan have?
      - Can I check whether one plan lets SIMs send SMS?
      instructions:
      - text: Show rate plan {plan}.
        slots:
          plan: path.Sid
      - text: Get the data and roaming limits of plan {plan}.
        slots:
          plan: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/RatePlans/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a rate plan
      effect: write
      questions:
      - Can I change a rate plan's name without touching its limits?
      - Is it possible to give an existing plan a new unique name?
      instructions:
      - text: Rename rate plan {plan} to {name}.
        slots:
          plan: path.Sid
          name: requestBody.FriendlyName
      - text: Change the unique name of existing plan {plan} to {unique_name}.
        slots:
          plan: path.Sid
          unique_name: requestBody.UniqueName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/RatePlans/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rate plan
      effect: destructive
      questions:
      - How do I retire a rate plan no SIMs use anymore?
      - What is required to delete a wireless rate plan?
      instructions:
      - text: Delete rate plan {plan}.
        slots:
          plan: path.Sid
      - text: Remove the unused wireless plan {plan}.
        slots:
          plan: path.Sid
      method: generated
      generated: '2026-09-26'