# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Suppressions Bounces API
  version: 1.0.0
extends: openapi/sendgrid-bounces-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v3/suppression/bounces'].get
  update:
    x-apievangelist-phrasing:
      intent: List bounced email addresses
      effect: read
      questions:
      - Which addresses have bounced recently?
      - Can I limit the bounce list to a time window?
      - How do I check whether a specific email appears in my bounces?
      instructions:
      - text: List my bounces between {start_time} and {end_time}.
        slots:
          start_time: query.start_time
          end_time: query.end_time
      - text: Search the bounce list for {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/bounces'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many or all bounces
      effect: destructive
      questions:
      - Can I clear my entire bounce list in one go?
      - Is it possible to delete a selection of bounced addresses at once?
      instructions:
      - text: Delete all bounces by setting delete all to {delete_all}.
        slots:
          delete_all: requestBody.delete_all
      - text: 'Remove these addresses from my bounce list: {emails}.'
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/bounces/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the bounce for an email address
      effect: read
      questions:
      - Why did mail to a particular address bounce?
      - What bounce record exists for one email?
      instructions:
      - text: Get the bounce record for {email}.
        slots:
          email: path.email
      - text: Show why {email} bounced.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/bounces/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one address from bounces
      effect: destructive
      questions:
      - How do I remove a single address from my bounce list?
      - Can one bounced email be cleared so I can send to it again?
      instructions:
      - text: Delete the bounce for {email}.
        slots:
          email: path.email
      - text: Clear {email} from my bounce list.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/bounces/classifications'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily bounce totals by classification
      effect: read
      questions:
      - What kinds of bounces am I getting each day, by classification?
      - Can I export bounce classification totals as CSV?
      instructions:
      - text: Show bounce totals by classification from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Get daily bounce classification totals as {Accept}.
        slots:
          Accept: header.Accept
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/bounces/classifications/{classification}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily bounces for one classification
      effect: read
      questions:
      - How have bounces of one specific classification trended over time?
      - Can I break one bounce classification down by recipient domain?
      instructions:
      - text: Show daily {classification} bounces by domain.
        slots:
          classification: path.classification
      - text: Get {classification} bounce counts between {start_date} and {end_date}.
        slots:
          classification: path.classification
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-24'