# 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 Incoming Files API
  version: 1.0.0
extends: openapi/elation-health-incoming-files-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: 9
- target: $.paths['/incoming_files/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find incoming faxes and files (legacy endpoint)
      effect: read
      questions:
      - Which faxes came in from a particular number, according to the legacy search?
      - Can I find incoming files still waiting to be processed with the older lookup?
      instructions:
      - text: Using the legacy lookup, find incoming files from number {from_number}.
        slots:
          from_number: query.from_number
      - text: Find old-path incoming files in process state {process_state} received after {received_date__gte}.
        slots:
          process_state: query.process_state
          received_date__gte: query.received_date__gte
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incoming_files/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incoming file (legacy endpoint)
      effect: read
      questions:
      - Can I open one incoming fax record on the legacy path?
      - Does the older incoming file lookup show its processing state?
      instructions:
      - text: Open incoming file {id} using the legacy endpoint.
        slots:
          id: path.id
      - text: Show the processing state of old-path incoming file {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incoming_files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an incoming file group (legacy endpoint)
      effect: write
      questions:
      - How do I push scanned documents into a practice's inbox through the legacy endpoint?
      - Can I upload images and files together as one group the old way?
      instructions:
      - text: Via the legacy endpoint, upload file group {group_name} to practice {practice}.
        slots:
          group_name: requestBody.group_name
          practice: requestBody.practice
      - text: Send old-path incoming files {files} as group {group_name} for practice {practice}.
        slots:
          files: requestBody.files
          group_name: requestBody.group_name
          practice: requestBody.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/incoming_files/'].get
  update:
    x-apievangelist-phrasing:
      intent: List incoming files in API 2.0
      effect: read
      questions:
      - How do I list incoming faxes received on a specific practice fax line in API 2.0?
      - Can API 2.0 show incoming files received within a time window?
      instructions:
      - text: List 2.0 incoming files on practice fax {practice_fax}.
        slots:
          practice_fax: query.practice_fax
      - text: List API 2.0 incoming files received between {received_time__gte} and {received_time__lte}.
        slots:
          received_time__gte: query.received_time__gte
          received_time__lte: query.received_time__lte
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/incoming_files/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an incoming file group in API 2.0
      effect: write
      questions:
      - How do I record an inbound fax with its sender number in the 2.0 API?
      - Can I include page count and subject when creating an incoming file?
      instructions:
      - text: In API 2.0, create incoming file group {group_name} for practice {practice}.
        slots:
          group_name: requestBody.group_name
          practice: requestBody.practice
      - text: Record a 2.0 inbound fax {group_name} for practice {practice} from {from_number} with subject {subject}.
        slots:
          group_name: requestBody.group_name
          practice: requestBody.practice
          from_number: requestBody.from_number
          subject: requestBody.subject
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/incoming_files/{file_group_id}/files/{file_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file from an incoming file group
      effect: read
      questions:
      - How do I download one document out of an incoming fax group?
      - Can I get a specific file attached to an incoming file group?
      instructions:
      - text: Download file {file_id} from incoming group {file_group_id}.
        slots:
          file_id: path.file_id
          file_group_id: path.file_group_id
      - text: Fetch document {file_id} out of fax group {file_group_id}.
        slots:
          file_id: path.file_id
          file_group_id: path.file_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/incoming_files/{file_group_id}/images/{image_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a page image from an incoming file group
      effect: read
      questions:
      - Can I view a page image from an incoming fax at a chosen size?
      - How do I pull a thumbnail of one image in an incoming file group?
      instructions:
      - text: Get image {image_id} from incoming group {file_group_id}.
        slots:
          image_id: path.image_id
          file_group_id: path.file_group_id
      - text: Show image {image_id} of fax group {file_group_id} at size {size}.
        slots:
          image_id: path.image_id
          file_group_id: path.file_group_id
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/incoming_files/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an incoming file group in API 2.0
      effect: read
      questions:
      - How do I retrieve one incoming file group by ID in API 2.0?
      - Does a 2.0 incoming file show the fax sender and page count?
      instructions:
      - text: Retrieve API 2.0 incoming file {id}.
        slots:
          id: path.id
      - text: Get the sender and page count of 2.0 incoming file {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/patients/{id}/incoming_files/'].post
  update:
    x-apievangelist-phrasing:
      intent: File a document into a patient's chart
      effect: write
      questions:
      - How do I attach an outside document directly to a patient's chart?
      - Can I flag an uploaded patient document as urgent and assign a reviewer?
      instructions:
      - text: Upload {files} to patient {id}'s chart as a {document_type} document.
        slots:
          files: requestBody.files
          id: path.id
          document_type: requestBody.document_type
      - text: File a {document_type} for patient {id} titled {custom_title}, urgent {urgent}, for review by {reviewer_user}.
        slots:
          document_type: requestBody.document_type
          id: path.id
          custom_title: requestBody.custom_title
          urgent: requestBody.urgent
          reviewer_user: requestBody.reviewer_user
      method: generated
      generated: '2026-09-26'