# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Gift Card Transactions API
  version: 1.0.0
extends: openapi/optimizely-gift-card-transactions-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['/api/v1/admin/GiftCardTransactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift card transactions
      effect: read
      questions:
      - How do I see all gift card transactions in the commerce admin?
      - Can I filter gift card transactions by gift card or order?
      - How many gift card transactions happened in a date range?
      instructions:
      - text: List all gift card transactions.
      - text: Find gift card transactions matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the latest {top} gift card transactions ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/GiftCardTransactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a gift card transaction
      effect: write
      questions:
      - How do I log a gift card being used on an order?
      - Can I record the currency amount as well as the base amount?
      instructions:
      - text: Record a {amount} transaction on gift card {giftCardId} for order {customerOrderId}.
        slots:
          amount: requestBody.amount
          giftCardId: requestBody.giftCardId
          customerOrderId: requestBody.customerOrderId
      - text: Log gift card {giftCardId} usage of {amount} on {transactionDate}.
        slots:
          giftCardId: requestBody.giftCardId
          amount: requestBody.amount
          transactionDate: requestBody.transactionDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/GiftCardTransactions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a gift card transaction
      effect: read
      questions:
      - How do I look up a single gift card transaction?
      - Which order and amount does a given gift card transaction cover?
      instructions:
      - text: Get gift card transaction {id}.
        slots:
          id: path.id
      - text: Show the amount and order for gift card transaction {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/GiftCardTransactions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a gift card transaction
      effect: write
      questions:
      - How do I overwrite a gift card transaction record in full?
      - Does a full replace reset transaction fields I leave out?
      instructions:
      - text: Replace gift card transaction {id} with amount {amount} on gift card {giftCardId}.
        slots:
          id: path.id
          amount: requestBody.amount
          giftCardId: requestBody.giftCardId
      - text: Overwrite all fields of gift card transaction {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/GiftCardTransactions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a gift card transaction
      effect: destructive
      questions:
      - How do I delete a single gift card transaction?
      - Can I delete a transaction only if its ETag matches?
      instructions:
      - text: Delete gift card transaction {id}.
        slots:
          id: path.id
      - text: Delete gift card transaction {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/GiftCardTransactions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a gift card transaction
      effect: write
      questions:
      - How do I correct the amount on a gift card transaction?
      - Can I change which order a gift card transaction belongs to?
      instructions:
      - text: Change the amount of gift card transaction {id} to {amount}.
        slots:
          id: path.id
          amount: requestBody.amount
      - text: Link gift card transaction {id} to order {customerOrderId}.
        slots:
          id: path.id
          customerOrderId: requestBody.customerOrderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/GiftCardTransactions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default gift card transaction template
      effect: read
      questions:
      - What default values does a new gift card transaction start with?
      - Can I fetch a blank gift card transaction template?
      instructions:
      - text: Fetch the default gift card transaction template.
      - text: Show me the defaults for a new gift card transaction.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/giftcardtransactions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete gift card transactions
      effect: destructive
      questions:
      - How do I delete several gift card transactions at once?
      - Can I remove gift card transactions by a list of IDs?
      instructions:
      - text: Bulk delete gift card transactions {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these gift card transactions in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/giftcardtransactions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a gift card transaction
      effect: read
      questions:
      - How do I read a custom property stored on a gift card transaction?
      - Can I fetch one extra property from a gift card transaction?
      instructions:
      - text: Get custom property {custompropertyKey} on gift card transaction {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show gift card transaction {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'