# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely Campaign REST Recipient lists API
  version: 1.0.0
extends: openapi/optimizely-recipient-lists-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: 6
- target: $.paths['/{clientId}/recipientlists'].get
  update:
    x-apievangelist-phrasing:
      intent: List all recipient lists
      effect: read
      questions:
      - Which recipient lists does my Optimizely Campaign client have and how many recipients are in each?
      - Can I include test lists when listing recipient lists?
      - How do I sort my recipient lists?
      instructions:
      - text: List all recipient lists for client {clientId}.
        slots:
          clientId: path.clientId
      - text: 'List recipient lists for client {clientId} including test lists: {includeTestLists}.'
        slots:
          clientId: path.clientId
          includeTestLists: query.includeTestLists
      - text: Show {limit} recipient lists for client {clientId} sorted by {sort}.
        slots:
          limit: query.limit
          clientId: path.clientId
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/recipientlists'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a recipient list
      effect: write
      questions:
      - How do I duplicate an existing recipient list?
      - Can I make a copy of a recipient list to experiment with?
      instructions:
      - text: Copy recipient list {sourceRecipientListId} in client {clientId}.
        slots:
          sourceRecipientListId: requestBody.sourceRecipientListId
          clientId: path.clientId
      - text: Duplicate recipient list {sourceRecipientListId}.
        slots:
          sourceRecipientListId: requestBody.sourceRecipientListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/recipientlists/{recipientListId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one recipient list
      effect: read
      questions:
      - How many recipients are on a specific recipient list?
      - Is a particular recipient list suitable for sending, and what is its description?
      instructions:
      - text: Get recipient list {recipientListId} for client {clientId}.
        slots:
          recipientListId: path.recipientListId
          clientId: path.clientId
      - text: Show the recipient count and description of list {recipientListId}.
        slots:
          recipientListId: path.recipientListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/recipientlists/{recipientListId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a recipient list's name or test flag
      effect: write
      questions:
      - Can I rename a recipient list or change its description?
      - How do I mark a recipient list as a test list?
      instructions:
      - text: Rename recipient list {recipientListId} in client {clientId} to {name}.
        slots:
          recipientListId: path.recipientListId
          clientId: path.clientId
          name: requestBody.name
      - text: 'Set recipient list {recipientListId} as a test list: {testList}.'
        slots:
          recipientListId: path.recipientListId
          testList: requestBody.testList
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/recipientlists/{recipientListId}/attributeNames'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recipient list's attribute names
      effect: read
      questions:
      - What attribute names can I use for personalization on a recipient list?
      - Which attributes are defined on a given recipient list?
      instructions:
      - text: Get the attribute names of recipient list {recipientListId} in client {clientId}.
        slots:
          recipientListId: path.recipientListId
          clientId: path.clientId
      - text: List attribute names for recipient list {recipientListId}.
        slots:
          recipientListId: path.recipientListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/recipientlists/{recipientListId}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recipient list's fields
      effect: read
      questions:
      - What fields does a recipient list store for each recipient?
      - Can I see the field definitions of a recipient list?
      instructions:
      - text: Get the fields of recipient list {recipientListId} in client {clientId}.
        slots:
          recipientListId: path.recipientListId
          clientId: path.clientId
      - text: Show the field definitions on recipient list {recipientListId}.
        slots:
          recipientListId: path.recipientListId
      method: generated
      generated: '2026-09-26'