Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Trusthub Compliance Inquiries API

4 actions 4 updates phrasing extends openapi/twilio-complianceinquiries-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/ComplianceInquiries/Customers/Initialize'].post
$.paths['/v1/ComplianceInquiries/Customers/{CustomerId}/Initialize'].post
$.paths['/v1/ComplianceInquiries/Tollfree/Initialize'].post

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 - Trusthub Compliance Inquiries API
  version: 1.0.0
extends: openapi/twilio-complianceinquiries-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/ComplianceInquiries/Customers/Initialize'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an embedded compliance onboarding session
      effect: write
      questions:
      - How do I launch the embedded compliance form for a new customer profile?
      - What do I need before starting a compliance inquiry session for my account?
      instructions:
      - text: Start a new compliance inquiry for primary profile {profile}.
        slots:
          profile: requestBody.PrimaryProfileSid
      - text: Initialize an embedded compliance session using profile {profile}.
        slots:
          profile: requestBody.PrimaryProfileSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ComplianceInquiries/Customers/{CustomerId}/Initialize'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume or reopen a compliance inquiry
      effect: write
      questions:
      - My compliance inquiry session expired, can I pick it up again?
      - Can a rejected compliance inquiry be reopened for edits?
      instructions:
      - text: Resume the expired compliance inquiry for customer {customer} with profile {profile}.
        slots:
          customer: path.CustomerId
          profile: requestBody.PrimaryProfileSid
      - text: Reopen rejected inquiry {customer} for editing under profile {profile}.
        slots:
          customer: path.CustomerId
          profile: requestBody.PrimaryProfileSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ComplianceInquiries/Tollfree/Initialize'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a toll-free verification inquiry
      effect: write
      questions:
      - How do I get a toll-free number verified for texting through the embedded form?
      - Can I prefill business name, use case and message volume in a toll-free verification?
      - Which email gets notified about a toll-free verification's progress?
      instructions:
      - text: Start toll-free verification for {number} and notify {email}.
        slots:
          number: requestBody.TollfreePhoneNumber
          email: requestBody.NotificationEmail
      - text: Start toll-free verification for {number}, notify {email}, prefilled for business {business} at {website}.
        slots:
          number: requestBody.TollfreePhoneNumber
          email: requestBody.NotificationEmail
          business: requestBody.BusinessName
          website: requestBody.BusinessWebsite
      method: generated
      generated: '2026-09-26'