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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/README.md +6 -6
  3. package/client.d.mts +2 -2
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +2 -2
  6. package/client.d.ts.map +1 -1
  7. package/client.js.map +1 -1
  8. package/client.mjs.map +1 -1
  9. package/package.json +1 -1
  10. package/resources/files.d.mts +16 -2
  11. package/resources/files.d.mts.map +1 -1
  12. package/resources/files.d.ts +16 -2
  13. package/resources/files.d.ts.map +1 -1
  14. package/resources/files.js +25 -2
  15. package/resources/files.js.map +1 -1
  16. package/resources/files.mjs +25 -2
  17. package/resources/files.mjs.map +1 -1
  18. package/resources/index.d.mts +1 -1
  19. package/resources/index.d.mts.map +1 -1
  20. package/resources/index.d.ts +1 -1
  21. package/resources/index.d.ts.map +1 -1
  22. package/resources/index.js.map +1 -1
  23. package/resources/index.mjs.map +1 -1
  24. package/resources/structured-sheets/index.d.mts +2 -2
  25. package/resources/structured-sheets/index.d.mts.map +1 -1
  26. package/resources/structured-sheets/index.d.ts +2 -2
  27. package/resources/structured-sheets/index.d.ts.map +1 -1
  28. package/resources/structured-sheets/index.js +3 -3
  29. package/resources/structured-sheets/index.js.map +1 -1
  30. package/resources/structured-sheets/index.mjs +1 -1
  31. package/resources/structured-sheets/index.mjs.map +1 -1
  32. package/resources/structured-sheets/structured-sheets.d.mts +62 -22
  33. package/resources/structured-sheets/structured-sheets.d.mts.map +1 -1
  34. package/resources/structured-sheets/structured-sheets.d.ts +62 -22
  35. package/resources/structured-sheets/structured-sheets.d.ts.map +1 -1
  36. package/resources/structured-sheets/structured-sheets.js +51 -9
  37. package/resources/structured-sheets/structured-sheets.js.map +1 -1
  38. package/resources/structured-sheets/structured-sheets.mjs +51 -9
  39. package/resources/structured-sheets/structured-sheets.mjs.map +1 -1
  40. package/resources/structured-sheets/tables.d.mts +145 -0
  41. package/resources/structured-sheets/tables.d.mts.map +1 -0
  42. package/resources/structured-sheets/tables.d.ts +145 -0
  43. package/resources/structured-sheets/tables.d.ts.map +1 -0
  44. package/resources/structured-sheets/tables.js +76 -0
  45. package/resources/structured-sheets/tables.js.map +1 -0
  46. package/resources/structured-sheets/tables.mjs +72 -0
  47. package/resources/structured-sheets/tables.mjs.map +1 -0
  48. package/src/client.ts +6 -4
  49. package/src/resources/files.ts +26 -2
  50. package/src/resources/index.ts +3 -2
  51. package/src/resources/structured-sheets/index.ts +10 -3
  52. package/src/resources/structured-sheets/structured-sheets.ts +89 -26
  53. package/src/resources/structured-sheets/tables.ts +190 -0
  54. package/src/version.ts +1 -1
  55. package/version.d.mts +1 -1
  56. package/version.d.ts +1 -1
  57. package/version.js +1 -1
  58. package/version.mjs +1 -1
  59. package/resources/structured-sheets/exports.d.mts +0 -22
  60. package/resources/structured-sheets/exports.d.mts.map +0 -1
  61. package/resources/structured-sheets/exports.d.ts +0 -22
  62. package/resources/structured-sheets/exports.d.ts.map +0 -1
  63. package/resources/structured-sheets/exports.js +0 -33
  64. package/resources/structured-sheets/exports.js.map +0 -1
  65. package/resources/structured-sheets/exports.mjs +0 -29
  66. package/resources/structured-sheets/exports.mjs.map +0 -1
  67. package/src/resources/structured-sheets/exports.ts +0 -32
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/structured-sheets/index.ts"],"names":[],"mappings":"OAEO,EAAE,OAAO,EAAE;OACX,EACL,gBAAgB,EAChB,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,oCAAoC,GAC1C"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/structured-sheets/index.ts"],"names":[],"mappings":"OAEO,EACL,gBAAgB,EAChB,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,qCAAqC,GAC3C;OACM,EACL,MAAM,EACN,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB"}
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.StructuredSheets = exports.Exports = void 0;
5
- var exports_1 = require("./exports.js");
6
- Object.defineProperty(exports, "Exports", { enumerable: true, get: function () { return exports_1.Exports; } });
4
+ exports.Tables = exports.StructuredSheets = void 0;
7
5
  var structured_sheets_1 = require("./structured-sheets.js");
8
6
  Object.defineProperty(exports, "StructuredSheets", { enumerable: true, get: function () { return structured_sheets_1.StructuredSheets; } });
7
+ var tables_1 = require("./tables.js");
8
+ Object.defineProperty(exports, "Tables", { enumerable: true, get: function () { return tables_1.Tables; } });
9
9
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/structured-sheets/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAChB,4DAM6B;AAL3B,qHAAA,gBAAgB,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/structured-sheets/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAO6B;AAN3B,qHAAA,gBAAgB,OAAA;AAOlB,sCAMkB;AALhB,gGAAA,MAAM,OAAA"}
@@ -1,4 +1,4 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
- export { Exports } from "./exports.mjs";
3
2
  export { StructuredSheets, } from "./structured-sheets.mjs";
3
+ export { Tables, } from "./tables.mjs";
4
4
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/structured-sheets/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,OAAO,EAAE;OACX,EACL,gBAAgB,GAKjB"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/structured-sheets/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,gBAAgB,GAMjB;OACM,EACL,MAAM,GAKP"}
@@ -1,11 +1,11 @@
1
1
  import { APIResource } from "../../core/resource.mjs";
2
- import * as ExportsAPI from "./exports.mjs";
3
- import { Exports } from "./exports.mjs";
2
+ import * as TablesAPI from "./tables.mjs";
3
+ import { TableDownloadParams, TableListResponse, TableResponse, TableRetrieveParams, Tables } from "./tables.mjs";
4
4
  import { APIPromise } from "../../core/api-promise.mjs";
5
5
  import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/pagination.mjs";
6
6
  import { RequestOptions } from "../../internal/request-options.mjs";
7
7
  export declare class StructuredSheets extends APIResource {
8
- exports: ExportsAPI.Exports;
8
+ tables: TablesAPI.Tables;
9
9
  /**
10
10
  * Start converting a spreadsheet workbook into structured data. This initiates an
11
11
  * asynchronous conversion process. Poll the returned resource using the `id` to
@@ -13,25 +13,25 @@ export declare class StructuredSheets extends APIResource {
13
13
  *
14
14
  * @example
15
15
  * ```ts
16
- * const structuredSheetResponse =
16
+ * const structuredSheetsResponse =
17
17
  * await client.structuredSheets.create({
18
18
  * file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
19
19
  * });
20
20
  * ```
21
21
  */
22
- create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetResponse>;
22
+ create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetsResponse>;
23
23
  /**
24
24
  * Get the status and details of a structured sheets conversion.
25
25
  *
26
26
  * @example
27
27
  * ```ts
28
- * const structuredSheetResponse =
28
+ * const structuredSheetsResponse =
29
29
  * await client.structuredSheets.retrieve(
30
- * 'ss_01abc2def3ghjkmnpqrs4uvwxy',
30
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
31
31
  * );
32
32
  * ```
33
33
  */
34
- retrieve(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetResponse>;
34
+ retrieve(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetsResponse>;
35
35
  /**
36
36
  * List all structured sheets conversions for the authenticated user. Results are
37
37
  * paginated using cursor-based pagination.
@@ -39,12 +39,12 @@ export declare class StructuredSheets extends APIResource {
39
39
  * @example
40
40
  * ```ts
41
41
  * // Automatically fetches more pages as needed.
42
- * for await (const structuredSheetResponse of client.structuredSheets.list()) {
42
+ * for await (const structuredSheetsResponse of client.structuredSheets.list()) {
43
43
  * // ...
44
44
  * }
45
45
  * ```
46
46
  */
47
- list(query?: StructuredSheetListParams | null | undefined, options?: RequestOptions): PagePromise<StructuredSheetResponsesCursorIDPage, StructuredSheetResponse>;
47
+ list(query?: StructuredSheetListParams | null | undefined, options?: RequestOptions): PagePromise<StructuredSheetsResponsesCursorIDPage, StructuredSheetsResponse>;
48
48
  /**
49
49
  * Delete a structured sheets conversion and its associated exports. This action
50
50
  * cannot be undone.
@@ -52,19 +52,52 @@ export declare class StructuredSheets extends APIResource {
52
52
  * @example
53
53
  * ```ts
54
54
  * await client.structuredSheets.delete(
55
- * 'ss_01abc2def3ghjkmnpqrs4uvwxy',
55
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
56
56
  * );
57
57
  * ```
58
58
  */
59
59
  delete(structuredSheetsID: string, options?: RequestOptions): APIPromise<void>;
60
+ /**
61
+ * Cancel a structured sheets conversion that is in progress. Only jobs with status
62
+ * 'queued' or 'in_progress' can be cancelled.
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * const structuredSheetsResponse =
67
+ * await client.structuredSheets.cancel(
68
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
69
+ * );
70
+ * ```
71
+ */
72
+ cancel(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetsResponse>;
73
+ /**
74
+ * Download the structured data in the specified format. Only available when
75
+ * conversion status is 'completed'.
76
+ *
77
+ * Available formats:
78
+ *
79
+ * - `sqlite`: SQLite database containing all extracted tables
80
+ * - `cell_labels`: CSV file with cell-level semantic labels
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const response = await client.structuredSheets.download(
85
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
86
+ * );
87
+ *
88
+ * const content = await response.blob();
89
+ * console.log(content);
90
+ * ```
91
+ */
92
+ download(structuredSheetsID: string, query?: StructuredSheetDownloadParams | null | undefined, options?: RequestOptions): APIPromise<Response>;
60
93
  }
61
- export type StructuredSheetResponsesCursorIDPage = CursorIDPage<StructuredSheetResponse>;
94
+ export type StructuredSheetsResponsesCursorIDPage = CursorIDPage<StructuredSheetsResponse>;
62
95
  /**
63
96
  * Response representing a structured sheets conversion job.
64
97
  *
65
98
  * This is returned from POST (create), GET (retrieve), and list endpoints.
66
99
  */
67
- export interface StructuredSheetResponse {
100
+ export interface StructuredSheetsResponse {
68
101
  /**
69
102
  * The unique identifier for this structured sheets conversion.
70
103
  */
@@ -80,19 +113,15 @@ export interface StructuredSheetResponse {
80
113
  /**
81
114
  * The current processing status.
82
115
  */
83
- status: 'pending' | 'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
116
+ status: 'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
84
117
  /**
85
118
  * The timestamp when the conversion was last updated.
86
119
  */
87
120
  updated_at: string;
88
- /**
89
- * List of export formats available for download (e.g., ['sqlite']).
90
- */
91
- exports_available?: Array<string>;
92
121
  /**
93
122
  * Error information when processing fails.
94
123
  */
95
- last_error?: StructuredSheetResponse.LastError | null;
124
+ last_error?: StructuredSheetsResponse.LastError | null;
96
125
  /**
97
126
  * The object type, which is always 'structured_sheet'.
98
127
  */
@@ -101,8 +130,13 @@ export interface StructuredSheetResponse {
101
130
  * List of sheet names included in this conversion.
102
131
  */
103
132
  sheet_names?: Array<string>;
133
+ /**
134
+ * Number of tables extracted from the workbook. Only present when status is
135
+ * 'completed'.
136
+ */
137
+ table_count?: number | null;
104
138
  }
105
- export declare namespace StructuredSheetResponse {
139
+ export declare namespace StructuredSheetsResponse {
106
140
  /**
107
141
  * Error information when processing fails.
108
142
  */
@@ -129,8 +163,14 @@ export interface StructuredSheetCreateParams {
129
163
  }
130
164
  export interface StructuredSheetListParams extends CursorIDPageParams {
131
165
  }
166
+ export interface StructuredSheetDownloadParams {
167
+ /**
168
+ * The export format to download.
169
+ */
170
+ format?: 'sqlite' | 'cell_labels';
171
+ }
132
172
  export declare namespace StructuredSheets {
133
- export { type StructuredSheetResponse as StructuredSheetResponse, type StructuredSheetResponsesCursorIDPage as StructuredSheetResponsesCursorIDPage, type StructuredSheetCreateParams as StructuredSheetCreateParams, type StructuredSheetListParams as StructuredSheetListParams, };
134
- export { Exports as Exports };
173
+ export { type StructuredSheetsResponse as StructuredSheetsResponse, type StructuredSheetsResponsesCursorIDPage as StructuredSheetsResponsesCursorIDPage, type StructuredSheetCreateParams as StructuredSheetCreateParams, type StructuredSheetListParams as StructuredSheetListParams, type StructuredSheetDownloadParams as StructuredSheetDownloadParams, };
174
+ export { Tables as Tables, type TableResponse as TableResponse, type TableListResponse as TableListResponse, type TableRetrieveParams as TableRetrieveParams, type TableDownloadParams as TableDownloadParams, };
135
175
  }
136
176
  //# sourceMappingURL=structured-sheets.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"structured-sheets.d.mts","sourceRoot":"","sources":["../../src/resources/structured-sheets/structured-sheets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OACX,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInG;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,uBAAuB,CAAC;IAO7E;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/E;AAED,MAAM,MAAM,oCAAoC,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAC;AAEzF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAEpF;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,CAAC,SAAS,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;CAAG;AAIxE,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;CAC/B"}
1
+ {"version":3,"file":"structured-sheets.d.mts","sourceRoot":"","sources":["../../src/resources/structured-sheets/structured-sheets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,EAAE;OACtF,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIzG;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIpG;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,wBAAwB,CAAC;IAO/E;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9E;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIlG;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,kBAAkB,EAAE,MAAM,EAC1B,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;CAQxB;AAED,MAAM,MAAM,qCAAqC,GAAG,YAAY,CAAC,wBAAwB,CAAC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAExE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,wBAAwB,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;CAAG;AAExE,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,aAAa,CAAC;CACnC;AAID,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
@@ -1,11 +1,11 @@
1
1
  import { APIResource } from "../../core/resource.js";
2
- import * as ExportsAPI from "./exports.js";
3
- import { Exports } from "./exports.js";
2
+ import * as TablesAPI from "./tables.js";
3
+ import { TableDownloadParams, TableListResponse, TableResponse, TableRetrieveParams, Tables } from "./tables.js";
4
4
  import { APIPromise } from "../../core/api-promise.js";
5
5
  import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/pagination.js";
6
6
  import { RequestOptions } from "../../internal/request-options.js";
7
7
  export declare class StructuredSheets extends APIResource {
8
- exports: ExportsAPI.Exports;
8
+ tables: TablesAPI.Tables;
9
9
  /**
10
10
  * Start converting a spreadsheet workbook into structured data. This initiates an
11
11
  * asynchronous conversion process. Poll the returned resource using the `id` to
@@ -13,25 +13,25 @@ export declare class StructuredSheets extends APIResource {
13
13
  *
14
14
  * @example
15
15
  * ```ts
16
- * const structuredSheetResponse =
16
+ * const structuredSheetsResponse =
17
17
  * await client.structuredSheets.create({
18
18
  * file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
19
19
  * });
20
20
  * ```
21
21
  */
22
- create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetResponse>;
22
+ create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetsResponse>;
23
23
  /**
24
24
  * Get the status and details of a structured sheets conversion.
25
25
  *
26
26
  * @example
27
27
  * ```ts
28
- * const structuredSheetResponse =
28
+ * const structuredSheetsResponse =
29
29
  * await client.structuredSheets.retrieve(
30
- * 'ss_01abc2def3ghjkmnpqrs4uvwxy',
30
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
31
31
  * );
32
32
  * ```
33
33
  */
34
- retrieve(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetResponse>;
34
+ retrieve(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetsResponse>;
35
35
  /**
36
36
  * List all structured sheets conversions for the authenticated user. Results are
37
37
  * paginated using cursor-based pagination.
@@ -39,12 +39,12 @@ export declare class StructuredSheets extends APIResource {
39
39
  * @example
40
40
  * ```ts
41
41
  * // Automatically fetches more pages as needed.
42
- * for await (const structuredSheetResponse of client.structuredSheets.list()) {
42
+ * for await (const structuredSheetsResponse of client.structuredSheets.list()) {
43
43
  * // ...
44
44
  * }
45
45
  * ```
46
46
  */
47
- list(query?: StructuredSheetListParams | null | undefined, options?: RequestOptions): PagePromise<StructuredSheetResponsesCursorIDPage, StructuredSheetResponse>;
47
+ list(query?: StructuredSheetListParams | null | undefined, options?: RequestOptions): PagePromise<StructuredSheetsResponsesCursorIDPage, StructuredSheetsResponse>;
48
48
  /**
49
49
  * Delete a structured sheets conversion and its associated exports. This action
50
50
  * cannot be undone.
@@ -52,19 +52,52 @@ export declare class StructuredSheets extends APIResource {
52
52
  * @example
53
53
  * ```ts
54
54
  * await client.structuredSheets.delete(
55
- * 'ss_01abc2def3ghjkmnpqrs4uvwxy',
55
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
56
56
  * );
57
57
  * ```
58
58
  */
59
59
  delete(structuredSheetsID: string, options?: RequestOptions): APIPromise<void>;
60
+ /**
61
+ * Cancel a structured sheets conversion that is in progress. Only jobs with status
62
+ * 'queued' or 'in_progress' can be cancelled.
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * const structuredSheetsResponse =
67
+ * await client.structuredSheets.cancel(
68
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
69
+ * );
70
+ * ```
71
+ */
72
+ cancel(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetsResponse>;
73
+ /**
74
+ * Download the structured data in the specified format. Only available when
75
+ * conversion status is 'completed'.
76
+ *
77
+ * Available formats:
78
+ *
79
+ * - `sqlite`: SQLite database containing all extracted tables
80
+ * - `cell_labels`: CSV file with cell-level semantic labels
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const response = await client.structuredSheets.download(
85
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
86
+ * );
87
+ *
88
+ * const content = await response.blob();
89
+ * console.log(content);
90
+ * ```
91
+ */
92
+ download(structuredSheetsID: string, query?: StructuredSheetDownloadParams | null | undefined, options?: RequestOptions): APIPromise<Response>;
60
93
  }
61
- export type StructuredSheetResponsesCursorIDPage = CursorIDPage<StructuredSheetResponse>;
94
+ export type StructuredSheetsResponsesCursorIDPage = CursorIDPage<StructuredSheetsResponse>;
62
95
  /**
63
96
  * Response representing a structured sheets conversion job.
64
97
  *
65
98
  * This is returned from POST (create), GET (retrieve), and list endpoints.
66
99
  */
67
- export interface StructuredSheetResponse {
100
+ export interface StructuredSheetsResponse {
68
101
  /**
69
102
  * The unique identifier for this structured sheets conversion.
70
103
  */
@@ -80,19 +113,15 @@ export interface StructuredSheetResponse {
80
113
  /**
81
114
  * The current processing status.
82
115
  */
83
- status: 'pending' | 'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
116
+ status: 'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
84
117
  /**
85
118
  * The timestamp when the conversion was last updated.
86
119
  */
87
120
  updated_at: string;
88
- /**
89
- * List of export formats available for download (e.g., ['sqlite']).
90
- */
91
- exports_available?: Array<string>;
92
121
  /**
93
122
  * Error information when processing fails.
94
123
  */
95
- last_error?: StructuredSheetResponse.LastError | null;
124
+ last_error?: StructuredSheetsResponse.LastError | null;
96
125
  /**
97
126
  * The object type, which is always 'structured_sheet'.
98
127
  */
@@ -101,8 +130,13 @@ export interface StructuredSheetResponse {
101
130
  * List of sheet names included in this conversion.
102
131
  */
103
132
  sheet_names?: Array<string>;
133
+ /**
134
+ * Number of tables extracted from the workbook. Only present when status is
135
+ * 'completed'.
136
+ */
137
+ table_count?: number | null;
104
138
  }
105
- export declare namespace StructuredSheetResponse {
139
+ export declare namespace StructuredSheetsResponse {
106
140
  /**
107
141
  * Error information when processing fails.
108
142
  */
@@ -129,8 +163,14 @@ export interface StructuredSheetCreateParams {
129
163
  }
130
164
  export interface StructuredSheetListParams extends CursorIDPageParams {
131
165
  }
166
+ export interface StructuredSheetDownloadParams {
167
+ /**
168
+ * The export format to download.
169
+ */
170
+ format?: 'sqlite' | 'cell_labels';
171
+ }
132
172
  export declare namespace StructuredSheets {
133
- export { type StructuredSheetResponse as StructuredSheetResponse, type StructuredSheetResponsesCursorIDPage as StructuredSheetResponsesCursorIDPage, type StructuredSheetCreateParams as StructuredSheetCreateParams, type StructuredSheetListParams as StructuredSheetListParams, };
134
- export { Exports as Exports };
173
+ export { type StructuredSheetsResponse as StructuredSheetsResponse, type StructuredSheetsResponsesCursorIDPage as StructuredSheetsResponsesCursorIDPage, type StructuredSheetCreateParams as StructuredSheetCreateParams, type StructuredSheetListParams as StructuredSheetListParams, type StructuredSheetDownloadParams as StructuredSheetDownloadParams, };
174
+ export { Tables as Tables, type TableResponse as TableResponse, type TableListResponse as TableListResponse, type TableRetrieveParams as TableRetrieveParams, type TableDownloadParams as TableDownloadParams, };
135
175
  }
136
176
  //# sourceMappingURL=structured-sheets.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"structured-sheets.d.ts","sourceRoot":"","sources":["../../src/resources/structured-sheets/structured-sheets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OACX,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInG;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,uBAAuB,CAAC;IAO7E;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/E;AAED,MAAM,MAAM,oCAAoC,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAC;AAEzF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAEpF;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,CAAC,SAAS,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;CAAG;AAIxE,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;CAC/B"}
1
+ {"version":3,"file":"structured-sheets.d.ts","sourceRoot":"","sources":["../../src/resources/structured-sheets/structured-sheets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,EAAE;OACtF,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIzG;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIpG;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,wBAAwB,CAAC;IAO/E;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9E;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIlG;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,kBAAkB,EAAE,MAAM,EAC1B,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;CAQxB;AAED,MAAM,MAAM,qCAAqC,GAAG,YAAY,CAAC,wBAAwB,CAAC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAExE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,wBAAwB,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;CAAG;AAExE,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,aAAa,CAAC;CACnC;AAID,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
@@ -4,15 +4,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.StructuredSheets = void 0;
5
5
  const tslib_1 = require("../../internal/tslib.js");
6
6
  const resource_1 = require("../../core/resource.js");
7
- const ExportsAPI = tslib_1.__importStar(require("./exports.js"));
8
- const exports_1 = require("./exports.js");
7
+ const TablesAPI = tslib_1.__importStar(require("./tables.js"));
8
+ const tables_1 = require("./tables.js");
9
9
  const pagination_1 = require("../../core/pagination.js");
10
10
  const headers_1 = require("../../internal/headers.js");
11
11
  const path_1 = require("../../internal/utils/path.js");
12
12
  class StructuredSheets extends resource_1.APIResource {
13
13
  constructor() {
14
14
  super(...arguments);
15
- this.exports = new ExportsAPI.Exports(this._client);
15
+ this.tables = new TablesAPI.Tables(this._client);
16
16
  }
17
17
  /**
18
18
  * Start converting a spreadsheet workbook into structured data. This initiates an
@@ -21,7 +21,7 @@ class StructuredSheets extends resource_1.APIResource {
21
21
  *
22
22
  * @example
23
23
  * ```ts
24
- * const structuredSheetResponse =
24
+ * const structuredSheetsResponse =
25
25
  * await client.structuredSheets.create({
26
26
  * file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
27
27
  * });
@@ -35,9 +35,9 @@ class StructuredSheets extends resource_1.APIResource {
35
35
  *
36
36
  * @example
37
37
  * ```ts
38
- * const structuredSheetResponse =
38
+ * const structuredSheetsResponse =
39
39
  * await client.structuredSheets.retrieve(
40
- * 'ss_01abc2def3ghjkmnpqrs4uvwxy',
40
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
41
41
  * );
42
42
  * ```
43
43
  */
@@ -51,7 +51,7 @@ class StructuredSheets extends resource_1.APIResource {
51
51
  * @example
52
52
  * ```ts
53
53
  * // Automatically fetches more pages as needed.
54
- * for await (const structuredSheetResponse of client.structuredSheets.list()) {
54
+ * for await (const structuredSheetsResponse of client.structuredSheets.list()) {
55
55
  * // ...
56
56
  * }
57
57
  * ```
@@ -69,7 +69,7 @@ class StructuredSheets extends resource_1.APIResource {
69
69
  * @example
70
70
  * ```ts
71
71
  * await client.structuredSheets.delete(
72
- * 'ss_01abc2def3ghjkmnpqrs4uvwxy',
72
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
73
73
  * );
74
74
  * ```
75
75
  */
@@ -79,7 +79,49 @@ class StructuredSheets extends resource_1.APIResource {
79
79
  headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
80
80
  });
81
81
  }
82
+ /**
83
+ * Cancel a structured sheets conversion that is in progress. Only jobs with status
84
+ * 'queued' or 'in_progress' can be cancelled.
85
+ *
86
+ * @example
87
+ * ```ts
88
+ * const structuredSheetsResponse =
89
+ * await client.structuredSheets.cancel(
90
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
91
+ * );
92
+ * ```
93
+ */
94
+ cancel(structuredSheetsID, options) {
95
+ return this._client.post((0, path_1.path) `/v1/structured-sheets/${structuredSheetsID}/cancel`, options);
96
+ }
97
+ /**
98
+ * Download the structured data in the specified format. Only available when
99
+ * conversion status is 'completed'.
100
+ *
101
+ * Available formats:
102
+ *
103
+ * - `sqlite`: SQLite database containing all extracted tables
104
+ * - `cell_labels`: CSV file with cell-level semantic labels
105
+ *
106
+ * @example
107
+ * ```ts
108
+ * const response = await client.structuredSheets.download(
109
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
110
+ * );
111
+ *
112
+ * const content = await response.blob();
113
+ * console.log(content);
114
+ * ```
115
+ */
116
+ download(structuredSheetsID, query = {}, options) {
117
+ return this._client.get((0, path_1.path) `/v1/structured-sheets/${structuredSheetsID}/download`, {
118
+ query,
119
+ ...options,
120
+ headers: (0, headers_1.buildHeaders)([{ Accept: 'application/x-sqlite3' }, options?.headers]),
121
+ __binaryResponse: true,
122
+ });
123
+ }
82
124
  }
83
125
  exports.StructuredSheets = StructuredSheets;
84
- StructuredSheets.Exports = exports_1.Exports;
126
+ StructuredSheets.Tables = tables_1.Tables;
85
127
  //# sourceMappingURL=structured-sheets.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"structured-sheets.js","sourceRoot":"","sources":["../../src/resources/structured-sheets/structured-sheets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,iEAAwC;AACxC,0CAAoC;AAEpC,yDAA2F;AAC3F,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,gBAAiB,SAAQ,sBAAW;IAAjD;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyErE,CAAC;IAvEC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAiC,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAA0B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAA,yBAAqC,CAAA,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,kBAAkB,EAAE,EAAE;YAC5E,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA1ED,4CA0EC;AAuFD,gBAAgB,CAAC,OAAO,GAAG,iBAAO,CAAC"}
1
+ {"version":3,"file":"structured-sheets.js","sourceRoot":"","sources":["../../src/resources/structured-sheets/structured-sheets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,+DAAsC;AACtC,wCAA8G;AAE9G,yDAA2F;AAC3F,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,gBAAiB,SAAQ,sBAAW;IAAjD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyHhE,CAAC;IAvHC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAiC,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAA0B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAA,yBAAsC,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,kBAAkB,EAAE,EAAE;YAC5E,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,kBAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,kBAAkB,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,kBAA0B,EAC1B,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,kBAAkB,WAAW,EAAE;YAClF,KAAK;YACL,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;AA1HD,4CA0HC;AA+FD,gBAAgB,CAAC,MAAM,GAAG,eAAM,CAAC"}
@@ -1,14 +1,14 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../../core/resource.mjs";
3
- import * as ExportsAPI from "./exports.mjs";
4
- import { Exports } from "./exports.mjs";
3
+ import * as TablesAPI from "./tables.mjs";
4
+ import { Tables } from "./tables.mjs";
5
5
  import { CursorIDPage } from "../../core/pagination.mjs";
6
6
  import { buildHeaders } from "../../internal/headers.mjs";
7
7
  import { path } from "../../internal/utils/path.mjs";
8
8
  export class StructuredSheets extends APIResource {
9
9
  constructor() {
10
10
  super(...arguments);
11
- this.exports = new ExportsAPI.Exports(this._client);
11
+ this.tables = new TablesAPI.Tables(this._client);
12
12
  }
13
13
  /**
14
14
  * Start converting a spreadsheet workbook into structured data. This initiates an
@@ -17,7 +17,7 @@ export class StructuredSheets extends APIResource {
17
17
  *
18
18
  * @example
19
19
  * ```ts
20
- * const structuredSheetResponse =
20
+ * const structuredSheetsResponse =
21
21
  * await client.structuredSheets.create({
22
22
  * file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
23
23
  * });
@@ -31,9 +31,9 @@ export class StructuredSheets extends APIResource {
31
31
  *
32
32
  * @example
33
33
  * ```ts
34
- * const structuredSheetResponse =
34
+ * const structuredSheetsResponse =
35
35
  * await client.structuredSheets.retrieve(
36
- * 'ss_01abc2def3ghjkmnpqrs4uvwxy',
36
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
37
37
  * );
38
38
  * ```
39
39
  */
@@ -47,7 +47,7 @@ export class StructuredSheets extends APIResource {
47
47
  * @example
48
48
  * ```ts
49
49
  * // Automatically fetches more pages as needed.
50
- * for await (const structuredSheetResponse of client.structuredSheets.list()) {
50
+ * for await (const structuredSheetsResponse of client.structuredSheets.list()) {
51
51
  * // ...
52
52
  * }
53
53
  * ```
@@ -65,7 +65,7 @@ export class StructuredSheets extends APIResource {
65
65
  * @example
66
66
  * ```ts
67
67
  * await client.structuredSheets.delete(
68
- * 'ss_01abc2def3ghjkmnpqrs4uvwxy',
68
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
69
69
  * );
70
70
  * ```
71
71
  */
@@ -75,6 +75,48 @@ export class StructuredSheets extends APIResource {
75
75
  headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
76
76
  });
77
77
  }
78
+ /**
79
+ * Cancel a structured sheets conversion that is in progress. Only jobs with status
80
+ * 'queued' or 'in_progress' can be cancelled.
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const structuredSheetsResponse =
85
+ * await client.structuredSheets.cancel(
86
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
87
+ * );
88
+ * ```
89
+ */
90
+ cancel(structuredSheetsID, options) {
91
+ return this._client.post(path `/v1/structured-sheets/${structuredSheetsID}/cancel`, options);
92
+ }
93
+ /**
94
+ * Download the structured data in the specified format. Only available when
95
+ * conversion status is 'completed'.
96
+ *
97
+ * Available formats:
98
+ *
99
+ * - `sqlite`: SQLite database containing all extracted tables
100
+ * - `cell_labels`: CSV file with cell-level semantic labels
101
+ *
102
+ * @example
103
+ * ```ts
104
+ * const response = await client.structuredSheets.download(
105
+ * 'ss_01kfxgjd94fn9stqm42nejb627',
106
+ * );
107
+ *
108
+ * const content = await response.blob();
109
+ * console.log(content);
110
+ * ```
111
+ */
112
+ download(structuredSheetsID, query = {}, options) {
113
+ return this._client.get(path `/v1/structured-sheets/${structuredSheetsID}/download`, {
114
+ query,
115
+ ...options,
116
+ headers: buildHeaders([{ Accept: 'application/x-sqlite3' }, options?.headers]),
117
+ __binaryResponse: true,
118
+ });
119
+ }
78
120
  }
79
- StructuredSheets.Exports = Exports;
121
+ StructuredSheets.Tables = Tables;
80
122
  //# sourceMappingURL=structured-sheets.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"structured-sheets.mjs","sourceRoot":"","sources":["../../src/resources/structured-sheets/structured-sheets.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OAEX,EAAE,YAAY,EAAwC;OACtD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAAjD;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyErE,CAAC;IAvEC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAiC,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAA0B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAA,YAAqC,CAAA,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,kBAAkB,EAAE,EAAE;YAC5E,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAuFD,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC"}
1
+ {"version":3,"file":"structured-sheets.mjs","sourceRoot":"","sources":["../../src/resources/structured-sheets/structured-sheets.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAA8E,MAAM,EAAE;OAEtF,EAAE,YAAY,EAAwC;OACtD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAAjD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyHhE,CAAC;IAvHC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAiC,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAA0B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAA,YAAsC,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,kBAAkB,EAAE,EAAE;YAC5E,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,kBAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,kBAAkB,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,kBAA0B,EAC1B,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,kBAAkB,WAAW,EAAE;YAClF,KAAK;YACL,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;AA+FD,gBAAgB,CAAC,MAAM,GAAG,MAAM,CAAC"}