# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Antavo Coupons API
  version: 1.0.0
extends: openapi/antavo-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: 6
- target: $.paths['/v1/bulk-operation/coupons/{batch_id}/status/error'].get
  update:
    x-apievangelist-phrasing:
      intent: List errors from a coupon import
      effect: read
      questions:
      - Which coupon codes failed during my coupon import?
      - Where can I see what went wrong in a coupon batch upload?
      instructions:
      - text: List the errors from coupon import batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Show the failures in coupon upload batch {batch_id}.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/bulk-operation/coupons/{batch_id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a coupon import
      effect: read
      questions:
      - Is my coupon batch import queued, processing or done?
      - Can I track the progress of a coupon code upload?
      instructions:
      - text: Check the status of coupon import batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Tell me whether coupon batch {batch_id} has finished processing.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/bulk-operation/coupons/{coupon_pool_id}/{action}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload or assign coupons in a pool in bulk
      effect: write
      questions:
      - Can I upload a batch of coupon codes into a coupon pool?
      - Can I assign or unassign coupons to customers in bulk?
      instructions:
      - text: Run the {action} bulk operation on coupon pool {coupon_pool_id}.
        slots:
          action: path.action
          coupon_pool_id: path.coupon_pool_id
      - text: Upload a batch of coupon codes to pool {coupon_pool_id} using action {action}.
        slots:
          coupon_pool_id: path.coupon_pool_id
          action: path.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coupons'].get
  update:
    x-apievangelist-phrasing:
      intent: Search coupons across all customers
      effect: read
      questions:
      - How do I look up a coupon by its code without knowing which customer has it?
      - Can I find all redeemed or expired coupons in the program?
      - Which coupons are still unassigned to anyone?
      instructions:
      - text: Find the coupon with code {code}.
        slots:
          code: query.code
      - text: Search all coupons with status {status}, {limit} per page, page {page}.
        slots:
          status: query.status
          limit: query.limit
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/coupons'].get
  update:
    x-apievangelist-phrasing:
      intent: Filter coupons assigned to a customer
      effect: read
      questions:
      - Does a member hold a coupon with a particular code?
      - Can I filter a customer's assigned coupons by type or value?
      instructions:
      - text: Check whether customer {customer_id} has coupon code {code}.
        slots:
          customer_id: path.customer_id
          code: query.code
      - text: List customer {customer_id}'s assigned coupons of type {type} with status {status}.
        slots:
          customer_id: path.customer_id
          type: query.type
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/customers/{customer_id}/coupons'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's coupons
      effect: read
      questions:
      - What coupons does a specific loyalty member hold?
      - Can I sort a customer's coupons by expiration date or redemption date?
      instructions:
      - text: List the coupons belonging to customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show customer {customer_id}'s coupons matching {filter}, sorted by {sort}.
        slots:
          customer_id: path.customer_id
          filter: query.filter
          sort: query.sort
      method: generated
      generated: '2026-10-01'