@quadratichq/developer-api-client

v0.25.19

Published

3 days ago

OpenAPI client for @quadratichq/developer-api-client

0High
0Medium
0Low

david.dimaria

quadratichqcom

@quadratichq/[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @quadratichq/developer-api-client --save

Next, try it out.

import {
  Configuration,
  AuthApi,
} from '@quadratichq/developer-api-client';
import type { GetMeRequest } from '@quadratichq/developer-api-client';

async function example() {
  console.log("🚀 Testing @quadratichq/developer-api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer_auth
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new AuthApi(config);

  try {
    const data = await api.getMe();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AuthApi | getMe | GET /v1/auth/me | Returns identity information derived from the API token that authorized this request. Useful for verifying a token works and discovering which team it belongs to. CellsApi | deleteCells | DELETE /v1/files/{file_id}/cells | Deletes the contents of every cell in the selection. CellsApi | getCells | GET /v1/files/{file_id}/cells | Reads cell values for a selection. Read-only; dispatches via `/mcp/query`. CellsApi | getCodeCell | GET /v1/files/{file_id}/cells/code | Fetches the source and computed value of a single code cell. CellsApi | getDependencies | GET /v1/files/{file_id}/cells/dependencies | Lists the formula / code-cell dependencies that flow into or out of the given position. CellsApi | getFormats | GET /v1/files/{file_id}/cells/formats | Reads cell formatting (font, color, alignment, etc.) for a selection. CellsApi | hasCellData | GET /v1/files/{file_id}/cells/has-data | Returns whether any cell in the selection contains data. CellsApi | mergeCells | POST /v1/files/{file_id}/cells/merge | Merges every cell in the selection into a single visual cell. CellsApi | moveCells | POST /v1/files/{file_id}/cells/move | Moves a rectangular block of cells to a new location. CellsApi | rerunCode | POST /v1/files/{file_id}/cells/code/rerun | Triggers re-execution of code cells in the file (or selection). CellsApi | setBorders | PUT /v1/files/{file_id}/cells/borders | Applies cell borders in batch. CellsApi | setCellValues | PUT /v1/files/{file_id}/cells | Writes a 2D block of values starting at `top_left_position`. CellsApi | setCodeCell | PUT /v1/files/{file_id}/cells/code | Creates or updates a Python / JavaScript / Formula code cell. CellsApi | setFormats | PUT /v1/files/{file_id}/cells/formats | Applies formatting to one or more cells in a single batch. CellsApi | setFormulaCells | PUT /v1/files/{file_id}/cells/formula | Writes one or more formula cells in a single batch. CellsApi | setSqlCell | PUT /v1/files/{file_id}/cells/sql | Creates or updates a SQL code cell backed by a registered connection. CellsApi | unmergeCells | DELETE /v1/files/{file_id}/cells/merge | Splits previously-merged cells back into individual cells. ColumnsAndRowsApi | deleteColumns | DELETE /v1/files/{file_id}/columns | Deletes the named columns from the sheet. ColumnsAndRowsApi | deleteRows | DELETE /v1/files/{file_id}/rows | Deletes the listed rows from the sheet. ColumnsAndRowsApi | insertColumns | POST /v1/files/{file_id}/columns | Inserts one or more columns at the given position. ColumnsAndRowsApi | insertRows | POST /v1/files/{file_id}/rows | Inserts one or more rows at the given position. ColumnsAndRowsApi | resizeColumns | PUT /v1/files/{file_id}/columns/size | Resizes one or more columns to the given pixel width. ColumnsAndRowsApi | resizeRows | PUT /v1/files/{file_id}/rows/size | Resizes one or more rows to the given pixel height. ColumnsAndRowsApi | setDefaultColumnWidth | PUT /v1/files/{file_id}/columns/default-size | Sets the default width for columns that haven't been individually resized. ColumnsAndRowsApi | setDefaultRowHeight | PUT /v1/files/{file_id}/rows/default-size | Sets the default height for rows that haven't been individually resized. ConditionalFormatsApi | getConditionalFormats | GET /v1/files/{file_id}/conditional-formats | Returns all conditional-format rules on a single sheet. ConditionalFormatsApi | updateConditionalFormats | PUT /v1/files/{file_id}/conditional-formats | Creates, updates, or deletes conditional-format rules on a sheet. Rules with `action: "delete"` only require the `id` field; `create` and `update` rules need a `selection` plus a formula (`rule`) or a `color_scale_thresholds` array. ConnectionsApi | getConnectionSchemas | POST /v1/connections/schemas | Fetches DB schemas from the connection service. Unlike the other endpoints this doesn't require a worker — it talks directly to the `quadratic-connection` service. ContextOutlineSearchApi | getContext | GET /v1/files/{file_id}/context | Returns a worker-built context blob (summary of sheets, tables, named ranges, etc.) suitable for feeding to LLMs. ContextOutlineSearchApi | getOutline | GET /v1/files/{file_id}/outline | Returns a structural outline of the file: sheets, named ranges, tables, and code cells. ContextOutlineSearchApi | readData | GET /v1/files/{file_id}/data | Reads a tabular slice of cell data, optimized for bulk consumption. ContextOutlineSearchApi | textSearch | GET /v1/files/{file_id}/search | Searches cell values (and optionally code-cell source) for matches. DocumentationApi | openapiSpec | GET /openapi.json | Serves the raw OpenAPI 3.1 spec for the developer API. The same spec is rendered as interactive HTML at `/docs`. FilesApi | createFile | POST /v1/files | Creates a new blank file. If `team_uuid` is omitted the file is created in the team the caller's API token is scoped to. FilesApi | getFile | GET /v1/files/{file_id} | Fetches metadata for a single file by UUID. FilesApi | importIntoFile | POST /v1/files/{file_id}/import | Imports bytes into an existing file. The file is updated in place; the response is the worker's import summary. FilesApi | importNewFile | POST /v1/files/import | REST-only convenience endpoint that creates a new blank file and imports the given bytes into it in a single request. FilesApi | listFiles | GET /v1/files | Lists files visible to the caller across every team they belong to. HealthApi | health | GET /health | HistoryApi | batch | POST /v1/files/{file_id}/batch | Executes a batch of actions sequentially, stopping on the first error. Mirrors the MCP `batch` semantics. The response is an array of `{action, result}` objects up to and including the failed action. HistoryApi | redo | POST /v1/files/{file_id}/redo | Re-applies the last `count` operations that were undone. HistoryApi | undo | POST /v1/files/{file_id}/undo | Reverts the last `count` operations on a file. SheetsApi | addSheet | POST /v1/files/{file_id}/sheets | Adds a new sheet to the file. SheetsApi | colorSheets | PATCH /v1/files/{file_id}/sheets/colors | Recolors one or more sheet tabs in a single call. SheetsApi | deleteSheet | DELETE /v1/files/{file_id}/sheets/{sheet_name} | Deletes a sheet by name. Files must always have at least one sheet, so the worker will reject deleting the last remaining sheet. SheetsApi | duplicateSheet | POST /v1/files/{file_id}/sheets/duplicate | Duplicates an existing sheet under a new name. SheetsApi | listSheets | GET /v1/files/{file_id}/sheets | Returns info for all sheets, or a single sheet when `sheet_name` is provided. Read-only; dispatches via the worker's `/mcp/query` route. SheetsApi | moveSheet | POST /v1/files/{file_id}/sheets/move | Reorders sheets within a file. SheetsApi | renameSheet | PATCH /v1/files/{file_id}/sheets/{sheet_name} | Renames a sheet. TablesApi | addTable | POST /v1/files/{file_id}/tables | Creates a new data table on the given sheet. TablesApi | convertToTable | POST /v1/files/{file_id}/tables/from-range | Converts a plain range of cells into a structured data table. TablesApi | tableColumnSettings | PUT /v1/files/{file_id}/tables/columns | Updates per-column settings (display name, sort, filter) on a table. TablesApi | tableMeta | PATCH /v1/files/{file_id}/tables | Updates table-level metadata (name, header visibility, alternating row colors, etc.). Only the fields you supply are changed. ValidationsApi | addListValidation | POST /v1/files/{file_id}/validations/list | Adds a list-of-values validation. Either `list_source_list` or `list_source_selection` must be supplied (but not both). ValidationsApi | addLogicalValidation | POST /v1/files/{file_id}/validations/logical | Adds a boolean (true/false) validation rule to a selection. ValidationsApi | listValidations | GET /v1/files/{file_id}/validations | Lists all data-validation rules on a file (or one sheet). ValidationsApi | removeValidation | DELETE /v1/files/{file_id}/validations | Removes any data-validation rule(s) covering the given selection.

Models

Authorization

Authentication schemes defined for the API:

bearer_auth

Type: HTTP Bearer Token authentication (API token (qdx_live_… or qdx_test_…))

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 0.25.20
Package version: 0.25.19
Generator version: 7.22.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Apache-2.0