API Evangelist conversational phrasing for Email Template API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Email Template API
  version: 1.0.0
extends: openapi/conga-email-template-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: 12
- target: $.paths['/api/email/v1/email-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List email templates with filters
      effect: read
      questions:
      - Which email templates do we have, sorted by name?
      - Can I page through email templates filtered by a field value?
      instructions:
      - text: List email templates where {field} equals {value}.
        slots:
          field: query.searchBy
          value: query.searchValue
      - text: Show all email templates sorted by {sort}.
        slots:
          sort: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email template
      effect: write
      questions:
      - How do I create a new reusable email template?
      - What fields are required to save an email template?
      instructions:
      - text: Create an email template with subject {subject} and body {body} of type {type}.
        slots:
          subject: requestBody.Subject
          body: requestBody.Body
          type: requestBody.TemplateType
      - text: Add a new {type} email template named {name} with subject {subject} and body {body}.
        slots:
          type: requestBody.TemplateType
          name: requestBody.Name
          subject: requestBody.Subject
          body: requestBody.Body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/render'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview an unsaved email template
      effect: write
      questions:
      - Can I preview how a draft template renders before saving it?
      - Is it possible to merge record data into template HTML I have not stored yet?
      instructions:
      - text: Render this unsaved HTML body {html} with subject {subject} against record {record}.
        slots:
          html: requestBody.HtmlBody
          subject: requestBody.Subject
          record: requestBody.RecordId
      - text: Preview the draft template text {text} for recipient {recipient}.
        slots:
          text: requestBody.PlainTextBody
          recipient: requestBody.RecipientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search email templates by criteria
      effect: read
      questions:
      - What templates match a search criteria expression?
      - Can I run a criteria-based search across email templates?
      instructions:
      - text: Search email templates matching criteria {criteria}.
        slots:
          criteria: query.criteria
      - text: Find templates matching {criteria}, showing {size} per page.
        slots:
          criteria: query.criteria
          size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email template
      effect: read
      questions:
      - Where can I see the full details of one email template?
      - What subject and body does a specific template contain?
      instructions:
      - text: Get email template {id}.
        slots:
          id: path.id
      - text: Show me the contents of template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an email template
      effect: write
      questions:
      - How do I edit an existing email template's subject or body?
      - Can I deactivate a template by updating it?
      instructions:
      - text: Update template {id} with subject {subject}, body {body} and type {type}.
        slots:
          id: path.id
          subject: requestBody.Subject
          body: requestBody.Body
          type: requestBody.TemplateType
      - text: Change the body of existing template {id} to {body}.
        slots:
          id: path.id
          body: requestBody.Body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a file to an email template
      effect: write
      questions:
      - Can I add an attachment to a saved email template?
      - What file details are needed to attach a document to a template?
      instructions:
      - text: Attach file {name} to email template {id}.
        slots:
          name: requestBody.Name
          id: path.id
      - text: Upload {file} as an attachment of template {id} with MIME type {mime}.
        slots:
          file: requestBody.FileContent
          id: path.id
          mime: requestBody.MimeType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email template
      effect: destructive
      questions:
      - How do I remove an email template we no longer use?
      - Does deleting a template remove it permanently?
      instructions:
      - text: Delete email template {id}.
        slots:
          id: path.id
      - text: Remove the template {id} itself.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/{id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone an email template
      effect: write
      questions:
      - Can I duplicate an existing email template as a starting point?
      - Is there a quick way to copy a template?
      instructions:
      - text: Clone email template {id}.
        slots:
          id: path.id
      - text: Make a copy of template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/{id}/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all attachments from a template
      effect: destructive
      questions:
      - Can I strip every attachment from a template in one go?
      - How do I clear all files attached to an email template?
      instructions:
      - text: Delete every attachment on template {id}.
        slots:
          id: path.id
      - text: Clear all attached files from email template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/{id}/render'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a saved email template
      effect: write
      questions:
      - How do I see a stored template merged with a record's data?
      - Can I render a saved template for a specific recipient?
      instructions:
      - text: Render saved template {id} for record {record}.
        slots:
          id: path.id
          record: requestBody.RecordId
      - text: Merge stored template {id} with data for recipient {recipient}.
        slots:
          id: path.id
          recipient: requestBody.RecipientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-templates/{id}/{fileName}/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one attachment from a template
      effect: destructive
      questions:
      - Can I delete just a single named attachment from a template?
      - How do I drop one file from an email template's attachments?
      instructions:
      - text: Delete attachment {file} from template {id}.
        slots:
          file: path.fileName
          id: path.id
      - text: Remove the file {file} attached to email template {id}.
        slots:
          file: path.fileName
          id: path.id
      method: generated
      generated: '2026-10-01'