Class DataTableColumns

Class providing methods for working with columns of Make data tables.

Index

Constructors

Methods

create delete get list reorder update

Constructors

constructor

new DataTableColumns(fetch: FetchFunction): DataTableColumns
Create a new DataTableColumns instance.
Parameters
- fetch: FetchFunction
  Function for making API requests
Returns DataTableColumns
- Defined in src/endpoints/data-table-columns.ts:151

Methods

create

create(
dataTableId: number,
body: CreateDataTableColumnBody,
): Promise<DataTableColumn>
Create a new column in a data table.
Parameters
- dataTableId: number
  The data table ID to create the column in
- body: CreateDataTableColumnBody
  The column definition
Returns Promise<DataTableColumn>
Promise with the created column
- Defined in src/endpoints/data-table-columns.ts:190

delete

delete(dataTableId: number, columnId: number): Promise<void>
Delete a column from a data table.
Parameters
- dataTableId: number
  The data table ID containing the column
- columnId: number
  The column ID to delete
Returns Promise<void>
Promise that resolves when the column is deleted
- Defined in src/endpoints/data-table-columns.ts:226

get

get(dataTableId: number, columnId: number): Promise<DataTableColumn>
Get a single column of a data table.
Parameters
- dataTableId: number
  The data table ID containing the column
- columnId: number
  The column ID to retrieve
Returns Promise<DataTableColumn>
Promise with the column
- Defined in src/endpoints/data-table-columns.ts:180

list

list(
dataTableId: number,
options?: ListDataTableColumnsOptions,
): Promise<DataTableColumn[]>
List columns of a data table.
Parameters
- dataTableId: number
  The data table ID to list columns from
- Optionaloptions: ListDataTableColumnsOptions
  Optional parameters for pagination and sorting
Returns Promise<DataTableColumn[]>
Promise with the list of columns
- Defined in src/endpoints/data-table-columns.ts:161

reorder

reorder(dataTableId: number, columnIds: number[]): Promise<DataTableColumn[]>
Reorder the columns of a data table.
Parameters
- dataTableId: number
  The data table ID to reorder columns in
- columnIds: number[]
  Column IDs in the desired order
Returns Promise<DataTableColumn[]>
Promise with the list of columns in the new order
- Defined in src/endpoints/data-table-columns.ts:238

update

update(
    dataTableId: number,
    columnId: number,
    body: Partial,
    options?: UpdateDataTableColumnOptions,
): Promise<DataTableColumn>
Update an existing column of a data table.
Parameters
- dataTableId: number
  The data table ID containing the column
- columnId: number
  The column ID to update
- body: Partial
  The column fields to update
- Optionaloptions: UpdateDataTableColumnOptions
  Optional parameters (e.g. force a lossy conversion)
Returns Promise<DataTableColumn>
Promise with the updated column
- Defined in src/endpoints/data-table-columns.ts:205