# 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 Shares API
  version: 1.0.0
extends: openapi/optimizely-wish-list-shares-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/WishListShares'].get
  update:
    x-apievangelist-phrasing:
      intent: List wish list shares
      effect: read
      questions:
      - How do I see which wish lists have been shared and with whom in Optimizely Configured Commerce?
      - Can I filter wish list shares to ones not yet activated?
      instructions:
      - text: List all wish list shares.
      - text: List wish list shares matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListShares'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a wish list with someone
      effect: write
      questions:
      - Can I share a wish list with a person by email?
      - What share token is needed to record a new wish list share?
      instructions:
      - text: Share wish list {wishListId} with {email} using token {shareToken}.
        slots:
          wishListId: requestBody.wishListId
          email: requestBody.email
          shareToken: requestBody.shareToken
      - text: Create a wish list share for user profile {userProfileId} with email {email} and token {shareToken}.
        slots:
          userProfileId: requestBody.userProfileId
          email: requestBody.email
          shareToken: requestBody.shareToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListShares({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one wish list share
      effect: read
      questions:
      - How can I check the details of a single wish list share?
      - Can I expand the wish list when reading one share?
      instructions:
      - text: Show wish list share {id}.
        slots:
          id: path.id
      - text: Get wish list share {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListShares({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a wish list share
      effect: write
      questions:
      - Can I overwrite a wish list share record with new values?
      - What's the call to fully replace a share entry?
      instructions:
      - text: Replace wish list share {id} with email {email} and token {shareToken}.
        slots:
          id: path.id
          email: requestBody.email
          shareToken: requestBody.shareToken
      - text: Overwrite share {id} entirely to point at wish list {wishListId}.
        slots:
          id: path.id
          wishListId: requestBody.wishListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListShares({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing a wish list
      effect: destructive
      questions:
      - How do I revoke a wish list share?
      - Can I delete a share only if its ETag is unchanged?
      instructions:
      - text: Delete wish list share {id}.
        slots:
          id: path.id
      - text: Delete share {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/WishListShares({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a wish list share
      effect: write
      questions:
      - Can I mark an existing wish list share as activated?
      - How do I change the email on a share without replacing it?
      instructions:
      - text: Patch wish list share {id} to set activated to {activated}.
        slots:
          id: path.id
          activated: requestBody.activated
      - text: Update share {id} email to {email}.
        slots:
          id: path.id
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListShares/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a wish list share
      effect: read
      questions:
      - What defaults are pre-filled for a new wish list share?
      - Is there a blank share template?
      instructions:
      - text: Get the default wish list share template.
      - text: Show pre-filled values for a new wish list share.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistshares/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several wish list shares
      effect: destructive
      questions:
      - Can I bulk revoke many wish list shares?
      - How do I delete a list of shares in one request?
      instructions:
      - text: Bulk delete wish list shares {ids}.
        slots:
          ids: query.ids
      - text: Remove every share listed in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistshares({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a wish list share
      effect: read
      questions:
      - Can I read a custom property stored on a wish list share?
      - Where are custom attributes on a share kept?
      instructions:
      - text: Get custom property {custompropertyKey} on wish list share {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show share {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'