# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Lists API
  version: 1.0.0
extends: openapi/nylas-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: 8
- target: $.paths['/v3/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List all lists in the application
      effect: read
      questions:
      - What domain, TLD and email address lists have I created for my rules?
      - Can I page through every list my application has?
      instructions:
      - text: Show all lists in my application.
      - text: List my application's lists, {limit} at a time.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a list of domains, TLDs or addresses
      effect: write
      questions:
      - How do I create a blocklist of email domains for my agent account rules?
      - Can I change a list's type after I create it?
      - What kinds of values can a new list hold?
      instructions:
      - text: Create a list named {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Make a new {type} list called {name} described as {description}.
        slots:
          type: requestBody.type
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/lists/{list_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one list's details
      effect: read
      questions:
      - What's the type and item count of a specific list?
      - Can I look up one list by its ID?
      instructions:
      - text: Show list {list}.
        slots:
          list: path.list_id
      - text: Get the details of list {list}.
        slots:
          list: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/lists/{list_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a list
      effect: write
      questions:
      - Can I rename an existing list without changing its type?
      - Which fields of a list can be edited after creation?
      instructions:
      - text: Rename list {list} to {name}.
        slots:
          list: path.list_id
          name: requestBody.name
      - text: Change the description of list {list} to {description}.
        slots:
          list: path.list_id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/lists/{list_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a list and all its items
      effect: destructive
      questions:
      - What happens to rules that reference a list after I delete it?
      - Is deleting a whole list reversible?
      instructions:
      - text: Delete list {list} and everything in it.
        slots:
          list: path.list_id
      - text: Remove the entire list {list} permanently.
        slots:
          list: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/lists/{list_id}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the values in a list
      effect: read
      questions:
      - Which domains or addresses are currently in a given list?
      - How can I page through the entries of one list?
      instructions:
      - text: Show the items in list {list}.
        slots:
          list: path.list_id
      - text: List up to {limit} entries from list {list}.
        slots:
          limit: query.limit
          list: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/lists/{list_id}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add values to a list
      effect: write
      questions:
      - How do I add more domains to an existing list?
      - Are values I add to a list normalized or de-duplicated?
      instructions:
      - text: Add {items} to list {list}.
        slots:
          items: requestBody.items
          list: path.list_id
      - text: Append these entries {items} to list {list}.
        slots:
          items: requestBody.items
          list: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/lists/{list_id}/items'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove specific values from a list
      effect: destructive
      questions:
      - Can I take a few addresses out of a list without deleting the list?
      - What's the maximum number of items I can remove from a list in one request?
      instructions:
      - text: Remove {items} from list {list}.
        slots:
          items: requestBody.items
          list: path.list_id
      - text: Take these entries {items} out of list {list} but keep the list.
        slots:
          items: requestBody.items
          list: path.list_id
      method: generated
      generated: '2026-09-26'