# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Incentive Coupons API
  version: 1.0.0
extends: openapi/conga-incentive-coupons-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: 8
- target: $.paths['/incentives/{ParentId}/coupons'].get
  update:
    x-apievangelist-phrasing:
      intent: List an incentive's coupons
      effect: read
      questions:
      - Which coupon codes exist for an incentive?
      - Can I filter an incentive's coupons?
      instructions:
      - text: List coupons of incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Show coupons on incentive {incentive} matching {filter}.
        slots:
          incentive: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/coupons'].post
  update:
    x-apievangelist-phrasing:
      intent: Create incentive coupons
      effect: write
      questions:
      - How do I add specific coupon codes to an incentive?
      - Can I create several coupons by hand at once?
      instructions:
      - text: Create coupons on incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Add these coupon codes to incentive {incentive}.
        slots:
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/coupons'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete incentive coupons in bulk
      effect: destructive
      questions:
      - Can I remove many coupons from an incentive?
      - How do I bulk-delete coupon codes?
      instructions:
      - text: Bulk delete coupons on incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Remove the selected coupons from incentive {incentive}.
        slots:
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/coupons'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update incentive coupons in bulk
      effect: write
      questions:
      - Can I edit several coupons in one request?
      - How do I bulk-update coupon codes on an incentive?
      instructions:
      - text: Bulk update coupons on incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Edit the selected coupons of incentive {incentive}.
        slots:
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/coupons/generate/{numberOfCoupons}'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-generate incentive coupons
      effect: write
      questions:
      - Can the system generate a batch of coupon codes for me?
      - How many coupons can I auto-generate for an incentive?
      instructions:
      - text: Generate {count} coupons for incentive {incentive}.
        slots:
          count: path.numberOfCoupons
          incentive: path.ParentId
      - text: Auto-create {count} coupon codes on {incentive}.
        slots:
          count: path.numberOfCoupons
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/coupons/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incentive coupon
      effect: read
      questions:
      - Where can I see one coupon's details?
      - What does a single coupon record show?
      instructions:
      - text: Get coupon {id} of incentive {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      - text: Show coupon record {id} on {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/coupons/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an incentive coupon
      effect: destructive
      questions:
      - Can I delete a single coupon code?
      - How do I remove one coupon from an incentive?
      instructions:
      - text: Delete coupon {id} from incentive {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      - text: Remove only coupon {id} on {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/coupons/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incentive coupon
      effect: write
      questions:
      - How do I edit one coupon?
      - Can I change a single coupon code record?
      instructions:
      - text: Update coupon {id} of incentive {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      - text: Edit only coupon {id} on {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'