# 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 Customer Order Gift Cards API
  version: 1.0.0
extends: openapi/optimizely-customer-order-gift-cards-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/CustomerOrderGiftCards'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift cards applied to orders
      effect: read
      questions:
      - Which gift cards have been applied to customer orders in my Optimizely commerce admin?
      - Can I filter order gift card links to one order?
      instructions:
      - text: List all order gift card links.
      - text: List order gift cards matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderGiftCards'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a gift card to an order
      effect: write
      questions:
      - How do I attach a gift card to a customer order?
      - Can I link an existing gift card to an order record?
      instructions:
      - text: Apply gift card {giftCardId} to order {customerOrderId}.
        slots:
          giftCardId: requestBody.giftCardId
          customerOrderId: requestBody.customerOrderId
      - text: Link order {customerOrderId} to gift card {giftCardId}.
        slots:
          giftCardId: requestBody.giftCardId
          customerOrderId: requestBody.customerOrderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderGiftCards({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order gift card link
      effect: read
      questions:
      - Which order and gift card does a given link record connect?
      - How do I fetch one order gift card record by id?
      instructions:
      - text: Get order gift card record {id}.
        slots:
          id: path.id
      - text: Show which order and gift card link {id} ties together.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderGiftCards({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an order gift card link
      effect: write
      questions:
      - How do I overwrite an order gift card record entirely?
      - Can I replace both the order and gift card on an existing link?
      instructions:
      - text: Replace order gift card record {id} with order {customerOrderId} and gift card {giftCardId}.
        slots:
          id: path.id
          customerOrderId: requestBody.customerOrderId
          giftCardId: requestBody.giftCardId
      - text: Fully overwrite order gift card link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderGiftCards({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a gift card from an order
      effect: destructive
      questions:
      - How do I detach a gift card that was applied to an order?
      - Can I delete an order gift card link guarded by its ETag?
      instructions:
      - text: Delete order gift card record {id}.
        slots:
          id: path.id
      - text: Remove order gift card link {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/CustomerOrderGiftCards({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the gift card on an order link
      effect: write
      questions:
      - How do I swap the gift card on an existing order link?
      - Can I move a gift card link to a different order?
      instructions:
      - text: Change the gift card on link {id} to {giftCardId}.
        slots:
          id: path.id
          giftCardId: requestBody.giftCardId
      - text: Point order gift card link {id} at order {customerOrderId}.
        slots:
          id: path.id
          customerOrderId: requestBody.customerOrderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderGiftCards/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank default order gift card
      effect: read
      questions:
      - What does an empty order gift card record look like?
      - Is there a template for a new order gift card link?
      instructions:
      - text: Get the default template for a new order gift card link.
      - text: Show the blank order gift card object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerordergiftcards/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several order gift card links
      effect: destructive
      questions:
      - Can I remove multiple order gift card links at once?
      - How do I bulk-delete order gift card records by id?
      instructions:
      - text: Delete order gift card records {ids}.
        slots:
          ids: query.ids
      - text: Bulk-remove the order gift card links with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerordergiftcards({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order gift card custom property
      effect: read
      questions:
      - How do I read a custom property on an order gift card record?
      - Can order gift card links hold custom properties?
      instructions:
      - text: Get custom property {custompropertyKey} of order gift card {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show order gift card {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'