# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Brevo Transactional SMS API
  version: 1.0.0
extends: openapi/brevo-transactional-sms-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['/transactionalSMS/sms'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional SMS
      effect: write
      questions:
      - Can I send a one-time verification text to a phone number right away?
      - Can I tag a transactional SMS or set its type?
      instructions:
      - text: Send SMS {content} to {recipient} from {sender}.
        slots:
          content: requestBody.content
          recipient: requestBody.recipient
          sender: requestBody.sender
      - text: 'Text {recipient} from {sender}: {content}, tagged {tag}.'
        slots:
          recipient: requestBody.recipient
          sender: requestBody.sender
          content: requestBody.content
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactionalSMS/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional SMS asynchronously
      effect: write
      questions:
      - How do I send an order confirmation text to a customer's phone?
      - Why would my transactional SMS be treated as marketing?
      - Can I send an SMS from a stored template with parameters?
      instructions:
      - text: Text {recipient} from sender {sender} saying {content}.
        slots:
          recipient: requestBody.recipient
          sender: requestBody.sender
          content: requestBody.content
      - text: Send SMS template {templateId} to {recipient} from {sender} with params {params}.
        slots:
          templateId: requestBody.templateId
          recipient: requestBody.recipient
          sender: requestBody.sender
          params: requestBody.params
      method: generated
      generated: '2026-10-01'
- target: $.paths['/transactionalSMS/statistics/aggregatedReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total transactional SMS stats for a period
      effect: read
      questions:
      - How many transactional texts were delivered, bounced or replied to in total last month?
      - Can I get one summed SMS activity figure for a single tag?
      instructions:
      - text: Give me total transactional SMS counts from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Sum up SMS activity for tag {tag} over the past {days} days.
        slots:
          tag: query.tag
          days: query.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/transactionalSMS/statistics/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily transactional SMS stats
      effect: read
      questions:
      - What did my SMS delivery numbers look like day by day this week?
      - Can I see a per-day breakdown of texts for one tag, oldest day first?
      instructions:
      - text: Show my transactional SMS stats per day for the last {days} days.
        slots:
          days: query.days
      - text: Break down SMS activity by day for tag {tag} between {startDate} and {endDate}.
        slots:
          tag: query.tag
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/transactionalSMS/statistics/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List individual transactional SMS events
      effect: read
      questions:
      - Which texts to a specific phone number bounced, and why?
      - Can I read the replies people sent back to my transactional SMS?
      - What is the most SMS events I can fetch per page?
      instructions:
      - text: List every SMS event for {phoneNumber}.
        slots:
          phoneNumber: query.phoneNumber
      - text: Show the {event} SMS events from the last {days} days.
        slots:
          event: query.event
          days: query.days
      method: generated
      generated: '2026-10-01'