# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hint Health Company API
  version: 1.0.0
extends: openapi/hint-health-company-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/provider/companies'].get
  update:
    x-apievangelist-phrasing:
      intent: List employer companies
      effect: read
      questions:
      - Which employer companies are set up in my practice?
      - Can I see every company that sponsors patients?
      instructions:
      - text: List all companies.
      - text: Show every employer company in the practice.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an employer company
      effect: write
      questions:
      - What is needed to add a new employer company to my practice?
      - Can I set a default plan when creating a company?
      instructions:
      - text: Create company {name}.
        slots:
          name: requestBody.name
      - text: Add company {name} at {address} with default plan {default_plan}.
        slots:
          name: requestBody.name
          address: requestBody.address
          default_plan: requestBody.default_plan
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{id}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate an employer company
      effect: destructive
      questions:
      - How do I deactivate a company that is no longer a client?
      - Can I turn off an employer company without deleting it?
      instructions:
      - text: Deactivate company {id}.
        slots:
          id: path.id
      - text: Mark employer company {id} as inactive.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one employer company
      effect: read
      questions:
      - What details are on file for a specific company?
      - What address and phone numbers are on file for a company?
      instructions:
      - text: Show company {id}.
        slots:
          id: path.id
      - text: Get details for employer company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a company's name, address or phones
      effect: write
      questions:
      - How do I change a company's address or phone numbers?
      - Can I rename an employer company?
      instructions:
      - text: Rename company {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the address of company {id} to {address}.
        slots:
          id: path.id
          address: requestBody.address
      method: generated
      generated: '2026-10-01'