@deeptable/deeptable 0.1.0-alpha.1 → 0.1.0-alpha.2

package/src/resources/structured-sheets/structured-sheets.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as ExportsAPI from './exports';
-import { Exports } from './exports';
+import * as TablesAPI from './tables';
+import { TableDownloadParams, TableListResponse, TableResponse, TableRetrieveParams, Tables } from './tables';
 import { APIPromise } from '../../core/api-promise';
 import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
@@ -10,7 +10,7 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class StructuredSheets extends APIResource {
-  exports: ExportsAPI.Exports = new ExportsAPI.Exports(this._client);
+  tables: TablesAPI.Tables = new TablesAPI.Tables(this._client);
 
   /**
    * Start converting a spreadsheet workbook into structured data. This initiates an
@@ -19,13 +19,13 @@ export class StructuredSheets extends APIResource {
    *
    * @example
    * ```ts
-   * const structuredSheetResponse =
+   * const structuredSheetsResponse =
    *   await client.structuredSheets.create({
    *     file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
    *   });
    * ```
    */
-  create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetResponse> {
+  create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetsResponse> {
     return this._client.post('/v1/structured-sheets', { body, ...options });
   }
 
@@ -34,13 +34,13 @@ export class StructuredSheets extends APIResource {
    *
    * @example
    * ```ts
-   * const structuredSheetResponse =
+   * const structuredSheetsResponse =
    *   await client.structuredSheets.retrieve(
-   *     'ss_01abc2def3ghjkmnpqrs4uvwxy',
+   *     'ss_01kfxgjd94fn9stqm42nejb627',
    *   );
    * ```
    */
-  retrieve(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetResponse> {
+  retrieve(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetsResponse> {
     return this._client.get(path`/v1/structured-sheets/${structuredSheetsID}`, options);
   }
 
@@ -51,7 +51,7 @@ export class StructuredSheets extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const structuredSheetResponse of client.structuredSheets.list()) {
+   * for await (const structuredSheetsResponse of client.structuredSheets.list()) {
    *   // ...
    * }
    * ```
@@ -59,8 +59,8 @@ export class StructuredSheets extends APIResource {
   list(
     query: StructuredSheetListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<StructuredSheetResponsesCursorIDPage, StructuredSheetResponse> {
-    return this._client.getAPIList('/v1/structured-sheets', CursorIDPage<StructuredSheetResponse>, {
+  ): PagePromise<StructuredSheetsResponsesCursorIDPage, StructuredSheetsResponse> {
+    return this._client.getAPIList('/v1/structured-sheets', CursorIDPage<StructuredSheetsResponse>, {
       query,
       ...options,
     });
@@ -73,7 +73,7 @@ export class StructuredSheets extends APIResource {
    * @example
    * ```ts
    * await client.structuredSheets.delete(
-   *   'ss_01abc2def3ghjkmnpqrs4uvwxy',
+   *   'ss_01kfxgjd94fn9stqm42nejb627',
    * );
    * ```
    */
@@ -83,16 +83,64 @@ export class StructuredSheets extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Cancel a structured sheets conversion that is in progress. Only jobs with status
+   * 'queued' or 'in_progress' can be cancelled.
+   *
+   * @example
+   * ```ts
+   * const structuredSheetsResponse =
+   *   await client.structuredSheets.cancel(
+   *     'ss_01kfxgjd94fn9stqm42nejb627',
+   *   );
+   * ```
+   */
+  cancel(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetsResponse> {
+    return this._client.post(path`/v1/structured-sheets/${structuredSheetsID}/cancel`, options);
+  }
+
+  /**
+   * Download the structured data in the specified format. Only available when
+   * conversion status is 'completed'.
+   *
+   * Available formats:
+   *
+   * - `sqlite`: SQLite database containing all extracted tables
+   * - `cell_labels`: CSV file with cell-level semantic labels
+   *
+   * @example
+   * ```ts
+   * const response = await client.structuredSheets.download(
+   *   'ss_01kfxgjd94fn9stqm42nejb627',
+   * );
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
+   */
+  download(
+    structuredSheetsID: string,
+    query: StructuredSheetDownloadParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Response> {
+    return this._client.get(path`/v1/structured-sheets/${structuredSheetsID}/download`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/x-sqlite3' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
 }
 
-export type StructuredSheetResponsesCursorIDPage = CursorIDPage<StructuredSheetResponse>;
+export type StructuredSheetsResponsesCursorIDPage = CursorIDPage<StructuredSheetsResponse>;
 
 /**
  * Response representing a structured sheets conversion job.
  *
  * This is returned from POST (create), GET (retrieve), and list endpoints.
  */
-export interface StructuredSheetResponse {
+export interface StructuredSheetsResponse {
   /**
    * The unique identifier for this structured sheets conversion.
    */
@@ -111,22 +159,17 @@ export interface StructuredSheetResponse {
   /**
    * The current processing status.
    */
-  status: 'pending' | 'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
+  status: 'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
 
   /**
    * The timestamp when the conversion was last updated.
    */
   updated_at: string;
 
-  /**
-   * List of export formats available for download (e.g., ['sqlite']).
-   */
-  exports_available?: Array<string>;
-
   /**
    * Error information when processing fails.
    */
-  last_error?: StructuredSheetResponse.LastError | null;
+  last_error?: StructuredSheetsResponse.LastError | null;
 
   /**
    * The object type, which is always 'structured_sheet'.
@@ -137,9 +180,15 @@ export interface StructuredSheetResponse {
    * List of sheet names included in this conversion.
    */
   sheet_names?: Array<string>;
+
+  /**
+   * Number of tables extracted from the workbook. Only present when status is
+   * 'completed'.
+   */
+  table_count?: number | null;
 }
 
-export namespace StructuredSheetResponse {
+export namespace StructuredSheetsResponse {
   /**
    * Error information when processing fails.
    */
@@ -170,15 +219,29 @@ export interface StructuredSheetCreateParams {
 
 export interface StructuredSheetListParams extends CursorIDPageParams {}
 
-StructuredSheets.Exports = Exports;
+export interface StructuredSheetDownloadParams {
+  /**
+   * The export format to download.
+   */
+  format?: 'sqlite' | 'cell_labels';
+}
+
+StructuredSheets.Tables = Tables;
 
 export declare namespace StructuredSheets {
   export {
-    type StructuredSheetResponse as StructuredSheetResponse,
-    type StructuredSheetResponsesCursorIDPage as StructuredSheetResponsesCursorIDPage,
+    type StructuredSheetsResponse as StructuredSheetsResponse,
+    type StructuredSheetsResponsesCursorIDPage as StructuredSheetsResponsesCursorIDPage,
     type StructuredSheetCreateParams as StructuredSheetCreateParams,
     type StructuredSheetListParams as StructuredSheetListParams,
+    type StructuredSheetDownloadParams as StructuredSheetDownloadParams,
   };
 
-  export { Exports as Exports };
+  export {
+    Tables as Tables,
+    type TableResponse as TableResponse,
+    type TableListResponse as TableListResponse,
+    type TableRetrieveParams as TableRetrieveParams,
+    type TableDownloadParams as TableDownloadParams,
+  };
 }

package/src/resources/structured-sheets/tables.ts

@@ -0,0 +1,189 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Tables extends APIResource {
+  /**
+   * Get details of a specific table extracted from the structured sheet. Only
+   * available when conversion status is 'completed'.
+   *
+   * @example
+   * ```ts
+   * const tableResponse =
+   *   await client.structuredSheets.tables.retrieve(
+   *     'tbl_01kfxgjd94fn9stqm45rqr2pnz',
+   *     {
+   *       structured_sheets_id: 'ss_01kfxgjd94fn9stqm42nejb627',
+   *     },
+   *   );
+   * ```
+   */
+  retrieve(
+    tableID: string,
+    params: TableRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<TableResponse> {
+    const { structured_sheets_id } = params;
+    return this._client.get(path`/v1/structured-sheets/${structured_sheets_id}/tables/${tableID}`, options);
+  }
+
+  /**
+   * List all tables extracted from the structured sheet. Only available when
+   * conversion status is 'completed'.
+   *
+   * @example
+   * ```ts
+   * const tables = await client.structuredSheets.tables.list(
+   *   'ss_01kfxgjd94fn9stqm42nejb627',
+   * );
+   * ```
+   */
+  list(structuredSheetsID: string, options?: RequestOptions): APIPromise<TableListResponse> {
+    return this._client.get(path`/v1/structured-sheets/${structuredSheetsID}/tables`, options);
+  }
+
+  /**
+   * Download the table data in the specified format.
+   *
+   * Available formats:
+   *
+   * - `parquet`: Apache Parquet columnar format (recommended for data analysis)
+   * - `csv`: Comma-separated values (compatible with any spreadsheet application)
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.structuredSheets.tables.download(
+   *     'tbl_01kfxgjd94fn9stqm45rqr2pnz',
+   *     {
+   *       structured_sheets_id: 'ss_01kfxgjd94fn9stqm42nejb627',
+   *     },
+   *   );
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
+   */
+  download(tableID: string, params: TableDownloadParams, options?: RequestOptions): APIPromise<Response> {
+    const { structured_sheets_id, ...query } = params;
+    return this._client.get(path`/v1/structured-sheets/${structured_sheets_id}/tables/${tableID}/download`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/vnd.apache.parquet' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+}
+
+/**
+ * Response representing a table extracted from a structured sheet.
+ *
+ * This is returned from GET (retrieve) and list table endpoints. Table names use
+ * SQL naming conventions (e.g., monthly_head_count).
+ */
+export interface TableResponse {
+  /**
+   * The unique identifier for this table.
+   */
+  id: string;
+
+  /**
+   * The timestamp when this table was created.
+   */
+  created_at: string;
+
+  /**
+   * The name of the table using SQL naming conventions.
+   */
+  name: string;
+
+  /**
+   * The original Excel sheet name this table came from.
+   */
+  sheet_name: string;
+
+  /**
+   * Normalized sheet name for use in SQLite table names and export filenames
+   * (lowercase, snake_case).
+   */
+  sheet_name_normalized: string;
+
+  /**
+   * The ID of the structured sheet this table belongs to.
+   */
+  structured_sheet_id: string;
+
+  /**
+   * The type of table (relational, aggregation, or tableless).
+   */
+  type: 'relational' | 'aggregation' | 'tableless';
+
+  /**
+   * The object type, which is always 'table'.
+   */
+  object?: 'table';
+}
+
+/**
+ * Paginated response for listing tables from a structured sheet.
+ *
+ * Uses cursor-based pagination for efficient iteration through results.
+ */
+export interface TableListResponse {
+  /**
+   * List of tables.
+   */
+  data: Array<TableResponse>;
+
+  /**
+   * Whether there are more results available after this page.
+   */
+  has_more: boolean;
+
+  /**
+   * Unique identifier for a table.
+   */
+  first_id?: string | null;
+
+  /**
+   * Unique identifier for a table.
+   */
+  last_id?: string | null;
+
+  /**
+   * The object type, which is always 'list'.
+   */
+  object?: 'list';
+}
+
+export interface TableRetrieveParams {
+  /**
+   * The unique identifier of the structured sheets conversion.
+   */
+  structured_sheets_id: string;
+}
+
+export interface TableDownloadParams {
+  /**
+   * Path param: The unique identifier of the structured sheets conversion.
+   */
+  structured_sheets_id: string;
+
+  /**
+   * Query param: The format to download the table data in.
+   */
+  format?: 'parquet' | 'csv';
+}
+
+export declare namespace Tables {
+  export {
+    type TableResponse as TableResponse,
+    type TableListResponse as TableListResponse,
+    type TableRetrieveParams as TableRetrieveParams,
+    type TableDownloadParams as TableDownloadParams,
+  };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-alpha.1'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.2'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.1";
+export declare const VERSION = "0.1.0-alpha.2";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.1";
+export declare const VERSION = "0.1.0-alpha.2";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-alpha.1'; // x-release-please-version
+exports.VERSION = '0.1.0-alpha.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0-alpha.1'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/resources/structured-sheets/exports.d.mts

@@ -1,22 +0,0 @@
-import { APIResource } from "../../core/resource.mjs";
-import { APIPromise } from "../../core/api-promise.mjs";
-import { RequestOptions } from "../../internal/request-options.mjs";
-export declare class Exports extends APIResource {
-    /**
-     * Download the structured data as a SQLite database file. Only available when
-     * conversion status is 'completed'.
-     *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.structuredSheets.exports.downloadSqlite(
-     *     'ss_01abc2def3ghjkmnpqrs4uvwxy',
-     *   );
-     *
-     * const content = await response.blob();
-     * console.log(content);
-     * ```
-     */
-    downloadSqlite(structuredSheetsID: string, options?: RequestOptions): APIPromise<Response>;
-}
-//# sourceMappingURL=exports.d.mts.map

package/resources/structured-sheets/exports.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"exports.d.mts","sourceRoot":"","sources":["../../src/resources/structured-sheets/exports.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAO3F"}

package/resources/structured-sheets/exports.d.ts

@@ -1,22 +0,0 @@
-import { APIResource } from "../../core/resource.js";
-import { APIPromise } from "../../core/api-promise.js";
-import { RequestOptions } from "../../internal/request-options.js";
-export declare class Exports extends APIResource {
-    /**
-     * Download the structured data as a SQLite database file. Only available when
-     * conversion status is 'completed'.
-     *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.structuredSheets.exports.downloadSqlite(
-     *     'ss_01abc2def3ghjkmnpqrs4uvwxy',
-     *   );
-     *
-     * const content = await response.blob();
-     * console.log(content);
-     * ```
-     */
-    downloadSqlite(structuredSheetsID: string, options?: RequestOptions): APIPromise<Response>;
-}
-//# sourceMappingURL=exports.d.ts.map

package/resources/structured-sheets/exports.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../src/resources/structured-sheets/exports.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAO3F"}

package/resources/structured-sheets/exports.js

@@ -1,33 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Exports = void 0;
-const resource_1 = require("../../core/resource.js");
-const headers_1 = require("../../internal/headers.js");
-const path_1 = require("../../internal/utils/path.js");
-class Exports extends resource_1.APIResource {
-    /**
-     * Download the structured data as a SQLite database file. Only available when
-     * conversion status is 'completed'.
-     *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.structuredSheets.exports.downloadSqlite(
-     *     'ss_01abc2def3ghjkmnpqrs4uvwxy',
-     *   );
-     *
-     * const content = await response.blob();
-     * console.log(content);
-     * ```
-     */
-    downloadSqlite(structuredSheetsID, options) {
-        return this._client.get((0, path_1.path) `/v1/structured-sheets/${structuredSheetsID}/exports/sqlite`, {
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: 'application/x-sqlite3' }, options?.headers]),
-            __binaryResponse: true,
-        });
-    }
-}
-exports.Exports = Exports;
-//# sourceMappingURL=exports.js.map

package/resources/structured-sheets/exports.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"exports.js","sourceRoot":"","sources":["../../src/resources/structured-sheets/exports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,kBAA0B,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,kBAAkB,iBAAiB,EAAE;YACxF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,uBAAuB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC9E,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AAvBD,0BAuBC"}

package/resources/structured-sheets/exports.mjs

@@ -1,29 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../core/resource.mjs";
-import { buildHeaders } from "../../internal/headers.mjs";
-import { path } from "../../internal/utils/path.mjs";
-export class Exports extends APIResource {
-    /**
-     * Download the structured data as a SQLite database file. Only available when
-     * conversion status is 'completed'.
-     *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.structuredSheets.exports.downloadSqlite(
-     *     'ss_01abc2def3ghjkmnpqrs4uvwxy',
-     *   );
-     *
-     * const content = await response.blob();
-     * console.log(content);
-     * ```
-     */
-    downloadSqlite(structuredSheetsID, options) {
-        return this._client.get(path `/v1/structured-sheets/${structuredSheetsID}/exports/sqlite`, {
-            ...options,
-            headers: buildHeaders([{ Accept: 'application/x-sqlite3' }, options?.headers]),
-            __binaryResponse: true,
-        });
-    }
-}
-//# sourceMappingURL=exports.mjs.map

package/resources/structured-sheets/exports.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"exports.mjs","sourceRoot":"","sources":["../../src/resources/structured-sheets/exports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,kBAA0B,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,kBAAkB,iBAAiB,EAAE;YACxF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,uBAAuB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC9E,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/resources/structured-sheets/exports.ts

@@ -1,32 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../core/resource';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
-
-export class Exports extends APIResource {
-  /**
-   * Download the structured data as a SQLite database file. Only available when
-   * conversion status is 'completed'.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.structuredSheets.exports.downloadSqlite(
-   *     'ss_01abc2def3ghjkmnpqrs4uvwxy',
-   *   );
-   *
-   * const content = await response.blob();
-   * console.log(content);
-   * ```
-   */
-  downloadSqlite(structuredSheetsID: string, options?: RequestOptions): APIPromise<Response> {
-    return this._client.get(path`/v1/structured-sheets/${structuredSheetsID}/exports/sqlite`, {
-      ...options,
-      headers: buildHeaders([{ Accept: 'application/x-sqlite3' }, options?.headers]),
-      __binaryResponse: true,
-    });
-  }
-}