API Evangelist conversational phrasing for Lusha API Documentation Companies Tables API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lusha API Documentation Companies Tables API
  version: 1.0.0
extends: openapi/lusha-companies-tables-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: 11
- target: $.paths['/v3/companies/tables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a companies table
      effect: write
      questions:
      - How do I start a new account list table in Lusha?
      - Can I seed a new companies table with company IDs when I create it?
      - Is creating a companies table free?
      instructions:
      - text: Create a companies table named {name} owned by {owner}.
        slots:
          name: requestBody.name
          owner: requestBody.owner
      - text: Create a companies table called {name} for {owner} seeded with companies {ids}.
        slots:
          name: requestBody.name
          owner: requestBody.owner
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List companies tables
      effect: read
      questions:
      - Which companies tables do I own or have shared with me?
      - Can I find an account list table by its name?
      - How do I page through all my companies tables?
      instructions:
      - text: List the companies tables owned by {owner}.
        slots:
          owner: requestBody.owner
      - text: Find companies tables for {owner} whose name matches {name}.
        slots:
          owner: requestBody.owner
          name: requestBody.name
      - text: List companies tables for {owner} with status {status}.
        slots:
          owner: requestBody.owner
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/{table_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a companies table and its status
      effect: read
      questions:
      - Is my companies table still processing?
      - What metadata does a single account table have?
      instructions:
      - text: Show the details of companies table {table_id}.
        slots:
          table_id: path.table_id
      - text: Check whether companies table {table_id} has finished processing.
        slots:
          table_id: path.table_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/{table_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a companies table
      effect: destructive
      questions:
      - How do I permanently delete a companies table?
      - Can a deleted account table be recovered?
      instructions:
      - text: Delete companies table {table_id} and all its data.
        slots:
          table_id: path.table_id
      - text: Permanently remove companies table {table_id} on behalf of {email}.
        slots:
          table_id: path.table_id
          email: query.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/{table_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename, archive or reassign a companies table
      effect: write
      questions:
      - How do I rename a companies table?
      - Can I archive an account table or change who owns it?
      - Can I change a companies table's visibility after creating it?
      instructions:
      - text: Rename companies table {table_id} to {name} as owner {owner}.
        slots:
          table_id: path.table_id
          name: requestBody.name
          owner: requestBody.owner
      - text: Archive companies table {table_id}, owned by {owner}.
        slots:
          table_id: path.table_id
          owner: requestBody.owner
      - text: Set the visibility of companies table {table_id} to {visibility} with owner {owner}.
        slots:
          table_id: path.table_id
          visibility: requestBody.visibility
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/{table_id}/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the rows of a companies table
      effect: read
      questions:
      - How do I export the rows and column values from a companies table?
      - Am I charged for reading rows out of an account table?
      - Can I page through a large companies table's rows?
      instructions:
      - text: Show the rows in companies table {table_id}.
        slots:
          table_id: path.table_id
      - text: Get page {page} of rows from companies table {table_id}, {size} per page.
        slots:
          page: query.page
          table_id: path.table_id
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/{table_id}/entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Add companies to a table
      effect: write
      questions:
      - How do I add more companies to an existing table?
      - How many company IDs can I add to a table in one call?
      - Does adding a company that's already in the table create a duplicate row?
      instructions:
      - text: Add companies {entityIds} to companies table {table_id} as owner {owner}.
        slots:
          entityIds: requestBody.entityIds
          table_id: path.table_id
          owner: requestBody.owner
      - text: 'Put these accounts into table {table_id}: {entityIds}, owner {owner}.'
        slots:
          table_id: path.table_id
          entityIds: requestBody.entityIds
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/{table_id}/entities'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove companies from a table
      effect: destructive
      questions:
      - How do I take specific companies out of a table without deleting the table?
      - Can I remove several account rows from a table at once?
      instructions:
      - text: Remove companies {entityIds} from companies table {table_id} as owner {owner}.
        slots:
          entityIds: requestBody.entityIds
          table_id: path.table_id
          owner: requestBody.owner
      - text: 'Drop these account rows from table {table_id}: {entityIds}, owner {owner}.'
        slots:
          table_id: path.table_id
          entityIds: requestBody.entityIds
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/{table_id}/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List the columns on a companies table
      effect: read
      questions:
      - What columns does my companies table have?
      - How many cells in each account table column are done or failed?
      instructions:
      - text: List the columns on companies table {table_id}.
        slots:
          table_id: path.table_id
      - text: Show column types and cell status counts for companies table {table_id}.
        slots:
          table_id: path.table_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/{table_id}/columns/{column_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a column from a companies table
      effect: destructive
      questions:
      - How do I delete a column and its data from a companies table?
      - Can I remove the default Lusha columns from an account table?
      instructions:
      - text: Remove column {column_id} from companies table {table_id}.
        slots:
          column_id: path.column_id
          table_id: path.table_id
      - text: Delete column {column_id} and all its cell data in companies table {table_id}.
        slots:
          column_id: path.column_id
          table_id: path.table_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/tables/{table_id}/columns/{column_id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Populate or refresh a companies table column
      effect: write
      questions:
      - How do I fill in a column's data for every row of a companies table?
      - Can I refresh an account table column for just a few rows?
      - How do I know when a column run on a companies table has finished?
      instructions:
      - text: Run column {column_id} on companies table {table_id} with scope {runScope} as owner {owner}.
        slots:
          column_id: path.column_id
          table_id: path.table_id
          runScope: requestBody.runScope
          owner: requestBody.owner
      - text: Refresh column {column_id} in companies table {table_id} for rows {entityIds}, scope {runScope}, owner {owner}.
        slots:
          column_id: path.column_id
          table_id: path.table_id
          entityIds: requestBody.entityIds
          runScope: requestBody.runScope
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'