# 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 Mail archive API
  version: 1.0.0
extends: openapi/optimizely-mail-archive-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: 4
- target: $.paths['/{clientId}/mailarchive/{bmMailId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one archived mailing
      effect: read
      questions:
      - How do I see metadata for a single archived email sent to a recipient?
      - When was a specific archived mailing created and what type was it?
      instructions:
      - text: Get archive details for mail {bmMailId} in client {clientId}.
        slots:
          bmMailId: path.bmMailId
          clientId: path.clientId
      - text: Show the mailing type and creation time of archived mail {bmMailId} for client {clientId}.
        slots:
          bmMailId: path.bmMailId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/mailarchive'].get
  update:
    x-apievangelist-phrasing:
      intent: Search archived mailings
      effect: read
      questions:
      - Which emails were archived for a given recipient address?
      - Can I filter archived mailings by date range and mailing type?
      - Can I list only double opt-in confirmation mails by opt-in status?
      instructions:
      - text: List archived mails for client {clientId} sent to {recipientAddress}.
        slots:
          clientId: path.clientId
          recipientAddress: query.recipientAddress
      - text: Find archived mails for client {clientId} created between {from} and {until}.
        slots:
          clientId: path.clientId
          from: query.from
          until: query.until
      - text: Show archived mails of mailing {mailingId} for client {clientId}.
        slots:
          mailingId: query.mailingId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/mailarchive/{bmMailId}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an archived mailing's content
      effect: read
      questions:
      - How do I retrieve the actual content of an archived email?
      - Can I download an archived mailing as EML or HTML, compressed?
      instructions:
      - text: Download the content of archived mail {bmMailId} for client {clientId}.
        slots:
          bmMailId: path.bmMailId
          clientId: path.clientId
      - text: Get archived mail {bmMailId} for client {clientId} as {mailFormat}.
        slots:
          bmMailId: path.bmMailId
          clientId: path.clientId
          mailFormat: query.mailFormat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/mailarchive/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Bulk download archived mailing contents
      effect: read
      questions:
      - How do I export the contents of many archived emails at once?
      - Can I get a compressed bundle of archived mails for one recipient?
      instructions:
      - text: Download a compressed file of archived mail contents for client {clientId} from {from} to {until}.
        slots:
          clientId: path.clientId
          from: query.from
          until: query.until
      - text: Export the archived mail contents sent to {recipientAddress} for client {clientId} as a zip.
        slots:
          recipientAddress: query.recipientAddress
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'