# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Emails API
  version: 1.0.0
extends: openapi/auth0-emails-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: 4
- target: $.paths['/emails/provider'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the email provider configuration
      effect: read
      questions:
      - Which email provider is my tenant sending verification and reset emails through?
      - What default from address is configured for outgoing emails?
      instructions:
      - text: Show me the email provider configuration.
      - text: Get the email provider settings, returning only {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/provider'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure an email provider
      effect: write
      questions:
      - How do I send my tenant's emails through my own SMTP or email service?
      - What credentials does setting up an email provider require?
      instructions:
      - text: Configure {name} as the email provider with credentials {credentials}.
        slots:
          name: requestBody.name
          credentials: requestBody.credentials
      - text: Set up email provider {name} using credentials {credentials} and from address {default_from_address}.
        slots:
          name: requestBody.name
          credentials: requestBody.credentials
          default_from_address: requestBody.default_from_address
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/provider'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the email provider
      effect: destructive
      questions:
      - How do I remove my custom email provider configuration?
      - Can I delete the email provider and stop using my own mail service?
      instructions:
      - text: Delete the email provider.
      - text: Remove the configured email provider from my tenant.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/provider'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the email provider settings
      effect: write
      questions:
      - Can I change the from address on my existing email provider?
      - How do I temporarily disable the configured email provider?
      instructions:
      - text: Change the email provider's from address to {default_from_address}.
        slots:
          default_from_address: requestBody.default_from_address
      - text: Set the existing email provider's enabled flag to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: Rotate the existing email provider credentials to {credentials}.
        slots:
          credentials: requestBody.credentials
      method: generated
      generated: '2026-10-01'