# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Email Provider Configuration API
  version: 1.0.0
extends: openapi/strivacity-email-provider-configuration-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: 7
- target: $.paths['/admin/api/v1/instance/email/activeProvider'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the active email service provider
      effect: read
      questions:
      - Which email service provider is currently sending our emails?
      - Can I check the active email provider for the instance?
      instructions:
      - text: Show the active email service provider.
      - text: Get which email provider is in use right now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/email/activeProvider'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the active email service provider
      effect: write
      questions:
      - How do I switch the instance to a different email service provider?
      - Can I make a newly configured email provider the active one?
      instructions:
      - text: Set the active email service provider.
      - text: Switch outgoing email to a different configured provider.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/email/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List email service providers
      effect: read
      questions:
      - What email service providers are configured on my instance?
      - Can I search configured email providers by name?
      instructions:
      - text: List email service providers.
      - text: Find email service providers named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/email/providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email service provider
      effect: write
      questions:
      - How do I configure a new email service provider for sending notifications?
      - Can I add a second email provider configuration?
      instructions:
      - text: Create a new email service provider configuration.
      - text: Add an email provider for sending instance emails.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/email/providers/{providerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email service provider
      effect: read
      questions:
      - Can I view the settings of one configured email provider?
      - What is configured for a specific email service provider?
      instructions:
      - text: Get email service provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Show settings for email provider {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/email/providers/{providerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an email service provider
      effect: write
      questions:
      - How do I change the credentials of an existing email provider?
      - Can I edit an email service provider's configuration?
      instructions:
      - text: Update email service provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Change the configuration of email provider {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/email/providers/{providerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email service provider
      effect: destructive
      questions:
      - Can I delete an email service provider I no longer use?
      - What happens if I remove an email provider configuration?
      instructions:
      - text: Delete email service provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Remove email provider {providerId} from the instance.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'