# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Ecommerce Coupons API
  version: 1.0.0
extends: openapi/brevo-coupons-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['/couponCollections'].get
  update:
    x-apievangelist-phrasing:
      intent: List coupon collections
      effect: read
      questions:
      - What coupon collections do I have and how many coupons remain?
      - Can I sort coupon collections by expiration date?
      instructions:
      - text: List my coupon collections.
      - text: Show coupon collections sorted by {sortBy}.
        slots:
          sortBy: query.sortBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/couponCollections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a coupon collection
      effect: write
      questions:
      - How do I set up a new pool of discount coupons?
      - Can I get alerted when a coupon collection runs low?
      instructions:
      - text: Create coupon collection {name} with default coupon {defaultCoupon}.
        slots:
          name: requestBody.name
          defaultCoupon: requestBody.defaultCoupon
      - text: Create collection {name}, default {defaultCoupon}, expiring {expirationDate}.
        slots:
          name: requestBody.name
          defaultCoupon: requestBody.defaultCoupon
          expirationDate: requestBody.expirationDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/couponCollections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a coupon collection
      effect: read
      questions:
      - How many coupons are left in one collection?
      - What is the default coupon value of a specific collection?
      instructions:
      - text: Show coupon collection {id}.
        slots:
          id: path.id
      - text: Get remaining coupon count for collection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/couponCollections/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a coupon collection
      effect: write
      questions:
      - Can I change the expiration date of a coupon collection?
      - Is it possible to remove the low-stock alert on a collection?
      instructions:
      - text: Set collection {id} to expire on {expirationDate}.
        slots:
          id: path.id
          expirationDate: requestBody.expirationDate
      - text: Change the default coupon of collection {id} to {defaultCoupon}.
        slots:
          id: path.id
          defaultCoupon: requestBody.defaultCoupon
      method: generated
      generated: '2026-09-26'
- target: $.paths['/coupons'].post
  update:
    x-apievangelist-phrasing:
      intent: Add coupon codes to a collection
      effect: write
      questions:
      - How do I upload coupon codes into a collection?
      - What's the maximum number of coupon codes per upload?
      instructions:
      - text: Add coupons {coupons} to collection {collectionId}.
        slots:
          coupons: requestBody.coupons
          collectionId: requestBody.collectionId
      - text: Upload these codes {coupons} into coupon collection {collectionId}.
        slots:
          coupons: requestBody.coupons
          collectionId: requestBody.collectionId
      method: generated
      generated: '2026-09-26'