# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Connectors (Integrations) API
  version: 1.0.0
extends: openapi/nylas-connectors-integrations-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/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List my application's provider connectors
      effect: read
      questions:
      - Which email and calendar provider connectors are set up in my app?
      - How do I page through all the connectors in my application?
      instructions:
      - text: List all connectors in my application.
      - text: Show {limit} connectors starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up a connector for a provider
      effect: write
      questions:
      - What's the first step to let users authenticate with a new email provider?
      - How do I create a connector so my app can connect to an external service?
      instructions:
      - text: Create a new connector in my application.
      - text: Set up a provider connector for authentication.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connectors/{provider}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve the connector for a provider
      effect: read
      questions:
      - How can I see the settings and scopes of the connector for a given provider?
      - Can I check which credential is active on a provider's connector?
      instructions:
      - text: Get the {provider} connector.
        slots:
          provider: path.provider
      - text: Show the settings of my connector for {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connectors/{provider}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a provider connector
      effect: destructive
      questions:
      - What happens to existing grants if I delete a connector?
      - How do I remove a provider connector and its credentials?
      instructions:
      - text: Delete the {provider} connector.
        slots:
          provider: path.provider
      - text: Remove my connector for {provider} along with its credentials.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/connectors/{provider}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a connector's scopes or settings
      effect: write
      questions:
      - Can I change the OAuth scopes requested by a provider connector?
      - How do I switch which credential a connector uses?
      instructions:
      - text: Set the scopes on the {provider} connector to {scope}.
        slots:
          provider: path.provider
          scope: requestBody.scope
      - text: Make credential {active_credential_id} active on the {provider} connector.
        slots:
          active_credential_id: requestBody.active_credential_id
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/providers/detect'].post
  update:
    x-apievangelist-phrasing:
      intent: Detect a user's email provider from an address
      effect: read
      questions:
      - Can I figure out which email provider an address belongs to before authenticating?
      - Is there a rate limit on detecting providers by email?
      instructions:
      - text: Detect the email provider for {email}.
        slots:
          email: query.email
      - text: Find out which provider hosts the mailbox {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'