# 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 Insurance Companies API
  version: 1.0.0
extends: openapi/elation-health-insurance-companies-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: 12
- target: $.paths['/insurance_companies/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find insurance companies by carrier
      effect: read
      questions:
      - How do I find a practice's insurance company by carrier name?
      - Which insurance carriers has my practice set up in Elation?
      instructions:
      - text: Find insurance companies named {carrier}.
        slots:
          carrier: query.carrier
      - text: Find the insurance companies for practice {practice}.
        slots:
          practice: query.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insurance_companies/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an insurance company with payer ID
      effect: write
      questions:
      - Can I add a new insurance carrier with its payer ID and address?
      - How do I register an insurance company for my practice on the legacy endpoint?
      instructions:
      - text: Add insurance company {carrier} to practice {practice}.
        slots:
          carrier: requestBody.carrier
          practice: requestBody.practice
      - text: Add carrier {carrier} for practice {practice} with payer ID {payer_id} and phone {phone}.
        slots:
          carrier: requestBody.carrier
          practice: requestBody.practice
          payer_id: requestBody.payer_id
          phone: requestBody.phone
      method: generated
      generated: '2026-10-02'
- target: $.paths['/insurance_companies/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an insurance company (Get endpoint)
      effect: read
      questions:
      - How do I get one insurance company's address and payer ID?
      - Can I get a carrier record by its id?
      instructions:
      - text: Get insurance company {id}.
        slots:
          id: path.id
      - text: Get the payer ID and address for insurer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insurance_companies/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an insurance company (legacy)
      effect: destructive
      questions:
      - How do I remove an insurance carrier with the older delete call?
      - Can I delete an insurer my practice no longer accepts?
      instructions:
      - text: Delete insurance company {id} using the legacy call.
        slots:
          id: path.id
      - text: Remove insurer {id} that we no longer accept.
        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 (legacy PUT)
      effect: write
      questions:
      - Can I overwrite an insurance company using the older PUT endpoint?
      - What fields does the legacy full update of an insurer require?
      instructions:
      - text: With the legacy PUT, set carrier {carrier} for practice {practice} and state {state}.
        slots:
          carrier: requestBody.carrier
          practice: requestBody.practice
          state: requestBody.state
      - text: Overwrite the insurer record via legacy PUT with carrier {carrier}, practice {practice}, credentialed {is_credentialed}.
        slots:
          carrier: requestBody.carrier
          practice: requestBody.practice
          is_credentialed: requestBody.is_credentialed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insurance_companies/:id/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an insurance company (legacy PATCH)
      effect: write
      questions:
      - Can I change just an insurer's phone number with the older PATCH call?
      - Is there a legacy partial update for insurance companies?
      instructions:
      - text: Using the legacy PATCH, change the insurer phone to {phone}.
        slots:
          phone: requestBody.phone
      - text: Legacy-patch the insurer aliases to {aliases} and type {insurance_type}.
        slots:
          aliases: requestBody.aliases
          insurance_type: requestBody.insurance_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/insurance_companies/'].get
  update:
    x-apievangelist-phrasing:
      intent: List insurance companies with paging
      effect: read
      questions:
      - Can I page through every insurance company my practice has?
      - How do I sort insurance companies when listing them?
      instructions:
      - text: List insurance companies, {limit} at a time.
        slots:
          limit: query.limit
      - text: List insurers for practice {practice} sorted by {order_by}.
        slots:
          practice: query.practice
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/insurance_companies/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an insurance company with eligibility ID
      effect: write
      questions:
      - Can I set an eligibility payer ID when creating an insurance company?
      - How do I create an insurer that is marked enrolled in the v2.0 API?
      instructions:
      - text: Create insurance company {carrier} for practice {practice} with eligibility payer ID {eligibility_payer_id}.
        slots:
          carrier: requestBody.carrier
          practice: requestBody.practice
          eligibility_payer_id: requestBody.eligibility_payer_id
      - text: Create enrolled insurer {carrier} in {practice}, enrolled {is_enrolled}.
        slots:
          carrier: requestBody.carrier
          practice: requestBody.practice
          is_enrolled: requestBody.is_enrolled
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/insurance_companies/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an insurance company
      effect: read
      questions:
      - Can I retrieve an insurance company with its eligibility payer ID?
      - Does retrieving an insurer show whether we're enrolled with it?
      instructions:
      - text: Retrieve insurance company {id}.
        slots:
          id: path.id
      - text: Retrieve enrollment status of insurer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/insurance_companies/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an insurance company
      effect: write
      questions:
      - Can I replace an insurer record including its plans?
      - What must I send to fully update an insurance company by id?
      instructions:
      - text: Replace insurance company {id} with carrier {carrier} for practice {practice}.
        slots:
          id: path.id
          carrier: requestBody.carrier
          practice: requestBody.practice
      - text: 'Replace insurer {id}: carrier {carrier}, practice {practice}, plans {plans}.'
        slots:
          id: path.id
          carrier: requestBody.carrier
          practice: requestBody.practice
          plans: requestBody.plans
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/insurance_companies/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an insurance company
      effect: destructive
      questions:
      - How do I delete an existing insurance company by id?
      - Can I destroy an insurance company record?
      instructions:
      - text: Delete existing insurance company {id}.
        slots:
          id: path.id
      - text: Destroy insurer record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/insurance_companies/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an insurance company
      effect: write
      questions:
      - Can I mark an insurance company as credentialed without resending it?
      - How do I update only an insurer's payer ID?
      instructions:
      - text: 'Mark insurance company {id} credentialed: {is_credentialed}.'
        slots:
          id: path.id
          is_credentialed: requestBody.is_credentialed
      - text: Set payer ID of insurer {id} to {payer_id}.
        slots:
          id: path.id
          payer_id: requestBody.payer_id
      method: generated
      generated: '2026-09-26'