# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 Transactional Emails API
  version: 1.0.0
extends: openapi/getresponse-transactional-emails-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['/transactional-emails/{transactionalEmailId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transactional email
      effect: read
      questions:
      - What was sent in one specific transactional email?
      - Can I look up a transactional email's details by ID?
      instructions:
      - text: Show transactional email {transactionalEmailId}.
        slots:
          transactionalEmailId: path.transactionalEmailId
      - text: Get the details of the transactional email {transactionalEmailId} I sent.
        slots:
          transactionalEmailId: path.transactionalEmailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactional-emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactional emails
      effect: read
      questions:
      - Which transactional emails went out in a given period?
      - Can I filter transactional emails by tag?
      instructions:
      - text: List my transactional emails.
      - text: Show transactional emails sent between {from} and {to}.
        slots:
          from: query.query[sentOn][from]
          to: query.query[sentOn][to]
      - text: List transactional emails with tag {tagId}.
        slots:
          tagId: query.query[tagId]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactional-emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional email
      effect: write
      questions:
      - How do I send a one-off transactional email like a receipt?
      - Can I tag a transactional email when sending it?
      instructions:
      - text: Send a transactional email from {fromField} to {recipients} with content type {contentType}.
        slots:
          fromField: requestBody.fromField
          recipients: requestBody.recipients
          contentType: requestBody.contentType
      - text: Send a {contentType} transactional email to {recipients} from {fromField} tagged {tag}.
        slots:
          contentType: requestBody.contentType
          recipients: requestBody.recipients
          fromField: requestBody.fromField
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactional-emails/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get transactional email statistics
      effect: read
      questions:
      - How are my transactional emails performing overall?
      - Can I group transactional email stats by time period?
      instructions:
      - text: Show transactional email statistics grouped by {groupBy}.
        slots:
          groupBy: query.query[groupBy]
      - text: Get transactional email stats by {groupBy} from {from} to {to}.
        slots:
          groupBy: query.query[groupBy]
          from: query.query[timeFrame][from]
          to: query.query[timeFrame][to]
      method: generated
      generated: '2026-09-26'