@deeptable/deeptable 0.1.0-alpha.3 → 0.1.0-alpha.4

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

@@ -2,7 +2,14 @@
 
 import { APIResource } from '../../core/resource';
 import * as TablesAPI from './tables';
-import { TableDownloadParams, TableListResponse, TableResponse, TableRetrieveParams, Tables } from './tables';
+import {
+  TableDownloadParams,
+  TableListParams,
+  TableResponse,
+  TableResponsesCursorIDPage,
+  TableRetrieveParams,
+  Tables,
+} from './tables';
 import { APIPromise } from '../../core/api-promise';
 import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
@@ -19,29 +26,29 @@ export class StructuredSheets extends APIResource {
    *
    * @example
    * ```ts
-   * const structuredSheetsResponse =
+   * const structuredSheetResponse =
    *   await client.structuredSheets.create({
    *     file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
    *   });
    * ```
    */
-  create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetsResponse> {
+  create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetResponse> {
     return this._client.post('/v1/structured-sheets', { body, ...options });
   }
 
   /**
-   * Get the status and details of a structured sheets conversion.
+   * Get the status and details of a structured sheet conversion.
    *
    * @example
    * ```ts
-   * const structuredSheetsResponse =
+   * const structuredSheetResponse =
    *   await client.structuredSheets.retrieve(
    *     'ss_01kfxgjd94fn9stqm42nejb627',
    *   );
    * ```
    */
-  retrieve(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetsResponse> {
-    return this._client.get(path`/v1/structured-sheets/${structuredSheetsID}`, options);
+  retrieve(structuredSheetID: string, options?: RequestOptions): APIPromise<StructuredSheetResponse> {
+    return this._client.get(path`/v1/structured-sheets/${structuredSheetID}`, options);
   }
 
   /**
@@ -51,7 +58,7 @@ export class StructuredSheets extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const structuredSheetsResponse of client.structuredSheets.list()) {
+   * for await (const structuredSheetResponse of client.structuredSheets.list()) {
    *   // ...
    * }
    * ```
@@ -59,45 +66,43 @@ export class StructuredSheets extends APIResource {
   list(
     query: StructuredSheetListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<StructuredSheetsResponsesCursorIDPage, StructuredSheetsResponse> {
-    return this._client.getAPIList('/v1/structured-sheets', CursorIDPage<StructuredSheetsResponse>, {
+  ): PagePromise<StructuredSheetResponsesCursorIDPage, StructuredSheetResponse> {
+    return this._client.getAPIList('/v1/structured-sheets', CursorIDPage<StructuredSheetResponse>, {
       query,
       ...options,
     });
   }
 
   /**
-   * Delete a structured sheets conversion and its associated exports. This action
+   * Delete a structured sheet conversion and its associated exports. This action
    * cannot be undone.
    *
    * @example
    * ```ts
-   * await client.structuredSheets.delete(
-   *   'ss_01kfxgjd94fn9stqm42nejb627',
-   * );
+   * const structuredSheet =
+   *   await client.structuredSheets.delete(
+   *     'ss_01kfxgjd94fn9stqm42nejb627',
+   *   );
    * ```
    */
-  delete(structuredSheetsID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/v1/structured-sheets/${structuredSheetsID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  delete(structuredSheetID: string, options?: RequestOptions): APIPromise<StructuredSheetDeleteResponse> {
+    return this._client.delete(path`/v1/structured-sheets/${structuredSheetID}`, options);
   }
 
   /**
-   * Cancel a structured sheets conversion that is in progress. Only jobs with status
+   * Cancel a structured sheet conversion that is in progress. Only jobs with status
    * 'queued' or 'in_progress' can be cancelled.
    *
    * @example
    * ```ts
-   * const structuredSheetsResponse =
+   * const structuredSheetResponse =
    *   await client.structuredSheets.cancel(
    *     'ss_01kfxgjd94fn9stqm42nejb627',
    *   );
    * ```
    */
-  cancel(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetsResponse> {
-    return this._client.post(path`/v1/structured-sheets/${structuredSheetsID}/cancel`, options);
+  cancel(structuredSheetID: string, options?: RequestOptions): APIPromise<StructuredSheetResponse> {
+    return this._client.post(path`/v1/structured-sheets/${structuredSheetID}/cancel`, options);
   }
 
   /**
@@ -120,11 +125,11 @@ export class StructuredSheets extends APIResource {
    * ```
    */
   download(
-    structuredSheetsID: string,
+    structuredSheetID: string,
     query: StructuredSheetDownloadParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<Response> {
-    return this._client.get(path`/v1/structured-sheets/${structuredSheetsID}/download`, {
+    return this._client.get(path`/v1/structured-sheets/${structuredSheetID}/download`, {
       query,
       ...options,
       headers: buildHeaders([{ Accept: 'application/x-sqlite3' }, options?.headers]),
@@ -133,16 +138,16 @@ export class StructuredSheets extends APIResource {
   }
 }
 
-export type StructuredSheetsResponsesCursorIDPage = CursorIDPage<StructuredSheetsResponse>;
+export type StructuredSheetResponsesCursorIDPage = CursorIDPage<StructuredSheetResponse>;
 
 /**
- * Response representing a structured sheets conversion job.
+ * Response representing a structured sheet conversion job.
  *
  * This is returned from POST (create), GET (retrieve), and list endpoints.
  */
-export interface StructuredSheetsResponse {
+export interface StructuredSheetResponse {
   /**
-   * The unique identifier for this structured sheets conversion.
+   * The unique identifier for this structured sheet conversion.
    */
   id: string;
 
@@ -169,7 +174,7 @@ export interface StructuredSheetsResponse {
   /**
    * Error information when processing fails.
    */
-  last_error?: StructuredSheetsResponse.LastError | null;
+  last_error?: StructuredSheetResponse.LastError | null;
 
   /**
    * The object type, which is always 'structured_sheet'.
@@ -188,7 +193,7 @@ export interface StructuredSheetsResponse {
   table_count?: number | null;
 }
 
-export namespace StructuredSheetsResponse {
+export namespace StructuredSheetResponse {
   /**
    * Error information when processing fails.
    */
@@ -205,6 +210,28 @@ export namespace StructuredSheetsResponse {
   }
 }
 
+/**
+ * Response from deleting a structured sheet.
+ *
+ * Following the OpenAI API convention for delete responses.
+ */
+export interface StructuredSheetDeleteResponse {
+  /**
+   * The unique identifier of the deleted structured sheet.
+   */
+  id: string;
+
+  /**
+   * Whether the structured sheet was successfully deleted.
+   */
+  deleted?: true;
+
+  /**
+   * The object type, which is always 'structured_sheet'.
+   */
+  object?: 'structured_sheet';
+}
+
 export interface StructuredSheetCreateParams {
   /**
    * The unique identifier of the file to convert.
@@ -230,8 +257,9 @@ StructuredSheets.Tables = Tables;
 
 export declare namespace StructuredSheets {
   export {
-    type StructuredSheetsResponse as StructuredSheetsResponse,
-    type StructuredSheetsResponsesCursorIDPage as StructuredSheetsResponsesCursorIDPage,
+    type StructuredSheetResponse as StructuredSheetResponse,
+    type StructuredSheetDeleteResponse as StructuredSheetDeleteResponse,
+    type StructuredSheetResponsesCursorIDPage as StructuredSheetResponsesCursorIDPage,
     type StructuredSheetCreateParams as StructuredSheetCreateParams,
     type StructuredSheetListParams as StructuredSheetListParams,
     type StructuredSheetDownloadParams as StructuredSheetDownloadParams,
@@ -240,8 +268,9 @@ export declare namespace StructuredSheets {
   export {
     Tables as Tables,
     type TableResponse as TableResponse,
-    type TableListResponse as TableListResponse,
+    type TableResponsesCursorIDPage as TableResponsesCursorIDPage,
     type TableRetrieveParams as TableRetrieveParams,
+    type TableListParams as TableListParams,
     type TableDownloadParams as TableDownloadParams,
   };
 }

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

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -17,7 +18,7 @@ export class Tables extends APIResource {
    *   await client.structuredSheets.tables.retrieve(
    *     'tbl_01kfxgjd94fn9stqm45rqr2pnz',
    *     {
-   *       structured_sheets_id: 'ss_01kfxgjd94fn9stqm42nejb627',
+   *       structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
    *     },
    *   );
    * ```
@@ -27,8 +28,8 @@ export class Tables extends APIResource {
     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);
+    const { structured_sheet_id } = params;
+    return this._client.get(path`/v1/structured-sheets/${structured_sheet_id}/tables/${tableID}`, options);
   }
 
   /**
@@ -37,13 +38,24 @@ export class Tables extends APIResource {
    *
    * @example
    * ```ts
-   * const tables = await client.structuredSheets.tables.list(
+   * // Automatically fetches more pages as needed.
+   * for await (const tableResponse of client.structuredSheets.tables.list(
    *   'ss_01kfxgjd94fn9stqm42nejb627',
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
-  list(structuredSheetsID: string, options?: RequestOptions): APIPromise<TableListResponse> {
-    return this._client.get(path`/v1/structured-sheets/${structuredSheetsID}/tables`, options);
+  list(
+    structuredSheetID: string,
+    query: TableListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TableResponsesCursorIDPage, TableResponse> {
+    return this._client.getAPIList(
+      path`/v1/structured-sheets/${structuredSheetID}/tables`,
+      CursorIDPage<TableResponse>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -60,7 +72,7 @@ export class Tables extends APIResource {
    *   await client.structuredSheets.tables.download(
    *     'tbl_01kfxgjd94fn9stqm45rqr2pnz',
    *     {
-   *       structured_sheets_id: 'ss_01kfxgjd94fn9stqm42nejb627',
+   *       structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
    *       format: 'parquet',
    *     },
    *   );
@@ -70,8 +82,8 @@ export class Tables extends APIResource {
    * ```
    */
   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`, {
+    const { structured_sheet_id, ...query } = params;
+    return this._client.get(path`/v1/structured-sheets/${structured_sheet_id}/tables/${tableID}/download`, {
       query,
       ...options,
       headers: buildHeaders([{ Accept: 'application/vnd.apache.parquet' }, options?.headers]),
@@ -80,6 +92,8 @@ export class Tables extends APIResource {
   }
 }
 
+export type TableResponsesCursorIDPage = CursorIDPage<TableResponse>;
+
 /**
  * Response representing a table extracted from a structured sheet.
  *
@@ -129,50 +143,20 @@ export interface TableResponse {
   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.
+   * The unique identifier of the structured sheet conversion.
    */
-  structured_sheets_id: string;
+  structured_sheet_id: string;
 }
 
+export interface TableListParams extends CursorIDPageParams {}
+
 export interface TableDownloadParams {
   /**
-   * Path param: The unique identifier of the structured sheets conversion.
+   * Path param: The unique identifier of the structured sheet conversion.
    */
-  structured_sheets_id: string;
+  structured_sheet_id: string;
 
   /**
    * Query param: The format to download the table data in.
@@ -183,8 +167,9 @@ export interface TableDownloadParams {
 export declare namespace Tables {
   export {
     type TableResponse as TableResponse,
-    type TableListResponse as TableListResponse,
+    type TableResponsesCursorIDPage as TableResponsesCursorIDPage,
     type TableRetrieveParams as TableRetrieveParams,
+    type TableListParams as TableListParams,
     type TableDownloadParams as TableDownloadParams,
   };
 }

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.3";
+export declare const VERSION = "0.1.0-alpha.4";
 //# 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.3'; // x-release-please-version
+exports.VERSION = '0.1.0-alpha.4'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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