# 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 Sponsorship API
  version: 1.0.0
extends: openapi/hint-health-sponsorship-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/{company_id}/sponsorships'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's sponsored patients
      effect: read
      questions:
      - Which patients does an employer company sponsor?
      - Can I list sponsorships for just one family at a company?
      instructions:
      - text: List sponsorships for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show company {company_id}'s sponsorships for family {family_id}.
        slots:
          company_id: path.company_id
          family_id: query.family_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/sponsorships'].post
  update:
    x-apievangelist-phrasing:
      intent: Sponsor a patient under a company
      effect: write
      questions:
      - How do I add an employee as a sponsored patient under their employer?
      - Can I add a dependent to a company sponsorship rather than a subscriber?
      instructions:
      - text: Sponsor patient {patient} under company {company_id} as a {type}, subscriber {is_subscriber}.
        slots:
          patient: requestBody.patient
          company_id: path.company_id
          type: requestBody.type
          is_subscriber: requestBody.is_subscriber
      - text: Add patient {patient} to company {company_id} as {type} with external id {external_id}, is_subscriber {is_subscriber}.
        slots:
          patient: requestBody.patient
          company_id: path.company_id
          type: requestBody.type
          external_id: requestBody.external_id
          is_subscriber: requestBody.is_subscriber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/sponsorships/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one company sponsorship
      effect: read
      questions:
      - Can I look up a single sponsorship at a company?
      - Who is covered by a specific sponsorship?
      instructions:
      - text: Show sponsorship {id} at company {company_id}.
        slots:
          id: path.id
          company_id: path.company_id
      - text: Get details of company {company_id}'s sponsorship {id}.
        slots:
          id: path.id
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/sponsorships/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a company sponsorship
      effect: destructive
      questions:
      - If I remove a subscriber's sponsorship, are their dependents removed too?
      - Can I take a patient off an employer's sponsorship?
      instructions:
      - text: Delete sponsorship {id} at company {company_id}.
        slots:
          id: path.id
          company_id: path.company_id
      - text: Remove sponsorship {id} from company {company_id}, including dependents.
        slots:
          id: path.id
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/sponsorships/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a sponsorship's type or external id
      effect: write
      questions:
      - How do I change the sponsorship type for an employee?
      - Can I update the external id on an existing sponsorship?
      instructions:
      - text: Change sponsorship {id} at company {company_id} to type {type}.
        slots:
          id: path.id
          company_id: path.company_id
          type: requestBody.type
      - text: Set sponsorship {id} at company {company_id} to type {type} with external id {external_id}.
        slots:
          id: path.id
          company_id: path.company_id
          type: requestBody.type
          external_id: requestBody.external_id
      method: generated
      generated: '2026-10-01'