# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Store Credits API
  version: 1.0.0
extends: openapi/lightspeed-store-credits-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: 9
- target: $.paths['/store_credits'].get
  update:
    x-apievangelist-phrasing:
      intent: List store credit customers and recent activity
      effect: read
      questions:
      - Which customers have store credit and what have they done with it lately?
      - Can I page through all store credit balances with recent transactions?
      instructions:
      - text: List store credit customers with balances and their latest transactions.
      - text: Show store credit usage for the store, {page_size} customers per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/store_credits/balances-bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Get store credit balances in bulk
      effect: read
      questions:
      - How do I get just the balances of all store credit customers in one call?
      - Is there a bulk lookup that skips the transaction history?
      instructions:
      - text: Fetch store credit balances in bulk without transaction history.
      - text: Get only the balance for every store credit customer.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/store_credits/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Get store credit customers and history in bulk
      effect: read
      questions:
      - Can I bulk-fetch store credit customers with their recent transaction lists?
      - What does the bulk store credit POST return besides balances?
      instructions:
      - text: Bulk-fetch store credit customers with balances and last transactions.
      - text: Run the bulk store credit lookup including each customer's transaction list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/store_credits/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the store credit report
      effect: read
      questions:
      - Where can I see a report of all store credit in my store?
      - Is there a summary report of outstanding store credit?
      instructions:
      - text: Get the store credit report.
      - text: Pull the report summarizing store credits.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/store_credits/{customerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer's store credit history
      effect: read
      questions:
      - What store credit operations has a particular customer had?
      - How do I see a customer's store credit history along with their balance?
      instructions:
      - text: Show the store credit history and balance for customer {customerId}.
        slots:
          customerId: path.customerId
      - text: List all store credit operations for customer {customerId}.
        slots:
          customerId: path.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/store_credits/{customerId}/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer's store credit balance
      effect: read
      questions:
      - How much store credit does this customer have left?
      - Can I check a customer's balance without the transaction history?
      instructions:
      - text: Get the store credit balance for customer {customerId}.
        slots:
          customerId: path.customerId
      - text: Tell me how much store credit customer {customerId} has.
        slots:
          customerId: path.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/store_credits/{customerId}/hold'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a temporary hold on store credit
      effect: write
      questions:
      - How do I temporarily reserve part of a customer's store credit before checkout?
      - Can I put a hold on store credit that I redeem later?
      instructions:
      - text: Hold {amount} of store credit for customer {customerId}.
        slots:
          amount: requestBody.amount
          customerId: path.customerId
      - text: Create a store credit hold of {amount} on customer {customerId} with client ID {client_id}.
        slots:
          amount: requestBody.amount
          customerId: path.customerId
          client_id: requestBody.client_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/store_credits/{customerId}/hold/reverse'].post
  update:
    x-apievangelist-phrasing:
      intent: Release a store credit hold
      effect: write
      questions:
      - How do I release a store credit hold if the customer abandons checkout?
      - Can I reverse a specific hold by its reference ID?
      instructions:
      - text: Reverse the store credit hold for customer {customerId}.
        slots:
          customerId: path.customerId
      - text: Release hold {reference_id} on customer {customerId}'s store credit.
        slots:
          reference_id: requestBody.reference_id
          customerId: path.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/store_credits/{customerId}/transactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue or redeem store credit
      effect: write
      questions:
      - How do I redeem part of a customer's store credit balance?
      - Can I issue store credit to a customer with a note?
      instructions:
      - text: Create a {type} store credit transaction of {amount} for customer {customerId} with client ID {client_id}.
        slots:
          type: requestBody.type
          amount: requestBody.amount
          customerId: path.customerId
          client_id: requestBody.client_id
      - text: Redeem {amount} from customer {customerId}'s store credit with note {notes}.
        slots:
          amount: requestBody.amount
          customerId: path.customerId
          notes: requestBody.notes
      method: generated
      generated: '2026-09-26'