# 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 REST Insurance API
  version: 1.0.0
extends: openapi/elation-health-insurance-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: 6
- target: $.paths['/insurance_companies/'].get
  update:
    x-apievangelist-phrasing:
      intent: List insurance companies
      effect: read
      questions:
      - Which insurance companies are set up in the system?
      - Can I page through the insurance company list?
      instructions:
      - text: List insurance companies.
      - text: Show {limit} insurance companies starting at {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insurance_companies/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an insurance company
      effect: write
      questions:
      - How do I add a new insurance carrier with its payer id?
      - Can I store a carrier's phone and fax when creating it?
      instructions:
      - text: Create insurance company {name} with payer id {payer_id}.
        slots:
          name: requestBody.name
          payer_id: requestBody.payer_id
      - text: Add carrier {name} at {address}, phone {phone}, fax {fax}.
        slots:
          name: requestBody.name
          address: requestBody.address
          phone: requestBody.phone
          fax: requestBody.fax
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insurance_companies/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one insurance company
      effect: read
      questions:
      - What contact details are stored for a given insurance company?
      - Can I look up a carrier's payer id by its record id?
      instructions:
      - text: Retrieve insurance company {id}.
        slots:
          id: path.id
      - text: Show the payer id and contact info for carrier {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insurance_companies/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an insurance company record
      effect: write
      questions:
      - Which call fully replaces an insurance company's details?
      - Do I need to resend the name when replacing a carrier?
      instructions:
      - text: Replace insurance company {id} with name {name} and address {address}.
        slots:
          id: path.id
          name: requestBody.name
          address: requestBody.address
      - text: Overwrite every field of carrier {id}, naming it {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insurance_companies/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an insurance company
      effect: destructive
      questions:
      - Can I delete a duplicate insurance company?
      - What removes a carrier from the insurance list?
      instructions:
      - text: Delete insurance company {id}.
        slots:
          id: path.id
      - text: Remove duplicate carrier {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insurance_companies/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an insurance company's contact info
      effect: write
      questions:
      - Can I change just a carrier's phone or fax number?
      - Is there a partial update for an insurance company's payer id?
      instructions:
      - text: Update the phone of insurance company {id} ({name}) to {phone}.
        slots:
          id: path.id
          name: requestBody.name
          phone: requestBody.phone
      - text: Patch carrier {id} named {name} with new payer id {payer_id}.
        slots:
          id: path.id
          name: requestBody.name
          payer_id: requestBody.payer_id
      method: generated
      generated: '2026-09-26'