# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Manage Domains API
  version: 1.0.0
extends: openapi/nylas-manage-domains-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/v3/admin/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List my organization's email domains
      effect: read
      questions:
      - Which email domains are registered for my organization?
      - What do I need before I can list domains through the admin API?
      instructions:
      - text: List all registered email domains.
      - text: Show the first {limit} domains in my organization.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/admin/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new sending email domain
      effect: write
      questions:
      - How do I register a domain so I can send transactional email from it?
      - What has to happen after I add a domain before I can use it?
      instructions:
      - text: Register domain {domain_address} with label {name}.
        slots:
          domain_address: requestBody.domain_address
          name: requestBody.name
      - text: Add {domain_address} as a new email domain called {name}.
        slots:
          domain_address: requestBody.domain_address
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/admin/domains/{domain_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one registered domain
      effect: read
      questions:
      - Can I look up a single registered domain by its ID?
      - What details are stored for one of my email domains?
      instructions:
      - text: Get domain {domain_id}.
        slots:
          domain_id: path.domain_id
      - text: Show the record for email domain {domain_id}.
        slots:
          domain_id: path.domain_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/admin/domains/{domain_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a registered domain
      effect: write
      questions:
      - Can I change the label of a domain I already registered?
      - Which fields of a domain are editable after it's created?
      instructions:
      - text: Rename domain {domain_id} to {name}.
        slots:
          domain_id: path.domain_id
          name: requestBody.name
      - text: Set the display label of email domain {domain_id} to {name}.
        slots:
          domain_id: path.domain_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/admin/domains/{domain_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registered email domain
      effect: destructive
      questions:
      - How do I remove an email domain from my organization?
      - Is deleting a registered domain reversible?
      instructions:
      - text: Delete domain {domain_id}.
        slots:
          domain_id: path.domain_id
      - text: Remove email domain {domain_id} from my organization.
        slots:
          domain_id: path.domain_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/admin/domains/{domain_id}/info'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the DNS records a domain needs
      effect: read
      questions:
      - Which DNS records do I need to add at my DNS host to verify a domain?
      - Can I check the verification status of a domain for one record type?
      instructions:
      - text: Show the {type} DNS records needed for domain {domain_id}.
        slots:
          type: requestBody.type
          domain_id: path.domain_id
      - text: Get the {type} verification status and records for domain {domain_id}.
        slots:
          type: requestBody.type
          domain_id: path.domain_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/admin/domains/{domain_id}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a DNS verification check on a domain
      effect: write
      questions:
      - I've added the DNS records, how do I trigger verification of my domain?
      - Can I re-run the check for a single DNS record type after fixing it?
      instructions:
      - text: Verify the {type} records for domain {domain_id}.
        slots:
          type: requestBody.type
          domain_id: path.domain_id
      - text: Trigger a {type} DNS verification check on {domain_id} now.
        slots:
          type: requestBody.type
          domain_id: path.domain_id
      method: generated
      generated: '2026-09-26'