API Evangelist conversational phrasing for Hubspot Folders API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hubspot Folders API
  version: 1.0.0
extends: openapi/hubspot-folders-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 17
- target: $.paths['/cms/pages/2026-09/landing-pages/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List landing page folders
      effect: read
      questions:
      - How do I list all the folders my landing pages are organized into?
      - Can I filter landing page folders by when they were created or last updated?
      - Is there a way to include archived landing page folders in the listing?
      instructions:
      - text: List all of my landing page folders.
      - text: List landing page folders updated after {updatedAfter}, {limit} at a time.
        slots:
          updatedAfter: query.updatedAfter
          limit: query.limit
      - text: Show landing page folders sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/pages/2026-09/landing-pages/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a landing page folder
      effect: write
      questions:
      - How do I create a new folder to group my landing pages?
      - Can I nest a new landing page folder inside an existing parent folder?
      instructions:
      - text: Create a landing page folder called {name}.
        slots:
          name: requestBody.name
      - text: Create a landing page folder named {name} under parent folder {parentFolderId}.
        slots:
          name: requestBody.name
          parentFolderId: requestBody.parentFolderId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/pages/2026-09/landing-pages/folders/batch/read'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several landing page folders at once
      effect: write
      questions:
      - Can I look up a batch of landing page folders by their IDs in one call?
      - What's the fastest way to fetch details for many landing page folders together?
      instructions:
      - text: Fetch the landing page folders with IDs {inputs} in one batch.
        slots:
          inputs: requestBody.inputs
      - text: 'Batch-read landing page folders {inputs}, including archived ones: {archived}.'
        slots:
          inputs: requestBody.inputs
          archived: query.archived
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/pages/2026-09/landing-pages/folders/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one landing page folder
      effect: read
      questions:
      - How do I look up a single landing page folder by its ID?
      - What details does HubSpot return for one specific landing page folder?
      instructions:
      - text: Show me landing page folder {objectId}.
        slots:
          objectId: path.objectId
      - text: Get only the {property} property of landing page folder {objectId}.
        slots:
          property: query.property
          objectId: path.objectId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/pages/2026-09/landing-pages/folders/{objectId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a landing page folder
      effect: destructive
      questions:
      - Can I delete a landing page folder I no longer use?
      - What happens when I remove one of my landing page folders?
      instructions:
      - text: Delete landing page folder {objectId}.
        slots:
          objectId: path.objectId
      - text: Remove the landing page folder with ID {objectId}.
        slots:
          objectId: path.objectId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/pages/2026-09/landing-pages/folders/{objectId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a landing page folder
      effect: write
      questions:
      - How do I rename an existing landing page folder?
      - Can I move a landing page folder under a different parent folder?
      instructions:
      - text: Rename landing page folder {objectId} to {name}.
        slots:
          objectId: path.objectId
          name: requestBody.name
      - text: Move landing page folder {objectId} under parent folder {parentFolderId}.
        slots:
          objectId: path.objectId
          parentFolderId: requestBody.parentFolderId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/pages/2026-09/landing-pages/folders/{objectId}/revisions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a landing page folder's revision history
      effect: read
      questions:
      - Where can I see every earlier version of a landing page folder?
      - Does HubSpot keep a revision history for landing page folders?
      instructions:
      - text: List all previous versions of landing page folder {objectId}.
        slots:
          objectId: path.objectId
      - text: Show the last {limit} revisions of landing page folder {objectId}.
        slots:
          limit: query.limit
          objectId: path.objectId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/pages/2026-09/landing-pages/folders/{objectId}/revisions/{revisionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one past revision of a landing page folder
      effect: read
      questions:
      - Can I inspect exactly what a landing page folder looked like at a specific revision?
      - What did one particular earlier revision of my landing page folder contain?
      instructions:
      - text: Show revision {revisionId} of landing page folder {objectId}.
        slots:
          revisionId: path.revisionId
          objectId: path.objectId
      - text: Open past revision {revisionId} for folder {objectId} so I can compare it.
        slots:
          revisionId: path.revisionId
          objectId: path.objectId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/cms/pages/2026-09/landing-pages/folders/{objectId}/revisions/{revisionId}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a landing page folder to an earlier revision
      effect: write
      questions:
      - How do I roll a landing page folder back to an earlier version?
      - Can I undo changes to a landing page folder by restoring an old revision?
      instructions:
      - text: Restore landing page folder {objectId} to revision {revisionId}.
        slots:
          objectId: path.objectId
          revisionId: path.revisionId
      - text: Roll folder {objectId} back to its saved revision {revisionId}.
        slots:
          objectId: path.objectId
          revisionId: path.revisionId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/files/2026-03/folders/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search file manager folders
      effect: read
      questions:
      - How do I search my file manager folders by name?
      - Can I find all file folders that sit under a particular parent folder?
      - Does folder search in the file manager return hidden or archived folders?
      instructions:
      - text: Search my file manager for folders named {name}.
        slots:
          name: query.name
      - text: Find file folders inside parent folders {parentFolderIds}.
        slots:
          parentFolderIds: query.parentFolderIds
      - text: Search file folders created on or after {createdAtGte}, up to {limit} results.
        slots:
          createdAtGte: query.createdAtGte
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/files/2026-03/folders/update/async'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a file folder and all its children
      effect: write
      questions:
      - Can I rename a file folder and have the change cascade to everything inside it?
      - Which folder update runs in the background and applies to child folders too?
      instructions:
      - text: Start a background update renaming file folder {id} to {name}, including its children.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Asynchronously move file folder {id} and its contents under {parentFolderId}.
        slots:
          id: requestBody.id
          parentFolderId: requestBody.parentFolderId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/files/2026-03/folders/update/async/tasks/{taskId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a background folder update's status
      effect: read
      questions:
      - How can I tell whether my asynchronous file folder update has finished?
      - Is there a way to poll the progress of a recursive folder update task?
      instructions:
      - text: Check the status of folder update task {taskId}.
        slots:
          taskId: path.taskId
      - text: Tell me if background folder task {taskId} is complete yet.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/files/2026-03/folders/{folderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file folder by ID
      effect: read
      questions:
      - How do I look up a file manager folder when I know its ID?
      - What properties can I get back for one file folder by its numeric ID?
      instructions:
      - text: Get file manager folder {folderId}.
        slots:
          folderId: path.folderId
      - text: Show the {properties} of file folder ID {folderId}.
        slots:
          properties: query.properties
          folderId: path.folderId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/files/2026-03/folders/{folderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file folder by ID
      effect: destructive
      questions:
      - Can I delete a file manager folder using its ID?
      - What's the way to remove a file folder when I only have its numeric ID?
      instructions:
      - text: Delete file manager folder with ID {folderId}.
        slots:
          folderId: path.folderId
      - text: Remove file folder {folderId} from the file manager.
        slots:
          folderId: path.folderId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/files/2026-03/folders/{folderId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a single file folder
      effect: write
      questions:
      - How do I rename just one file manager folder right away?
      - Can I move a single file folder to a new parent without a background job?
      instructions:
      - text: Rename file folder {folderId} to {name} directly.
        slots:
          folderId: path.folderId
          name: requestBody.name
      - text: Move file folder {folderId} into parent folder {parentFolderId} now.
        slots:
          folderId: path.folderId
          parentFolderId: requestBody.parentFolderId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/files/2026-03/folders/{folderPath}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file folder by its path
      effect: read
      questions:
      - Can I look up a file manager folder by its path instead of its ID?
      - What does the file folder at a given path like /images/2026 contain in its metadata?
      instructions:
      - text: Get the file folder at path {folderPath}.
        slots:
          folderPath: path.folderPath
      - text: Show the {properties} of the folder located at {folderPath}.
        slots:
          properties: query.properties
          folderPath: path.folderPath
      method: generated
      generated: '2026-09-24'
- target: $.paths['/files/2026-03/folders/{folderPath}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file folder by its path
      effect: destructive
      questions:
      - Can I delete a file manager folder by giving its path?
      - Is it possible to remove a file folder without knowing its ID, only where it lives?
      instructions:
      - text: Delete the file folder at path {folderPath}.
        slots:
          folderPath: path.folderPath
      - text: Remove the folder located at {folderPath} from my file manager.
        slots:
          folderPath: path.folderPath
      method: generated
      generated: '2026-09-24'