# 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 Wish List Products API
  version: 1.0.0
extends: openapi/optimizely-wish-list-products-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/WishListProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List products on wish lists
      effect: read
      questions:
      - How do I see every product saved on customers' wish lists?
      - Can I filter wish list products to a single wish list?
      - Which products appear most often across wish lists?
      instructions:
      - text: List all wish list products.
      - text: Find wish list products matching {filter}.
        slots:
          filter: query.$filter
      - text: Group wish list products using {apply}.
        slots:
          apply: query.$apply
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListProducts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product to a wish list
      effect: write
      questions:
      - How do I add a product to a customer's wish list?
      - Can I set a quantity and note when saving a product to a wish list?
      instructions:
      - text: Add product {productId} to wish list {wishListId} in {unitOfMeasure} with note {notes}.
        slots:
          productId: requestBody.productId
          wishListId: requestBody.wishListId
          unitOfMeasure: requestBody.unitOfMeasure
          notes: requestBody.notes
      - text: Save {qtyOrdered} {unitOfMeasure} of product {productId} to wish list {wishListId}, noting {notes}.
        slots:
          qtyOrdered: requestBody.qtyOrdered
          unitOfMeasure: requestBody.unitOfMeasure
          productId: requestBody.productId
          wishListId: requestBody.wishListId
          notes: requestBody.notes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListProducts({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a wish list product
      effect: read
      questions:
      - How do I look up one wish list line by ID?
      - What quantity and notes are saved on a specific wish list item?
      instructions:
      - text: Get wish list product {id}.
        slots:
          id: path.id
      - text: Show the quantity and notes on wish list item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListProducts({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a wish list product
      effect: write
      questions:
      - How do I overwrite a wish list item record entirely?
      - Does replacing a wish list item require unit of measure and notes?
      instructions:
      - text: Replace wish list item {id} with unit {unitOfMeasure} and notes {notes}.
        slots:
          id: path.id
          unitOfMeasure: requestBody.unitOfMeasure
          notes: requestBody.notes
      - text: Overwrite every field of wish list item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListProducts({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a product from a wish list
      effect: destructive
      questions:
      - How do I take a product off a wish list?
      - Can I delete a wish list item only if its ETag matches?
      instructions:
      - text: Delete wish list item {id}.
        slots:
          id: path.id
      - text: Delete wish list item {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/WishListProducts({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a wish list product
      effect: write
      questions:
      - How do I change the quantity of a product on a wish list?
      - Can I edit just the notes on a wish list item?
      instructions:
      - text: Set the quantity on wish list item {id} to {qtyOrdered}.
        slots:
          id: path.id
          qtyOrdered: requestBody.qtyOrdered
      - text: Update the notes on wish list item {id} to {notes}.
        slots:
          id: path.id
          notes: requestBody.notes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListProducts/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default wish list product template
      effect: read
      questions:
      - What default values does a new wish list item start with?
      - Can I fetch a blank wish list product template?
      instructions:
      - text: Fetch the default wish list product template.
      - text: Show me the defaults for a new wish list item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistproducts/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove wish list products
      effect: destructive
      questions:
      - How do I remove several products from wish lists at once?
      - Can I delete wish list items by a list of IDs?
      instructions:
      - text: Bulk delete wish list items {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these wish list items in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistproducts({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a wish list product
      effect: read
      questions:
      - How do I read a custom property stored on a wish list item?
      - Can I fetch one extra property from a wish list product?
      instructions:
      - text: Get custom property {custompropertyKey} on wish list item {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show wish list item {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'