# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elation Health Thread Messages API
  version: 1.0.0
extends: openapi/elation-health-thread-messages-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/thread_messages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a message in a thread (Get)
      effect: read
      questions:
      - How do I get the body of one message in a patient thread?
      - Can I get who sent a thread message?
      instructions:
      - text: Get thread message {id}.
        slots:
          id: path.id
      - text: Get the sender and body of message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/thread_messages/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a thread message (legacy)
      effect: destructive
      questions:
      - How do I delete a single message from a thread with the older call?
      - Can a sent thread message be removed?
      instructions:
      - text: Delete thread message {id} with the legacy call.
        slots:
          id: path.id
      - text: Remove message {id} from its thread.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/thread_messages/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find thread messages (unfiltered)
      effect: read
      questions:
      - Can I pull every thread message without any filters?
      - Is there a basic call that returns all thread messages?
      instructions:
      - text: Find all thread messages.
      - text: Return thread messages without filtering.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/thread_messages/'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a message to a thread
      effect: write
      questions:
      - How do I add a reply to an existing message thread on the legacy endpoint?
      - Can a new thread message also be saved to a document?
      instructions:
      - text: Post {body} to thread {thread} from {sender} sent {send_date}.
        slots:
          body: requestBody.body
          thread: requestBody.thread
          sender: requestBody.sender
          send_date: requestBody.send_date
      - text: Reply in thread {thread} as {sender} on {send_date} saying {body}, attach to document {to_document}.
        slots:
          thread: requestBody.thread
          sender: requestBody.sender
          send_date: requestBody.send_date
          body: requestBody.body
          to_document: requestBody.to_document
      method: generated
      generated: '2026-10-02'
- target: $.paths['/thread_messages/ [WIP]'].get
  update:
    x-apievangelist-phrasing:
      intent: Find thread messages by thread (WIP)
      effect: read
      questions:
      - Is there a WIP endpoint to find messages by thread or sender?
      - Can I find a patient's thread messages with the work-in-progress call?
      instructions:
      - text: Using the WIP endpoint, find messages in thread {thread}.
        slots:
          thread: query.thread
      - text: WIP-find messages sent by {sender} for patient {patient}.
        slots:
          sender: query.sender
          patient: query.patient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/thread_messages/ [WIP]'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a thread message (WIP)
      effect: write
      questions:
      - Does the work-in-progress API let me post a thread message?
      - Can I create a thread message using the WIP endpoint?
      instructions:
      - text: Via the WIP endpoint, post {body} to thread {thread} from {sender} on {send_date}.
        slots:
          body: requestBody.body
          thread: requestBody.thread
          sender: requestBody.sender
          send_date: requestBody.send_date
      - text: WIP-create message {body} in {thread} by {sender} at {send_date}.
        slots:
          body: requestBody.body
          thread: requestBody.thread
          sender: requestBody.sender
          send_date: requestBody.send_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/thread_messages/'].get
  update:
    x-apievangelist-phrasing:
      intent: List thread messages with paging
      effect: read
      questions:
      - Can I page through thread messages with limit and offset?
      - How do I list thread messages at a practice sorted by send date?
      instructions:
      - text: List thread messages, {limit} per page.
        slots:
          limit: query.limit
      - text: List messages at practice {practice} ordered by {order_by}.
        slots:
          practice: query.practice
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/thread_messages/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a thread message for a patient
      effect: write
      questions:
      - Can I create a thread message tied to a patient and practice?
      - What's required to create a new thread message in the v2.0 API?
      instructions:
      - text: Create message {body} from {sender} sent {send_date}.
        slots:
          body: requestBody.body
          sender: requestBody.sender
          send_date: requestBody.send_date
      - text: 'Create a message for patient {patient} in thread {thread}: {body}, from {sender}, {send_date}.'
        slots:
          patient: requestBody.patient
          thread: requestBody.thread
          body: requestBody.body
          sender: requestBody.sender
          send_date: requestBody.send_date
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/thread_messages/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a thread message
      effect: read
      questions:
      - Can I retrieve one thread message by id?
      - Where do I retrieve the send date of a thread message?
      instructions:
      - text: Retrieve thread message {id}.
        slots:
          id: path.id
      - text: Retrieve when message {id} was sent.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/thread_messages/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a thread message
      effect: destructive
      questions:
      - How do I delete an existing thread message by id?
      - Can I destroy a thread message?
      instructions:
      - text: Delete existing thread message {id}.
        slots:
          id: path.id
      - text: Destroy thread message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'