# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Rules API
  version: 1.0.0
extends: openapi/nylas-rules-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: 6
- target: $.paths['/v3/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List my application's email rules
      effect: read
      questions:
      - Which inbound and outbound email rules are defined for my app?
      - How do I page through all of my rules?
      instructions:
      - text: List all email rules.
      - text: Show the first {limit} rules.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an inbound or outbound email rule
      effect: write
      questions:
      - Can I automatically act on incoming mail from a particular sender domain?
      - How do I set up a rule that runs on outbound sends before they reach the provider?
      instructions:
      - text: Create a rule {name} matching {match} that applies {actions}.
        slots:
          name: requestBody.name
          match: requestBody.match
          actions: requestBody.actions
      - text: Add an {trigger} rule named {name} with conditions {match} and actions {actions}.
        slots:
          trigger: requestBody.trigger
          name: requestBody.name
          match: requestBody.match
          actions: requestBody.actions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/rules/{rule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one email rule
      effect: read
      questions:
      - How can I see the conditions and actions of a specific rule?
      - Can I look up a rule by its ID?
      instructions:
      - text: Get rule {rule_id}.
        slots:
          rule_id: path.rule_id
      - text: Show the conditions and actions of rule {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/rules/{rule_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit or disable an email rule
      effect: write
      questions:
      - Can I temporarily turn off a rule without deleting it?
      - Is it possible to change a rule's priority?
      instructions:
      - text: Disable rule {rule_id}.
        slots:
          rule_id: path.rule_id
      - text: Set the priority of rule {rule_id} to {priority}.
        slots:
          rule_id: path.rule_id
          priority: requestBody.priority
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/rules/{rule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email rule
      effect: destructive
      questions:
      - What happens to policies that reference a rule after I delete it?
      - How do I permanently remove a rule?
      instructions:
      - text: Delete rule {rule_id}.
        slots:
          rule_id: path.rule_id
      - text: Permanently remove email rule {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/rule-evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: See which rules ran on a user's mail
      effect: read
      questions:
      - How can I audit which rules were evaluated against a user's incoming messages?
      - Can I see the outcome of rule checks on a specific grant's sends?
      instructions:
      - text: List rule evaluations for grant {grant_id}.
        slots:
          grant_id: path.grant_id
      - text: Show the latest {limit} rule evaluation records for mailbox {grant_id}.
        slots:
          limit: query.limit
          grant_id: path.grant_id
      method: generated
      generated: '2026-09-26'