API Evangelist conversational phrasing for Antavo Rewards API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Antavo Rewards API
  version: 1.0.0
extends: openapi/antavo-rewards-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: 17
- target: $.paths['/v1/bulk-operation/reward/claim/{batch_id}/status/error'].get
  update:
    x-apievangelist-phrasing:
      intent: List errors from a bulk reward claim
      effect: read
      questions:
      - Which customers failed to get the reward in my bulk claim batch?
      - Can I page through the errors from a mass reward claim?
      instructions:
      - text: Show the failed claims in bulk reward batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: List errors {limit} at a time from reward claim batch {batch_id}, starting at {offset}.
        slots:
          limit: query.limit
          batch_id: path.batch_id
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/bulk-operation/reward/claim/{batch_id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a bulk reward claim
      effect: read
      questions:
      - Is my bulk reward claim batch still processing or already done?
      - What is the overall completion status of a mass reward claim?
      instructions:
      - text: Check the processing status of bulk reward claim batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Tell me whether reward claim batch {batch_id} has finished.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/bulk-operation/reward/claim/{reward_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Claim one reward for many customers
      effect: write
      questions:
      - Can I give one reward to thousands of customers at once?
      - What is the maximum number of customers in a single bulk reward claim?
      instructions:
      - text: Bulk-claim reward {reward_id} for customers {customers}.
        slots:
          reward_id: path.reward_id
          customers: requestBody.customers
      - text: Claim reward {reward_id} for the batch {customers} and call {callback_url} when it completes.
        slots:
          reward_id: path.reward_id
          customers: requestBody.customers
          callback_url: requestBody.callback_url
      - text: Force the bulk claim of reward {reward_id} for {customers} with force_claim {force_claim}.
        slots:
          reward_id: path.reward_id
          customers: requestBody.customers
          force_claim: requestBody.force_claim
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/rewards/{reward_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show one reward available to a customer
      effect: read
      questions:
      - Can I see the details of a specific reward as a particular member would see it?
      - What does a single claimable reward look like for one customer?
      instructions:
      - text: Get reward {reward_id} as offered to customer {customer_id}.
        slots:
          reward_id: path.reward_id
          customer_id: path.customer_id
      - text: Show claimable reward {reward_id} for member {customer_id} with fields {fields}.
        slots:
          reward_id: path.reward_id
          customer_id: path.customer_id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/rewards'].get
  update:
    x-apievangelist-phrasing:
      intent: List rewards a customer can claim
      effect: read
      questions:
      - Which rewards can this loyalty member redeem right now?
      - Can I sort the rewards a customer is able to claim?
      instructions:
      - text: List the rewards customer {customer_id} can claim.
        slots:
          customer_id: path.customer_id
      - text: Show {limit} claimable rewards for customer {customer_id}, sorted by {sort} {order}.
        slots:
          limit: query.limit
          customer_id: path.customer_id
          sort: query.sort
          order: query.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/rewards'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's claimed rewards
      effect: read
      questions:
      - What rewards has this member already claimed?
      - Can I page through a customer's reward redemption history?
      instructions:
      - text: List the rewards customer {customer_id} has already claimed.
        slots:
          customer_id: path.customer_id
      - text: Show customer {customer_id}'s past reward claims ordered by {sort} {order}, {limit} per page.
        slots:
          customer_id: path.customer_id
          sort: query.sort
          order: query.order
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/rewards/{reward_id}/bid'].post
  update:
    x-apievangelist-phrasing:
      intent: Bid on an auction reward for a customer
      effect: write
      questions:
      - Can a member place a bid on an auction-style reward?
      - How is the bid amount worked out for a bidding reward?
      instructions:
      - text: Place a bid for customer {customer_id} on bidding reward {reward_id}.
        slots:
          customer_id: path.customer_id
          reward_id: path.reward_id
      - text: Bid {amount} for customer {customer_id} on auction reward {reward_id}.
        slots:
          amount: requestBody.amount
          customer_id: path.customer_id
          reward_id: path.reward_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/rewards/{reward_id}/claim'].post
  update:
    x-apievangelist-phrasing:
      intent: Claim a reward for a customer
      effect: write
      questions:
      - How do I redeem a reward on behalf of a loyalty member?
      - Can a customer claim several of the same reward in one go?
      instructions:
      - text: Claim reward {reward_id} for customer {customer_id}.
        slots:
          reward_id: path.reward_id
          customer_id: path.customer_id
      - text: Redeem {count} of reward {reward_id} for member {customer_id}.
        slots:
          count: requestBody.count
          reward_id: path.reward_id
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/rewards/{reward_id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a customer's reward claim
      effect: destructive
      questions:
      - Can I undo a reward a customer already claimed?
      - Is there a way to take back a reward that was claimed by mistake?
      instructions:
      - text: Revoke customer {customer_id}'s claim on reward {reward_id}.
        slots:
          customer_id: path.customer_id
          reward_id: path.reward_id
      - text: Cancel reward {reward_id} claimed by member {customer_id}, referencing claim event {event}.
        slots:
          reward_id: path.reward_id
          customer_id: path.customer_id
          event: requestBody.event
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/rewards/reward/{entity_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a loyalty reward's details
      effect: read
      questions:
      - How do I see all the settings of one reward in my loyalty program?
      - What parameters does a single reward carry when I fetch it by ID?
      instructions:
      - text: Get the full details of reward {entity_id}.
        slots:
          entity_id: path.entity_id
      - text: Show me the configuration of loyalty reward {entity_id}.
        slots:
          entity_id: path.entity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/rewards/reward/{entity_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update attributes of a reward
      effect: write
      questions:
      - Can I change an attribute on a reward that already exists in Antavo?
      - Which endpoint edits an existing loyalty reward's attributes?
      instructions:
      - text: Update the attributes of reward {entity_id}.
        slots:
          entity_id: path.entity_id
      - text: Edit existing loyalty reward {entity_id} with new attribute values.
        slots:
          entity_id: path.entity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/rewards/reward/{entity_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a deactivated reward
      effect: destructive
      questions:
      - How do I archive a reward that is no longer active?
      - Will members still see a reward after it has been archived?
      instructions:
      - text: Archive inactive reward {entity_id} so members can no longer see it.
        slots:
          entity_id: path.entity_id
      - text: Remove deactivated loyalty reward {entity_id} from the catalog by archiving it.
        slots:
          entity_id: path.entity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/rewards/reward'].get
  update:
    x-apievangelist-phrasing:
      intent: List all rewards in the catalog
      effect: read
      questions:
      - Which rewards are configured in my loyalty program, regardless of customer?
      - Can I list only the rewards offered at certain stores?
      instructions:
      - text: List every reward entity in the program.
      - text: List the reward entities available at stores {stores}.
        slots:
          stores: query.stores
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/rewards/reward'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a new loyalty reward
      effect: write
      questions:
      - Can I add a new reward to my loyalty program through the API?
      - What endpoint creates a reward members can claim?
      instructions:
      - text: Create a new reward in the loyalty program.
      - text: Add a brand-new loyalty reward to the rewards catalog.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rewards/{reward_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a reward on the rewards endpoint
      effect: read
      questions:
      - Can I fetch one reward item by its reward ID without naming a customer?
      - What reward-specific information is returned for a single reward item?
      instructions:
      - text: Look up reward item {reward_id}.
        slots:
          reward_id: path.reward_id
      - text: Fetch the reward-specific info for reward {reward_id} from the rewards endpoint.
        slots:
          reward_id: path.reward_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rewards'].get
  update:
    x-apievangelist-phrasing:
      intent: List reward items by price range
      effect: read
      questions:
      - Can I find rewards priced between a minimum and maximum?
      - Which reward item matches a given external ID?
      instructions:
      - text: List reward items priced between {min_price} and {max_price}.
        slots:
          min_price: query.min_price
          max_price: query.max_price
      - text: Find the reward item with external ID {external_id}.
        slots:
          external_id: query.external_id
      - text: Show page {page} of reward items for customer {customer}, {limit} per page.
        slots:
          page: query.page
          customer: query.customer
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rewards/{reward_id}/claim'].post
  update:
    x-apievangelist-phrasing:
      intent: Claim a reward via the deprecated endpoint
      effect: write
      questions:
      - Is the old rewards claim endpoint still supported?
      - Where does the deprecated reward claim call record which customer claimed it?
      instructions:
      - text: Register that customer {customer} claimed reward {reward_id} using the deprecated claim endpoint.
        slots:
          customer: requestBody.customer
          reward_id: path.reward_id
      - text: Use the legacy claim call to record reward {reward_id} for {customer} with external ID {external_id}.
        slots:
          reward_id: path.reward_id
          customer: requestBody.customer
          external_id: requestBody.external_id
      method: generated
      generated: '2026-10-01'