# 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 Trust Products API
  version: 1.0.0
extends: openapi/twilio-trustproducts-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: 16
- target: $.paths['/v1/TrustProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List trust products
      effect: read
      questions:
      - Which of my trust products are approved and which are still in review?
      - Can I find the trust products tied to a particular policy?
      - What trust products have I set up on this account?
      instructions:
      - text: List my trust products with status {status}.
        slots:
          status: query.Status
      - text: Show trust products that use policy {policy_sid}.
        slots:
          policy_sid: query.PolicySid
      - text: Find the trust product called {friendly_name}.
        slots:
          friendly_name: query.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a trust product
      effect: write
      questions:
      - How do I start a new trust product under a specific policy?
      - Can a trust product email me whenever its verification status changes?
      instructions:
      - text: Create trust product {friendly_name} under policy {policy_sid} with updates sent to {email}.
        slots:
          friendly_name: requestBody.FriendlyName
          policy_sid: requestBody.PolicySid
          email: requestBody.Email
      - text: Start a new trust product {friendly_name} for policy {policy_sid}, notify {email}, and call back {status_callback}.
        slots:
          friendly_name: requestBody.FriendlyName
          policy_sid: requestBody.PolicySid
          email: requestBody.Email
          status_callback: requestBody.StatusCallback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one trust product
      effect: read
      questions:
      - What is the verification status of one particular trust product?
      - Can I see the full record of a trust product by its SID?
      instructions:
      - text: Get trust product {sid}.
        slots:
          sid: path.Sid
      - text: Show me the status and details of trust product {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update or submit a trust product
      effect: write
      questions:
      - How do I submit a finished trust product for review?
      - Can I change the notification email on a trust product I already made?
      instructions:
      - text: Set the status of trust product {sid} to {status}.
        slots:
          sid: path.Sid
          status: requestBody.Status
      - text: Rename existing trust product {sid} to {friendly_name}.
        slots:
          sid: path.Sid
          friendly_name: requestBody.FriendlyName
      - text: Change the status email on trust product {sid} to {email}.
        slots:
          sid: path.Sid
          email: requestBody.Email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a trust product
      effect: destructive
      questions:
      - Can I permanently remove a trust product I no longer need?
      - Is deleting an abandoned trust product reversible?
      instructions:
      - text: Delete trust product {sid}.
        slots:
          sid: path.Sid
      - text: Remove the unused trust product {sid} from my account.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone numbers assigned to a trust product
      effect: read
      questions:
      - Which phone numbers or channel endpoints are covered by my trust product?
      - Is a specific phone number already assigned to this trust product?
      instructions:
      - text: List the channel endpoints assigned to trust product {trust_product_sid}.
        slots:
          trust_product_sid: path.TrustProductSid
      - text: Check whether channel endpoint {channel_endpoint_sid} is assigned to trust product {trust_product_sid}.
        slots:
          channel_endpoint_sid: query.ChannelEndpointSid
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a phone number to a trust product
      effect: write
      questions:
      - How do I attach a phone number to an approved trust product?
      - Can I link one of my channel endpoints to a trust product?
      instructions:
      - text: Assign {channel_endpoint_type} {channel_endpoint_sid} to trust product {trust_product_sid}.
        slots:
          channel_endpoint_type: requestBody.ChannelEndpointType
          channel_endpoint_sid: requestBody.ChannelEndpointSid
          trust_product_sid: path.TrustProductSid
      - text: Link phone number {channel_endpoint_sid} to trust product {trust_product_sid} as a {channel_endpoint_type}.
        slots:
          channel_endpoint_sid: requestBody.ChannelEndpointSid
          trust_product_sid: path.TrustProductSid
          channel_endpoint_type: requestBody.ChannelEndpointType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one phone number assignment
      effect: read
      questions:
      - Can I look up a single channel endpoint assignment on a trust product?
      - Which phone number does a given trust product endpoint assignment refer to?
      instructions:
      - text: Get channel endpoint assignment {sid} on trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      - text: Show the phone number behind endpoint assignment {sid} of trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign a phone number from a trust product
      effect: destructive
      questions:
      - How can I take a phone number off a trust product?
      - Can I remove a channel endpoint from a trust product without deleting the product?
      instructions:
      - text: Remove channel endpoint assignment {sid} from trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      - text: Unlink the phone number assignment {sid} from trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/EntityAssignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List entities attached to a trust product
      effect: read
      questions:
      - Which customer profiles, end users or documents are attached to my trust product?
      - What supporting entities has this trust product been given so far?
      instructions:
      - text: List the entities assigned to trust product {trust_product_sid}.
        slots:
          trust_product_sid: path.TrustProductSid
      - text: Show which profiles and documents are attached to trust product {trust_product_sid}.
        slots:
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/EntityAssignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach an entity to a trust product
      effect: write
      questions:
      - How do I attach a customer profile or supporting document to a trust product?
      - Can I add an end user entity to a trust product I am building?
      instructions:
      - text: Attach entity {object_sid} to trust product {trust_product_sid}.
        slots:
          object_sid: requestBody.ObjectSid
          trust_product_sid: path.TrustProductSid
      - text: Assign customer profile or document {object_sid} to trust product {trust_product_sid}.
        slots:
          object_sid: requestBody.ObjectSid
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entity assignment
      effect: read
      questions:
      - Can I inspect a single entity assignment on a trust product?
      - Which object does a particular trust product entity assignment point to?
      instructions:
      - text: Get entity assignment {sid} on trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      - text: Show what entity assignment {sid} links to in trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach an entity from a trust product
      effect: destructive
      questions:
      - How can I remove the wrong document or profile from a trust product?
      - Can I detach an entity from a trust product while keeping the entity itself?
      instructions:
      - text: Remove entity assignment {sid} from trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      - text: Detach the attached entity {sid} from trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/Evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: List evaluations of a trust product
      effect: read
      questions:
      - What evaluations have been run against my trust product so far?
      - Can I see the history of policy checks on one trust product?
      instructions:
      - text: List the evaluations for trust product {trust_product_sid}.
        slots:
          trust_product_sid: path.TrustProductSid
      - text: Show every past policy check on trust product {trust_product_sid}.
        slots:
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/Evaluations'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate a trust product against a policy
      effect: write
      questions:
      - How do I check whether my trust product satisfies its policy before submitting?
      - Can I run a new evaluation to see what a trust product is missing?
      instructions:
      - text: Evaluate trust product {trust_product_sid} against policy {policy_sid}.
        slots:
          trust_product_sid: path.TrustProductSid
          policy_sid: requestBody.PolicySid
      - text: Run a fresh policy check of {policy_sid} on trust product {trust_product_sid} and report failures.
        slots:
          policy_sid: requestBody.PolicySid
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one trust product evaluation
      effect: read
      questions:
      - What did a specific earlier evaluation of my trust product conclude?
      - Can I pull up the results of one trust product evaluation by SID?
      instructions:
      - text: Get evaluation {sid} of trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      - text: Show the results of evaluation {sid} on trust product {trust_product_sid}.
        slots:
          sid: path.Sid
          trust_product_sid: path.TrustProductSid
      method: generated
      generated: '2026-09-26'