# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Remote Payroll and Billing Incentives API
  version: 1.0.0
extends: openapi/remote-com-incentives-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['/incentives'].get
  update:
    x-apievangelist-phrasing:
      intent: List incentives
      effect: read
      questions:
      - What bonuses or commissions have been scheduled for employees?
      - Can I filter incentives by employee or type?
      instructions:
      - text: List incentives for employment {employment_id}.
        slots:
          employment_id: query.employment_id
      - text: Show incentives of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incentives'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a bonus or incentive payment
      effect: write
      questions:
      - How do I pay an employee a one-time bonus through payroll?
      - Can I set up a recurring incentive for an employee?
      instructions:
      - text: Give employment {employment_id} a {type} of {amount} {currency} effective {effective_date}.
        slots:
          employment_id: requestBody.employment_id
          type: requestBody.type
          amount: requestBody.amount
          currency: requestBody.currency
          effective_date: requestBody.effective_date
      - text: Create a {recurrence} {type} incentive of {amount} {currency} for {employment_id} from {effective_date}.
        slots:
          recurrence: requestBody.recurrence
          type: requestBody.type
          amount: requestBody.amount
          currency: requestBody.currency
          employment_id: requestBody.employment_id
          effective_date: requestBody.effective_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incentives/{incentive_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View an incentive
      effect: read
      questions:
      - What are the details of a bonus I scheduled?
      - How do I look up one incentive by id?
      instructions:
      - text: Show incentive {incentive_id}.
        slots:
          incentive_id: path.incentive_id
      - text: Get the amount and date of incentive {incentive_id}.
        slots:
          incentive_id: path.incentive_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incentives/{incentive_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an incentive
      effect: destructive
      questions:
      - How do I cancel a bonus that hasn't been paid yet?
      - Can a scheduled incentive be deleted?
      instructions:
      - text: Delete incentive {incentive_id}.
        slots:
          incentive_id: path.incentive_id
      - text: Remove the scheduled bonus {incentive_id}.
        slots:
          incentive_id: path.incentive_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incentives/{incentive_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing incentive
      effect: write
      questions:
      - Can I change the amount or effective date of a bonus I already created?
      - How do I edit an existing incentive's recurrence?
      instructions:
      - text: Change incentive {incentive_id} to {amount} {currency}.
        slots:
          incentive_id: path.incentive_id
          amount: requestBody.amount
          currency: requestBody.currency
      - text: Move incentive {incentive_id} to take effect on {effective_date}.
        slots:
          incentive_id: path.incentive_id
          effective_date: requestBody.effective_date
      method: generated
      generated: '2026-09-26'