# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Allowlist API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-allowlist-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/api/allowlist'].get
  update:
    x-apievangelist-phrasing:
      intent: List allowlist entries
      effect: read
      questions:
      - Which emails and domains are on my allowlist?
      - Can I filter allowlist entries to only domains?
      instructions:
      - text: List allowlist entries of type {type}.
        slots:
          type: query.type
      - text: Search the allowlist for {search}, page {page} of size {pageSize}.
        slots:
          search: query.search
          page: query.page
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/allowlist'].post
  update:
    x-apievangelist-phrasing:
      intent: Allowlist an email or domain
      effect: write
      questions:
      - How do I add a trusted email address or domain to the allowlist?
      - Can I allowlist a single domain?
      instructions:
      - text: Add an email or domain to the allowlist.
      - text: Create a single allowlist entry.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/allowlist/check'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an email or domain is allowlisted
      effect: read
      questions:
      - Is this email address already on the allowlist?
      - Can I verify whether a sender is allowlisted before acting?
      instructions:
      - text: Check whether {email} is allowlisted.
        slots:
          email: query.email
      - text: Confirm whether {email} is on the allowlist.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/allowlist/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-add allowlist entries
      effect: write
      questions:
      - Can I add many emails or domains to the allowlist at once?
      - What is the maximum number of allowlist entries per bulk request?
      instructions:
      - text: Bulk-add these entries to the allowlist.
      - text: Allowlist up to 1000 emails and domains in one go.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/allowlist/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an allowlist entry
      effect: destructive
      questions:
      - Can I remove an email or domain from the allowlist?
      - What happens when an allowlist entry is deleted?
      instructions:
      - text: Delete allowlist entry {id}.
        slots:
          id: path.id
      - text: Remove allowlist entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'