# 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 Supporting Documents API
  version: 1.0.0
extends: openapi/twilio-supportingdocuments-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/SupportingDocuments'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Trust Hub supporting documents
      effect: read
      questions:
      - Which compliance documents have I uploaded to Trust Hub?
      - Can I page through all the supporting documents on my account?
      instructions:
      - text: List all my Trust Hub supporting documents.
      - text: Show my compliance documents, {page_size} per page.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SupportingDocuments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a supporting document
      effect: write
      questions:
      - How do I submit a business document for Trust Hub compliance review?
      - What details do I include when adding a supporting document, like an address proof?
      instructions:
      - text: Create a supporting document {name} of type {type}.
        slots:
          name: requestBody.FriendlyName
          type: requestBody.Type
      - text: Add a {type} compliance document called {name} with attributes {attributes}.
        slots:
          type: requestBody.Type
          name: requestBody.FriendlyName
          attributes: requestBody.Attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SupportingDocuments/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a supporting document
      effect: read
      questions:
      - What's the review status of a compliance document I submitted?
      - Can I pull up one supporting document by its SID?
      instructions:
      - text: Show supporting document {document}.
        slots:
          document: path.Sid
      - text: Check the status of compliance document {document}.
        slots:
          document: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SupportingDocuments/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a supporting document
      effect: write
      questions:
      - Can I correct the attributes on a supporting document I already submitted?
      - How do I rename an existing compliance document?
      instructions:
      - text: Update the attributes of supporting document {document} to {attributes}.
        slots:
          document: path.Sid
          attributes: requestBody.Attributes
      - text: Rename existing compliance document {document} to {name}.
        slots:
          document: path.Sid
          name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SupportingDocuments/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a supporting document
      effect: destructive
      questions:
      - How do I remove an outdated compliance document from Trust Hub?
      - Can I delete a supporting document I uploaded by mistake?
      instructions:
      - text: Delete supporting document {document}.
        slots:
          document: path.Sid
      - text: Remove the mistaken compliance upload {document}.
        slots:
          document: path.Sid
      method: generated
      generated: '2026-09-26'