# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Remote Benefits Benefit Offers API
  version: 1.0.0
extends: openapi/remote-com-benefit-offers-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: 5
- target: $.paths['/benefit_offers'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse benefit offers by country
      effect: read
      questions:
      - What benefit packages can I offer employees in each country?
      - Which benefit offers are available for new hires in a specific country?
      instructions:
      - text: List the benefit offers available in {country_code}.
        slots:
          country_code: query.country_code
      - text: Show me all benefit offers grouped by country.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/benefit_offers/by_employment'].get
  update:
    x-apievangelist-phrasing:
      intent: List benefit offers eligible for an employee
      effect: read
      questions:
      - Which benefit offers can a particular employee choose from?
      - Can I see the benefit options available to one employment before enrolling them?
      instructions:
      - text: List the benefit offers an employee on employment {employment_id} is eligible for.
        slots:
          employment_id: query.employment_id
      - text: Look up the offer choices open to employment {employment_id}.
        slots:
          employment_id: query.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/benefit_offers/{employment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee's selected benefits
      effect: read
      questions:
      - What benefits has an employee currently been enrolled in?
      - How can I check which benefit offers were saved for an employment?
      instructions:
      - text: Show the benefit selections saved for employment {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: Get the current benefits enrollment of employment {employment_id}.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/benefit_offers/{employment_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an employee's benefit selections
      effect: write
      questions:
      - How do I enroll an employee in benefits or change their existing selection?
      - Can I overwrite the benefit choices already saved for an employment?
      instructions:
      - text: Save the benefit selections for employment {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: Update which benefit offers employment {employment_id} is enrolled in.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/benefit_offers/{employment_id}/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the benefits form schema for an employee
      effect: read
      questions:
      - What fields do I need to fill in when enrolling an employee in benefits?
      - Where do I find the JSON Schema that describes an employment's benefit enrollment form?
      instructions:
      - text: Fetch the benefits enrollment JSON Schema for employment {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: Show the form definition I must follow to save benefits for employment {employment_id}.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'