Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Supersim E Sim Profiles API

4 actions 4 updates phrasing extends openapi/twilio-esimprofiles-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 4

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

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 - Supersim E Sim Profiles API
  version: 1.0.0
extends: openapi/twilio-esimprofiles-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: 3
- target: $.paths['/v1/ESimProfiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List eSIM profiles
      effect: read
      questions:
      - Which eSIM profiles have I ordered, and what state are they in?
      - Can I find the eSIM profile associated with a particular device EID?
      instructions:
      - text: List all my eSIM profiles.
      - text: Show eSIM profiles for device EID {eid}.
        slots:
          eid: query.Eid
      - text: List eSIM profiles with status {status}.
        slots:
          status: query.Status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ESimProfiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Order an eSIM profile
      effect: write
      questions:
      - How do I order an eSIM profile for an IoT device?
      - Can I order a profile without knowing the device's EID by using a matching ID?
      instructions:
      - text: Order an eSIM profile for device EID {eid}.
        slots:
          eid: requestBody.Eid
      - text: Order an eSIM profile with a matching ID and notify {callback} on status changes.
        slots:
          callback: requestBody.CallbackUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ESimProfiles/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one eSIM profile
      effect: read
      questions:
      - Has a specific eSIM profile finished downloading to its device?
      - What status is one eSIM profile in right now?
      instructions:
      - text: Show eSIM profile {profile}.
        slots:
          profile: path.Sid
      - text: Check the provisioning status of eSIM profile {profile}.
        slots:
          profile: path.Sid
      method: generated
      generated: '2026-09-26'