API Evangelist conversational phrasing for Twilio - Numbers Regulatory Compliance 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 Regulatory Compliance API
  version: 1.0.0
extends: openapi/twilio-regulatorycompliance-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: 31
- target: $.paths['/v2/RegulatoryCompliance/Bundles'].get
  update:
    x-apievangelist-phrasing:
      intent: List regulatory compliance bundles
      effect: read
      questions:
      - Which of my regulatory bundles are still waiting on review or were rejected?
      - Can I find the compliance bundles I filed for mobile numbers in a specific country?
      - What regulatory bundles expire soonest, sorted by their valid-until date?
      instructions:
      - text: List my regulatory bundles with status {status}.
        slots:
          status: query.Status
      - text: Show the compliance bundles for {iso_country} {number_type} phone numbers.
        slots:
          iso_country: query.IsoCountry
          number_type: query.NumberType
      - text: Find the regulatory bundle named {friendly_name}.
        slots:
          friendly_name: query.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a regulatory compliance bundle
      effect: write
      questions:
      - How do I start a regulatory bundle so I can buy phone numbers in a regulated country?
      - Can a new compliance bundle email me whenever its review status changes?
      instructions:
      - text: Create a regulatory bundle called {friendly_name} and send status updates to {email}.
        slots:
          friendly_name: requestBody.FriendlyName
          email: requestBody.Email
      - text: Open a new compliance bundle {friendly_name} for {iso_country} {number_type} numbers, notifying {email}.
        slots:
          friendly_name: requestBody.FriendlyName
          iso_country: requestBody.IsoCountry
          number_type: requestBody.NumberType
          email: requestBody.Email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one regulatory bundle
      effect: read
      questions:
      - What is the current review status of one particular regulatory bundle?
      - Where can I see the full details of a single compliance bundle by its SID?
      instructions:
      - text: Get regulatory bundle {sid}.
        slots:
          sid: path.Sid
      - text: Show me the status and details of compliance bundle {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update or submit a regulatory bundle
      effect: write
      questions:
      - How do I submit a draft regulatory bundle for review once it is complete?
      - Can I change the notification email on a compliance bundle I already created?
      instructions:
      - text: Set the status of regulatory bundle {sid} to {status}.
        slots:
          sid: path.Sid
          status: requestBody.Status
      - text: Rename existing compliance bundle {sid} to {friendly_name}.
        slots:
          sid: path.Sid
          friendly_name: requestBody.FriendlyName
      - text: Change the status notification email on bundle {sid} to {email}.
        slots:
          sid: path.Sid
          email: requestBody.Email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a regulatory bundle
      effect: destructive
      questions:
      - Can I permanently remove a regulatory bundle I no longer need?
      - What happens to an abandoned compliance bundle if I delete it?
      instructions:
      - text: Delete regulatory bundle {sid}.
        slots:
          sid: path.Sid
      - text: Remove the unused compliance bundle {sid} from my account.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies'].get
  update:
    x-apievangelist-phrasing:
      intent: List copies made of a bundle
      effect: read
      questions:
      - Which copies have been made from one of my regulatory bundles?
      - Can I see every duplicate that was cloned from an original compliance bundle?
      instructions:
      - text: List the copies made from bundle {bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
      - text: Show every clone of regulatory bundle {bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a regulatory bundle
      effect: write
      questions:
      - Can I duplicate an approved regulatory bundle along with its identities and documents?
      - How do I reuse an existing compliance bundle as the starting point for a new one?
      instructions:
      - text: Make a copy of bundle {bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
      - text: Clone regulatory bundle {bundle_sid} and name the copy {friendly_name}.
        slots:
          bundle_sid: path.BundleSid
          friendly_name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/EndUsers'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance end users
      effect: read
      questions:
      - Which end users (individuals or businesses) have I registered for regulatory compliance?
      - Where do I see all the end-user identities on my account?
      instructions:
      - text: List all regulatory end users on my account.
      - text: Show the next {page_size} compliance end users.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/EndUsers'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a compliance end user
      effect: write
      questions:
      - How do I add the business or person who will own a regulated phone number?
      - Can I record an end user's identity attributes for a regulatory bundle?
      instructions:
      - text: Create a {type} end user named {friendly_name}.
        slots:
          type: requestBody.Type
          friendly_name: requestBody.FriendlyName
      - text: Register end user {friendly_name} of type {type} with attributes {attributes}.
        slots:
          friendly_name: requestBody.FriendlyName
          type: requestBody.Type
          attributes: requestBody.Attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/EndUsers/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one compliance end user
      effect: read
      questions:
      - What identity attributes are stored on a particular end user?
      - Can I look up a single regulatory end user by SID?
      instructions:
      - text: Get end user {sid}.
        slots:
          sid: path.Sid
      - text: Show the attributes recorded for compliance end user {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/EndUsers/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a compliance end user
      effect: write
      questions:
      - Can I correct the attributes on an end user I already registered?
      - How can I rename an existing regulatory end user?
      instructions:
      - text: Update the attributes of existing end user {sid} to {attributes}.
        slots:
          sid: path.Sid
          attributes: requestBody.Attributes
      - text: Rename end user {sid} to {friendly_name}.
        slots:
          sid: path.Sid
          friendly_name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/EndUsers/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a compliance end user
      effect: destructive
      questions:
      - Is it possible to remove an end user identity I registered by mistake?
      - Can I clean up regulatory end users I no longer use?
      instructions:
      - text: Delete end user {sid}.
        slots:
          sid: path.Sid
      - text: Remove the regulatory end-user record {sid} permanently.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/EndUserTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List end-user types
      effect: read
      questions:
      - What kinds of end users can be registered for regulatory compliance?
      - Which end-user types are available and what fields does each expect?
      instructions:
      - text: List every available end-user type.
      - text: Show {page_size} end-user types per page.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/EndUserTypes/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one end-user type
      effect: read
      questions:
      - Which attributes does one specific end-user type require?
      - Can I inspect the definition of a single end-user type?
      instructions:
      - text: Get end-user type {sid}.
        slots:
          sid: path.Sid
      - text: Show the required fields for end-user type {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: List evaluations run on a bundle
      effect: read
      questions:
      - What past compliance evaluations have been run against my bundle?
      - Can I see the history of checks performed on one regulatory bundle?
      instructions:
      - text: List the evaluations for bundle {bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
      - text: Show every compliance check history entry on bundle {bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate a bundle against its regulation
      effect: write
      questions:
      - How do I check whether my regulatory bundle meets the requirements before submitting it?
      - Can I run a fresh compliance evaluation on a bundle to find what is missing?
      instructions:
      - text: Run a new compliance evaluation on bundle {bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
      - text: Evaluate bundle {bundle_sid} now and tell me what fails.
        slots:
          bundle_sid: path.BundleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one bundle evaluation result
      effect: read
      questions:
      - What did a specific earlier evaluation of my bundle find?
      - Can I pull up the results of one particular compliance evaluation?
      instructions:
      - text: Get evaluation {sid} of bundle {bundle_sid}.
        slots:
          sid: path.Sid
          bundle_sid: path.BundleSid
      - text: Show the results of evaluation {sid} on regulatory bundle {bundle_sid}.
        slots:
          sid: path.Sid
          bundle_sid: path.BundleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List items assigned to a bundle
      effect: read
      questions:
      - Which end users and supporting documents are attached to my bundle?
      - What items have been assigned to a regulatory bundle so far?
      instructions:
      - text: List the items assigned to bundle {bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
      - text: Show which identities and documents are attached to bundle {bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach an item to a bundle
      effect: write
      questions:
      - How do I attach an end user or supporting document to a regulatory bundle?
      - Can I add one more identity document to a bundle I am assembling?
      instructions:
      - text: Assign item {object_sid} to bundle {bundle_sid}.
        slots:
          object_sid: requestBody.ObjectSid
          bundle_sid: path.BundleSid
      - text: Attach supporting document or end user {object_sid} to regulatory bundle {bundle_sid}.
        slots:
          object_sid: requestBody.ObjectSid
          bundle_sid: path.BundleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one bundle item assignment
      effect: read
      questions:
      - Can I look at a single item assignment on my regulatory bundle?
      - Which object does a given bundle assignment point to?
      instructions:
      - text: Get item assignment {sid} on bundle {bundle_sid}.
        slots:
          sid: path.Sid
          bundle_sid: path.BundleSid
      - text: Show what assignment {sid} links to in regulatory bundle {bundle_sid}.
        slots:
          sid: path.Sid
          bundle_sid: path.BundleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach an item from a bundle
      effect: destructive
      questions:
      - How can I remove a wrong document from a regulatory bundle?
      - Can I unassign an end user from a bundle without deleting the end user itself?
      instructions:
      - text: Remove item assignment {sid} from bundle {bundle_sid}.
        slots:
          sid: path.Sid
          bundle_sid: path.BundleSid
      - text: Detach assigned item {sid} from regulatory bundle {bundle_sid}.
        slots:
          sid: path.Sid
          bundle_sid: path.BundleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Regulations'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone number regulations
      effect: read
      questions:
      - What regulations apply to buying phone numbers in a given country?
      - Which requirements do I face for a business versus an individual owning a toll-free number?
      - Can I filter regulations by number type, like local or mobile?
      instructions:
      - text: List the regulations for {number_type} numbers in {iso_country}.
        slots:
          number_type: query.NumberType
          iso_country: query.IsoCountry
      - text: Show regulations that apply to a {end_user_type} end user in {iso_country}.
        slots:
          end_user_type: query.EndUserType
          iso_country: query.IsoCountry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Regulations/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one phone number regulation
      effect: read
      questions:
      - What exactly does one specific regulation require me to provide?
      - Can I read the details of a regulation by its SID?
      instructions:
      - text: Get regulation {sid}.
        slots:
          sid: path.Sid
      - text: Show the requirements defined by regulation {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace a bundle's items with another's
      effect: write
      questions:
      - Can I swap all the items in one bundle for the items from another bundle?
      - Is there a way to overwrite a bundle's documents and identities using a source bundle?
      instructions:
      - text: Replace all items in bundle {bundle_sid} with the items from bundle {from_bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
          from_bundle_sid: requestBody.FromBundleSid
      - text: Overwrite target bundle {bundle_sid} using source bundle {from_bundle_sid}.
        slots:
          bundle_sid: path.BundleSid
          from_bundle_sid: requestBody.FromBundleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/SupportingDocuments'].get
  update:
    x-apievangelist-phrasing:
      intent: List supporting documents
      effect: read
      questions:
      - What supporting documents have I uploaded for regulatory compliance?
      - Where can I review every proof-of-address or business document on my account?
      instructions:
      - text: List all my supporting documents.
      - text: Show {page_size} compliance supporting documents at a time.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/SupportingDocuments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a supporting document
      effect: write
      questions:
      - How do I provide a supporting document like proof of address for a bundle?
      - Can I create a supporting document record with its type and attributes?
      instructions:
      - text: Create a {type} supporting document named {friendly_name}.
        slots:
          type: requestBody.Type
          friendly_name: requestBody.FriendlyName
      - text: Add supporting document {friendly_name} of type {type} with attributes {attributes}.
        slots:
          friendly_name: requestBody.FriendlyName
          type: requestBody.Type
          attributes: requestBody.Attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/SupportingDocuments/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one supporting document
      effect: read
      questions:
      - What is recorded on one particular supporting document?
      - Can I check the status of a single supporting document by SID?
      instructions:
      - text: Get supporting document {sid}.
        slots:
          sid: path.Sid
      - text: Show the details of compliance document {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/SupportingDocuments/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a supporting document
      effect: write
      questions:
      - Can I fix the attributes on a supporting document I already created?
      - How would I rename an existing supporting document?
      instructions:
      - text: Update existing supporting document {sid} with attributes {attributes}.
        slots:
          sid: path.Sid
          attributes: requestBody.Attributes
      - text: Rename supporting document {sid} to {friendly_name}.
        slots:
          sid: path.Sid
          friendly_name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/SupportingDocuments/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a supporting document
      effect: destructive
      questions:
      - Can I delete a supporting document that was uploaded in error?
      - Is removing an outdated compliance document permanent?
      instructions:
      - text: Delete supporting document {sid}.
        slots:
          sid: path.Sid
      - text: Permanently remove outdated compliance document {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/SupportingDocumentTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List supporting document types
      effect: read
      questions:
      - Which kinds of supporting documents are accepted for compliance?
      - What document types can I choose from when adding proof for a bundle?
      instructions:
      - text: List every supporting document type.
      - text: Show {page_size} accepted document types per page.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one supporting document type
      effect: read
      questions:
      - What fields does a particular supporting document type expect?
      - Can I look up one document type definition by SID?
      instructions:
      - text: Get supporting document type {sid}.
        slots:
          sid: path.Sid
      - text: Show the fields required by document type {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'