# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Incentives API
  version: 1.0.0
extends: openapi/conga-incentives-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: 11
- target: $.paths['/incentives'].get
  update:
    x-apievangelist-phrasing:
      intent: List incentives
      effect: read
      questions:
      - Which promotions and incentives are defined in the catalog?
      - Can I filter or page through incentives?
      instructions:
      - text: List all incentives.
      - text: List incentives matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives'].post
  update:
    x-apievangelist-phrasing:
      intent: Create incentives
      effect: write
      questions:
      - How do I set up a new incentive or promotion?
      - Can I create several incentives at once?
      instructions:
      - text: Create new incentives.
      - text: Add a batch of promotional incentives.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete incentives in bulk
      effect: destructive
      questions:
      - Can I delete several incentive definitions at once?
      - How do I bulk-remove incentives from the catalog?
      instructions:
      - text: Bulk delete the selected incentive definitions.
      - text: Remove many incentives from the catalog in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update incentives in bulk
      effect: write
      questions:
      - Can I edit multiple incentive definitions in one request?
      - How do I bulk-update catalog incentives?
      instructions:
      - text: Bulk update the selected incentive definitions.
      - text: Edit several catalog incentives at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incentive
      effect: read
      questions:
      - Where can I see one incentive's setup?
      - Can I include related rules when fetching an incentive?
      instructions:
      - text: Get incentive {id}.
        slots:
          id: path.Id
      - text: Show incentive {id} including {includes}.
        slots:
          id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an incentive
      effect: destructive
      questions:
      - Can I delete a single incentive definition?
      - What happens when one promotion is removed from the catalog?
      instructions:
      - text: Delete incentive {id}.
        slots:
          id: path.Id
      - text: Remove only the incentive definition {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incentive
      effect: write
      questions:
      - How do I edit one incentive's definition?
      - Can I change the dates on a single promotion?
      instructions:
      - text: Update incentive {id}.
        slots:
          id: path.Id
      - text: Edit only the incentive definition {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/incentives'].get
  update:
    x-apievangelist-phrasing:
      intent: List incentives applied to a cart
      effect: read
      questions:
      - Which promotions are applied to my cart?
      - Can I filter the incentives on a cart?
      instructions:
      - text: Show the incentives on cart {cart}.
        slots:
          cart: path.cartId
      - text: List incentives on cart {cart} matching {filter}.
        slots:
          cart: path.cartId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/incentives'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply an incentive to a cart
      effect: write
      questions:
      - How do I apply a promo code to a cart?
      - Can I add an incentive to a cart by its ID?
      instructions:
      - text: Apply promo codes {codes} to cart {cart}.
        slots:
          codes: requestBody.codes
          cart: path.cartId
      - text: Add incentives {ids} to cart {cart}.
        slots:
          ids: requestBody.ids
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/incentives'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an incentive from a cart
      effect: destructive
      questions:
      - Can I take a promo code off my cart?
      - How do I remove an applied incentive from a cart?
      instructions:
      - text: Remove promo codes {codes} from cart {cart}.
        slots:
          codes: requestBody.codes
          cart: path.cartId
      - text: Take incentives {ids} off cart {cart}.
        slots:
          ids: requestBody.ids
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/incentives'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change incentives applied to a cart
      effect: write
      questions:
      - Can I change which incentives are applied to a cart?
      - How do I update the summary groups of a cart incentive?
      instructions:
      - text: Update the applied incentives {ids} on cart {cart}.
        slots:
          ids: requestBody.ids
          cart: path.cartId
      - text: Change the cart promo codes on {cart} to {codes}.
        slots:
          cart: path.cartId
          codes: requestBody.codes
      method: generated
      generated: '2026-10-01'