# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Folders API
  version: 1.0.0
extends: openapi/nylas-folders-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/grants/{grant_id}/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List a mailbox's folders and labels
      effect: read
      questions:
      - What folders or labels exist in this user's mailbox?
      - Can I include hidden folders for Microsoft accounts?
      - How can I list only the child folders under a parent?
      instructions:
      - text: List all folders for grant {grant}.
        slots:
          grant: path.grant_id
      - text: Show subfolders of {parent_id} for {grant}.
        slots:
          parent_id: query.parent_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a mail folder or label
      effect: write
      questions:
      - How do I create a new folder or label in someone's mailbox?
      - Can I set a label color when creating a Gmail folder?
      instructions:
      - text: Create a folder named {name} for grant {grant}.
        slots:
          name: requestBody.name
          grant: path.grant_id
      - text: Create folder {name} under {parent_id} on {grant}.
        slots:
          name: requestBody.name
          parent_id: requestBody.parent_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/folders/{folder_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one folder
      effect: read
      questions:
      - What are the details of a specific mail folder?
      - Can I look up a single folder by its ID?
      instructions:
      - text: Show folder {folder} for grant {grant}.
        slots:
          folder: path.folder_id
          grant: path.grant_id
      - text: Get the details of folder {folder} on {grant}.
        slots:
          folder: path.folder_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/folders/{folder_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename, move or recolor a folder
      effect: write
      questions:
      - Can I rename an existing mail folder?
      - Is it possible to move a folder under a different parent?
      instructions:
      - text: Rename folder {folder} on grant {grant} to {name}.
        slots:
          folder: path.folder_id
          grant: path.grant_id
          name: requestBody.name
      - text: Move folder {folder} under {parent_id} for {grant}.
        slots:
          folder: path.folder_id
          parent_id: requestBody.parent_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/folders/{folder_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a mail folder
      effect: destructive
      questions:
      - How do I delete a folder or label from a mailbox?
      - Can I remove a folder shared from another user's mailbox?
      instructions:
      - text: Delete folder {folder} from grant {grant}.
        slots:
          folder: path.folder_id
          grant: path.grant_id
      - text: Remove the mail folder {folder} on {grant}.
        slots:
          folder: path.folder_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'