# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Application-level workflows API
  version: 1.0.0
extends: openapi/nylas-application-level-workflows-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: 5
- target: $.paths['/v3/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List application-level email workflows
      effect: read
      questions:
      - Which automated email workflows are set up for my whole application?
      - How do I page through all app-level workflows?
      instructions:
      - text: List all application-level workflows.
      - text: Show the first {limit} app workflows.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application-level email workflow
      effect: write
      questions:
      - Can I automatically send a templated email when a trigger event happens across my app?
      - What do I need before I can create an app-wide workflow?
      instructions:
      - text: Create an app workflow {name} that sends template {template_id} on {trigger_event}.
        slots:
          name: requestBody.name
          template_id: requestBody.template_id
          trigger_event: requestBody.trigger_event
      - text: Add application workflow {name} using template {template_id} on {trigger_event} after a {delay} delay.
        slots:
          name: requestBody.name
          template_id: requestBody.template_id
          trigger_event: requestBody.trigger_event
          delay: requestBody.delay
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workflows/{workflow_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an application-level workflow
      effect: read
      questions:
      - How can I see the trigger and template an app workflow uses?
      - Can I look up an application workflow by its ID?
      instructions:
      - text: Get application workflow {workflow_id}.
        slots:
          workflow_id: path.workflow_id
      - text: Show the settings of app-level workflow {workflow_id}.
        slots:
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workflows/{workflow_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit or pause an application-level workflow
      effect: write
      questions:
      - Can I pause an app-wide workflow without deleting it?
      - How do I switch the template an application workflow sends?
      instructions:
      - text: Disable application workflow {workflow_id}.
        slots:
          workflow_id: path.workflow_id
      - text: Point app workflow {workflow_id} at template {template_id}.
        slots:
          workflow_id: path.workflow_id
          template_id: requestBody.template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/workflows/{workflow_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application-level workflow
      effect: destructive
      questions:
      - How do I remove an automated workflow from my application?
      - Can I delete an app-level workflow I no longer need?
      instructions:
      - text: Delete application workflow {workflow_id}.
        slots:
          workflow_id: path.workflow_id
      - text: Remove app-level workflow {workflow_id} permanently.
        slots:
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-09-26'