# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Ingress Email API
  version: 1.0.0
extends: openapi/conga-email-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['/v1/Email/Delivery/Sign/{correlationId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a signing package URL for delivery
      effect: write
      questions:
      - Can I turn a merged document into an e-signature package link for email delivery?
      - Which signing provider will the generated sign package use?
      instructions:
      - text: Generate a sign package URL for merge {correlationId}.
        slots:
          correlationId: path.correlationId
      - text: Create a signing link for request {correlationId} using provider {signProvider}.
        slots:
          correlationId: path.correlationId
          signProvider: query.signProvider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Email/Merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge an email template with record data
      effect: write
      questions:
      - Can I fill an email template with Salesforce data from the original merge?
      - How do I render an email template using the JSON payload of a merge request?
      instructions:
      - text: Merge the email template for merge request {correlationId}.
        slots:
          correlationId: query.correlationId
      - text: Populate the email template with data from merge {correlationId}.
        slots:
          correlationId: query.correlationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Email/Mock/Delivery/Sign/{correlationId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Mock generating a signing package URL
      effect: write
      questions:
      - Is there a mock version of sign package generation for testing?
      - Can I test the sign-package flow without creating a real package?
      instructions:
      - text: Run a mock sign package generation for {correlationId}.
        slots:
          correlationId: path.correlationId
      - text: Test-generate a fake signing link for {correlationId} with provider {signProvider}.
        slots:
          correlationId: path.correlationId
          signProvider: query.signProvider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Email/Mock/Send'].post
  update:
    x-apievangelist-phrasing:
      intent: Mock sending an email with attachments
      effect: write
      questions:
      - Can I dry-run an email send and get back JSON instead of delivering it?
      - Is there a mock endpoint for testing email delivery with attachments?
      instructions:
      - text: Mock-send an email to {address} with subject "{subject}".
        slots:
          address: requestBody.EmailTo.Address
          subject: requestBody.EmailSubject
      - text: Do a test email send to {address} without delivering it.
        slots:
          address: requestBody.EmailTo.Address
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Email/Send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an email with attachments
      effect: write
      questions:
      - How do I email generated documents as attachments to a recipient?
      - Can I CC and BCC people on a delivery email?
      - Is there a sandbox flag for sending delivery emails?
      instructions:
      - text: Send an email to {address} with subject "{subject}" and the attachments.
        slots:
          address: requestBody.EmailTo.Address
          subject: requestBody.EmailSubject
      - text: Email {address}, CC {cc}, with the body "{body}".
        slots:
          address: requestBody.EmailTo.Address
          cc: requestBody.EmailCC
          body: requestBody.EmailTextBody
      method: generated
      generated: '2026-10-01'