# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Provider Config API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-provider-config-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: 8
- target: $.paths['/api/provider-configs'].get
  update:
    x-apievangelist-phrasing:
      intent: List email provider configurations
      effect: read
      questions:
      - Which mailbox provider settings are configured?
      - Can I see only the enabled email provider configurations?
      instructions:
      - text: List email provider configurations where enabled is {enabled}.
        slots:
          enabled: query.enabled
      - text: Show all mail provider configs with enabled set to {enabled}.
        slots:
          enabled: query.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/provider-configs/resolve'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the email provider for an address
      effect: read
      questions:
      - Which mail provider handles a given email address's domain?
      - Can I detect the provider settings to use for an address?
      instructions:
      - text: Resolve the email provider for {email}.
        slots:
          email: query.email
      - text: Tell me which mail provider config applies to {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/provider-configs/{provider}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one email provider configuration
      effect: read
      questions:
      - What settings are stored for a particular mail provider?
      - Can I view one provider configuration by its key?
      instructions:
      - text: Get the configuration for provider {provider}.
        slots:
          provider: path.provider
      - text: Show mail provider settings for {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/provider-configs/{provider}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a provider configuration
      effect: write
      questions:
      - How do I add or change settings for a mail provider?
      - Will saving a provider config overwrite the existing one?
      instructions:
      - text: Upsert the configuration for provider {provider}.
        slots:
          provider: path.provider
      - text: Save new mail provider settings for {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/provider-configs/{provider}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a provider configuration
      effect: destructive
      questions:
      - Can I remove a mail provider configuration entirely?
      - What if a provider config is obsolete and should go away?
      instructions:
      - text: Delete the configuration for provider {provider}.
        slots:
          provider: path.provider
      - text: Remove mail provider config {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/provider-configs/{provider}/toggle'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a provider configuration
      effect: write
      questions:
      - Can I switch a mail provider configuration off without deleting it?
      - How do I re-enable a disabled provider config?
      instructions:
      - text: Toggle provider configuration {provider} on or off.
        slots:
          provider: path.provider
      - text: Disable mail provider {provider} for now.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/provider-configs/{provider}/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a domain to a provider configuration
      effect: write
      questions:
      - Can I tell the system that a custom email domain is hosted by a certain provider?
      - How are domains mapped onto a mail provider config?
      instructions:
      - text: Add a domain mapping to provider {provider}.
        slots:
          provider: path.provider
      - text: Map another email domain to provider config {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/provider-configs/{provider}/domains/{pattern}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain mapping from a provider
      effect: destructive
      questions:
      - Can I unmap a domain pattern from a mail provider?
      - Does removing a domain mapping need the match type?
      instructions:
      - text: Remove domain pattern {pattern} with match type {matchType} from provider {provider}.
        slots:
          pattern: path.pattern
          matchType: query.matchType
          provider: path.provider
      - text: Unmap {pattern} ({matchType} match) from its provider config.
        slots:
          pattern: path.pattern
          matchType: query.matchType
      method: generated
      generated: '2026-10-01'