# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SMTP2GO IP Allow List API
  version: 1.0.0
extends: openapi/smtp2go-ip-allowlist-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['/ip_allow_list'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable an IP allow list
      effect: write
      questions:
      - How do I turn on IP allow listing for API access?
      - Can I disable the SMTP IP allow list?
      instructions:
      - text: Set the {type} IP allow list enabled to {enabled} for API key {api_key}.
        slots:
          type: requestBody.type
          enabled: requestBody.enabled
          api_key: requestBody.api_key
      - text: Enable IP allow listing using key {api_key}.
        slots:
          api_key: requestBody.api_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ip_allow_list/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an IP to an allow list
      effect: write
      questions:
      - How do I add a new IP address to my allow list?
      - Can I label an allow-listed IP with a description?
      instructions:
      - text: Add IP {ip_address} to the {type} allow list using key {api_key}.
        slots:
          ip_address: requestBody.ip_address
          type: requestBody.type
          api_key: requestBody.api_key
      - text: Allow-list {ip_address} described as {description} with key {api_key}.
        slots:
          ip_address: requestBody.ip_address
          description: requestBody.description
          api_key: requestBody.api_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ip_allow_list/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an allow-listed IP address
      effect: write
      questions:
      - How do I change an IP address that's already on my allow list?
      - Can I update the description of an allow-listed IP?
      instructions:
      - text: Change allow-listed IP {ip_address} to {new_ip_address} using key {api_key}.
        slots:
          ip_address: requestBody.ip_address
          new_ip_address: requestBody.new_ip_address
          api_key: requestBody.api_key
      - text: Update the description of allow-listed {ip_address} to {description} with key {api_key}.
        slots:
          ip_address: requestBody.ip_address
          description: requestBody.description
          api_key: requestBody.api_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ip_allow_list/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove an IP from an allow list
      effect: destructive
      questions:
      - How do I remove an IP address from my allow list?
      - Can I delete an IP from only the SMTP allow list?
      instructions:
      - text: Remove IP {ip_address} from the {type} allow list using key {api_key}.
        slots:
          ip_address: requestBody.ip_address
          type: requestBody.type
          api_key: requestBody.api_key
      - text: Take {ip_address} off the allow list with key {api_key}.
        slots:
          ip_address: requestBody.ip_address
          api_key: requestBody.api_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ip_allow_list/view'].post
  update:
    x-apievangelist-phrasing:
      intent: View an IP allow list and its status
      effect: read
      questions:
      - Which IP addresses are on my allow list, and is it enabled?
      - Can I see the API allow list separately from the SMTP one?
      instructions:
      - text: Show the {type} IP allow list using key {api_key}.
        slots:
          type: requestBody.type
          api_key: requestBody.api_key
      - text: List allow-listed IPs and their enabled status with key {api_key}.
        slots:
          api_key: requestBody.api_key
      method: generated
      generated: '2026-10-01'