# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for lemlist Deliverability alerts API
  version: 1.0.0
extends: openapi/lemlist-deliverability-alerts-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['/deliverability/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List my deliverability alerts
      effect: read
      questions:
      - Which deliverability alerts have I configured for my mailboxes?
      - What thresholds am I currently monitoring on bounce or spam rates?
      instructions:
      - text: List all my deliverability alerts.
      - text: Show every deliverability alert rule my team has set up.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deliverability/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deliverability alert
      effect: write
      questions:
      - How do I get notified when a mailbox's bounce rate crosses a threshold?
      - Can I scope a deliverability alert to specific domains?
      instructions:
      - text: Alert me at {severity} severity when {metric} on {widget} is {comparisonOperator} {threshold} over {periodDays} days ({periodMode}) for {scope}.
        slots:
          severity: requestBody.severity
          metric: requestBody.metric
          widget: requestBody.widget
          comparisonOperator: requestBody.comparisonOperator
          threshold: requestBody.threshold
          periodDays: requestBody.periodDays
          periodMode: requestBody.periodMode
          scope: requestBody.scope
      - text: Create a {metric} alert for mailboxes {scopeEntities} notifying via {channelConfig}.
        slots:
          metric: requestBody.metric
          scopeEntities: requestBody.scopeEntities
          channelConfig: requestBody.channelConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deliverability/alerts/{alertId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one deliverability alert
      effect: read
      questions:
      - What exactly does a particular deliverability alert check for?
      - Where can I see the threshold and channels on a single alert rule?
      instructions:
      - text: Show deliverability alert {alertId}.
        slots:
          alertId: path.alertId
      - text: Get the configuration of alert rule {alertId}.
        slots:
          alertId: path.alertId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deliverability/alerts/{alertId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deliverability alert
      effect: destructive
      questions:
      - Can I get rid of a deliverability alert I no longer need?
      - How do I remove an alert rule permanently rather than pausing it?
      instructions:
      - text: Delete deliverability alert {alertId}.
        slots:
          alertId: path.alertId
      - text: Remove alert rule {alertId} for good.
        slots:
          alertId: path.alertId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deliverability/alerts/{alertId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or pause a deliverability alert
      effect: write
      questions:
      - How do I change the threshold on an existing deliverability alert?
      - Can I temporarily pause an alert without deleting it?
      instructions:
      - text: Change the threshold of alert {alertId} to {threshold}.
        slots:
          alertId: path.alertId
          threshold: requestBody.threshold
      - text: Set alert {alertId} enabled to {enabled}.
        slots:
          alertId: path.alertId
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'