# 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 Customer Profiles API
  version: 1.0.0
extends: openapi/twilio-customer-profiles-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/CustomerProfiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List my customer profiles
      effect: read
      questions:
      - Which of my customer profiles are still pending review or were rejected?
      - Can I find customer profiles by friendly name or by the policy they follow?
      - What customer profiles does my account have for trust and compliance?
      instructions:
      - text: List all my customer profiles.
      - text: List customer profiles with status {status}.
        slots:
          status: query.Status
      - text: Find customer profiles named {name} under policy {policy}.
        slots:
          name: query.FriendlyName
          policy: query.PolicySid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer profile
      effect: write
      questions:
      - How do I start a new business customer profile for compliance review?
      - Can I get notified by callback when a new customer profile's status changes?
      instructions:
      - text: Create a customer profile named {name} with contact email {email} under policy {policy}.
        slots:
          name: requestBody.FriendlyName
          email: requestBody.Email
          policy: requestBody.PolicySid
      - text: Open a new customer profile {name} for {email} on policy {policy} and send status updates to {callback_url}.
        slots:
          name: requestBody.FriendlyName
          email: requestBody.Email
          policy: requestBody.PolicySid
          callback_url: requestBody.StatusCallback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one customer profile
      effect: read
      questions:
      - What is the current review status of a specific customer profile?
      - Can I look up a single customer profile's email and policy?
      instructions:
      - text: Get customer profile {profile}.
        slots:
          profile: path.Sid
      - text: Show the status and details of customer profile {profile}.
        slots:
          profile: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update or submit a customer profile
      effect: write
      questions:
      - How do I submit an existing customer profile for review once it is complete?
      - Can I change the notification email on a customer profile I already created?
      instructions:
      - text: Set the status of customer profile {profile} to {status}.
        slots:
          profile: path.Sid
          status: requestBody.Status
      - text: Change the email on existing customer profile {profile} to {email}.
        slots:
          profile: path.Sid
          email: requestBody.Email
      - text: Rename customer profile {profile} to {name}.
        slots:
          profile: path.Sid
          name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer profile
      effect: destructive
      questions:
      - Can I permanently remove a customer profile I no longer need?
      - What happens if I want to throw away a draft customer profile entirely?
      instructions:
      - text: Delete customer profile {profile}.
        slots:
          profile: path.Sid
      - text: Permanently remove the customer profile {profile} from my account.
        slots:
          profile: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone numbers assigned to a customer profile
      effect: read
      questions:
      - Which phone numbers or channel endpoints are assigned to a customer profile?
      - Can I check whether a particular channel endpoint is already on a profile?
      instructions:
      - text: List the channel endpoints assigned to customer profile {profile}.
        slots:
          profile: path.CustomerProfileSid
      - text: Check whether channel endpoint {endpoint} is assigned to customer profile {profile}.
        slots:
          endpoint: query.ChannelEndpointSid
          profile: path.CustomerProfileSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a phone number to a customer profile
      effect: write
      questions:
      - How do I attach one of my phone numbers to a customer profile?
      - Can I assign a channel endpoint of type phone-number to a business profile?
      instructions:
      - text: Assign {endpoint_type} endpoint {endpoint} to customer profile {profile}.
        slots:
          endpoint_type: requestBody.ChannelEndpointType
          endpoint: requestBody.ChannelEndpointSid
          profile: path.CustomerProfileSid
      - text: Attach phone number endpoint {endpoint} to profile {profile} as type {endpoint_type}.
        slots:
          endpoint: requestBody.ChannelEndpointSid
          profile: path.CustomerProfileSid
          endpoint_type: requestBody.ChannelEndpointType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one channel endpoint assignment on a profile
      effect: read
      questions:
      - Can I look up a single phone number assignment on a customer profile?
      - What channel endpoint does a given assignment on my profile point to?
      instructions:
      - text: Get channel endpoint assignment {assignment} on customer profile {profile}.
        slots:
          assignment: path.Sid
          profile: path.CustomerProfileSid
      - text: Show which endpoint assignment {assignment} links to profile {profile}.
        slots:
          assignment: path.Sid
          profile: path.CustomerProfileSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign a phone number from a customer profile
      effect: destructive
      questions:
      - How do I take a phone number off a customer profile?
      - Can I remove a channel endpoint assignment without deleting the profile?
      instructions:
      - text: Remove channel endpoint assignment {assignment} from customer profile {profile}.
        slots:
          assignment: path.Sid
          profile: path.CustomerProfileSid
      - text: Unassign the phone number held by assignment {assignment} on profile {profile}.
        slots:
          assignment: path.Sid
          profile: path.CustomerProfileSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents and end-users on a customer profile
      effect: read
      questions:
      - Which supporting documents and end-users are attached to my customer profile?
      - What entities have I already added to a business profile?
      instructions:
      - text: List the entity assignments on customer profile {profile}.
        slots:
          profile: path.CustomerProfileSid
      - text: Show every end-user and supporting document attached to profile {profile}.
        slots:
          profile: path.CustomerProfileSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a document or end-user to a customer profile
      effect: write
      questions:
      - How do I add a supporting document or authorized representative to a customer profile?
      - Can I attach an existing end-user object to a business profile?
      instructions:
      - text: Attach object {object} to customer profile {profile}.
        slots:
          object: requestBody.ObjectSid
          profile: path.CustomerProfileSid
      - text: Add supporting document or end-user {object} to profile {profile}.
        slots:
          object: requestBody.ObjectSid
          profile: path.CustomerProfileSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entity assignment on a customer profile
      effect: read
      questions:
      - Can I look up one specific document or end-user assignment on a profile?
      - Which object does a given entity assignment on my profile reference?
      instructions:
      - text: Get entity assignment {assignment} on customer profile {profile}.
        slots:
          assignment: path.Sid
          profile: path.CustomerProfileSid
      - text: Show what object entity assignment {assignment} attaches to profile {profile}.
        slots:
          assignment: path.Sid
          profile: path.CustomerProfileSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a document or end-user from a profile
      effect: destructive
      questions:
      - How do I remove a wrong supporting document from a customer profile?
      - Can I detach an end-user from a profile without deleting the end-user itself?
      instructions:
      - text: Remove entity assignment {assignment} from customer profile {profile}.
        slots:
          assignment: path.Sid
          profile: path.CustomerProfileSid
      - text: Detach the document or end-user in assignment {assignment} from profile {profile}.
        slots:
          assignment: path.Sid
          profile: path.CustomerProfileSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance evaluations of a customer profile
      effect: read
      questions:
      - Has my customer profile been evaluated against its policy before, and what were the results?
      - What evaluation history exists for a business profile?
      instructions:
      - text: List the evaluations run on customer profile {profile}.
        slots:
          profile: path.CustomerProfileSid
      - text: Show the policy evaluation history for profile {profile}, {page_size} per page.
        slots:
          profile: path.CustomerProfileSid
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate a customer profile against a policy
      effect: write
      questions:
      - How do I check whether my customer profile satisfies a regulatory policy before submitting it?
      - Can I run a fresh compliance check on a profile after adding documents?
      instructions:
      - text: Evaluate customer profile {profile} against policy {policy}.
        slots:
          profile: path.CustomerProfileSid
          policy: requestBody.PolicySid
      - text: Run a new compliance check of profile {profile} using policy {policy}.
        slots:
          profile: path.CustomerProfileSid
          policy: requestBody.PolicySid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one evaluation result for a customer profile
      effect: read
      questions:
      - What did a specific compliance evaluation of my profile find?
      - Can I see which requirements failed in one evaluation of a customer profile?
      instructions:
      - text: Get evaluation {evaluation} of customer profile {profile}.
        slots:
          evaluation: path.Sid
          profile: path.CustomerProfileSid
      - text: Show the results of evaluation {evaluation} for profile {profile}.
        slots:
          evaluation: path.Sid
          profile: path.CustomerProfileSid
      method: generated
      generated: '2026-09-26'