@deeptable/deeptable 0.1.0-alpha.2 → 0.1.0-alpha.4
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.
- package/CHANGELOG.md +17 -0
- package/README.md +6 -6
- package/client.d.mts +4 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -4
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/files.d.mts +22 -3
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +22 -3
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +2 -5
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +2 -5
- package/resources/files.mjs.map +1 -1
- package/resources/index.d.mts +2 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/structured-sheets/index.d.mts +2 -2
- package/resources/structured-sheets/index.d.mts.map +1 -1
- package/resources/structured-sheets/index.d.ts +2 -2
- package/resources/structured-sheets/index.d.ts.map +1 -1
- package/resources/structured-sheets/index.js.map +1 -1
- package/resources/structured-sheets/index.mjs.map +1 -1
- package/resources/structured-sheets/structured-sheets.d.mts +45 -25
- package/resources/structured-sheets/structured-sheets.d.mts.map +1 -1
- package/resources/structured-sheets/structured-sheets.d.ts +45 -25
- package/resources/structured-sheets/structured-sheets.d.ts.map +1 -1
- package/resources/structured-sheets/structured-sheets.js +19 -21
- package/resources/structured-sheets/structured-sheets.js.map +1 -1
- package/resources/structured-sheets/structured-sheets.mjs +20 -22
- package/resources/structured-sheets/structured-sheets.mjs.map +1 -1
- package/resources/structured-sheets/tables.d.mts +19 -38
- package/resources/structured-sheets/tables.d.mts.map +1 -1
- package/resources/structured-sheets/tables.d.ts +19 -38
- package/resources/structured-sheets/tables.d.ts.map +1 -1
- package/resources/structured-sheets/tables.js +15 -10
- package/resources/structured-sheets/tables.js.map +1 -1
- package/resources/structured-sheets/tables.mjs +15 -10
- package/resources/structured-sheets/tables.mjs.map +1 -1
- package/src/client.ts +15 -5
- package/src/resources/files.ts +26 -6
- package/src/resources/index.ts +4 -2
- package/src/resources/structured-sheets/index.ts +5 -3
- package/src/resources/structured-sheets/structured-sheets.ts +63 -34
- package/src/resources/structured-sheets/tables.ts +34 -48
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
2
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
3
4
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
5
|
export declare class Tables extends APIResource {
|
|
5
6
|
/**
|
|
@@ -12,7 +13,7 @@ export declare class Tables extends APIResource {
|
|
|
12
13
|
* await client.structuredSheets.tables.retrieve(
|
|
13
14
|
* 'tbl_01kfxgjd94fn9stqm45rqr2pnz',
|
|
14
15
|
* {
|
|
15
|
-
*
|
|
16
|
+
* structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
16
17
|
* },
|
|
17
18
|
* );
|
|
18
19
|
* ```
|
|
@@ -24,12 +25,15 @@ export declare class Tables extends APIResource {
|
|
|
24
25
|
*
|
|
25
26
|
* @example
|
|
26
27
|
* ```ts
|
|
27
|
-
*
|
|
28
|
+
* // Automatically fetches more pages as needed.
|
|
29
|
+
* for await (const tableResponse of client.structuredSheets.tables.list(
|
|
28
30
|
* 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
29
|
-
* )
|
|
31
|
+
* )) {
|
|
32
|
+
* // ...
|
|
33
|
+
* }
|
|
30
34
|
* ```
|
|
31
35
|
*/
|
|
32
|
-
list(
|
|
36
|
+
list(structuredSheetID: string, query?: TableListParams | null | undefined, options?: RequestOptions): PagePromise<TableResponsesCursorIDPage, TableResponse>;
|
|
33
37
|
/**
|
|
34
38
|
* Download the table data in the specified format.
|
|
35
39
|
*
|
|
@@ -44,7 +48,8 @@ export declare class Tables extends APIResource {
|
|
|
44
48
|
* await client.structuredSheets.tables.download(
|
|
45
49
|
* 'tbl_01kfxgjd94fn9stqm45rqr2pnz',
|
|
46
50
|
* {
|
|
47
|
-
*
|
|
51
|
+
* structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
52
|
+
* format: 'parquet',
|
|
48
53
|
* },
|
|
49
54
|
* );
|
|
50
55
|
*
|
|
@@ -54,6 +59,7 @@ export declare class Tables extends APIResource {
|
|
|
54
59
|
*/
|
|
55
60
|
download(tableID: string, params: TableDownloadParams, options?: RequestOptions): APIPromise<Response>;
|
|
56
61
|
}
|
|
62
|
+
export type TableResponsesCursorIDPage = CursorIDPage<TableResponse>;
|
|
57
63
|
/**
|
|
58
64
|
* Response representing a table extracted from a structured sheet.
|
|
59
65
|
*
|
|
@@ -95,50 +101,25 @@ export interface TableResponse {
|
|
|
95
101
|
*/
|
|
96
102
|
object?: 'table';
|
|
97
103
|
}
|
|
98
|
-
/**
|
|
99
|
-
* Paginated response for listing tables from a structured sheet.
|
|
100
|
-
*
|
|
101
|
-
* Uses cursor-based pagination for efficient iteration through results.
|
|
102
|
-
*/
|
|
103
|
-
export interface TableListResponse {
|
|
104
|
-
/**
|
|
105
|
-
* List of tables.
|
|
106
|
-
*/
|
|
107
|
-
data: Array<TableResponse>;
|
|
108
|
-
/**
|
|
109
|
-
* Whether there are more results available after this page.
|
|
110
|
-
*/
|
|
111
|
-
has_more: boolean;
|
|
112
|
-
/**
|
|
113
|
-
* Unique identifier for a table.
|
|
114
|
-
*/
|
|
115
|
-
first_id?: string | null;
|
|
116
|
-
/**
|
|
117
|
-
* Unique identifier for a table.
|
|
118
|
-
*/
|
|
119
|
-
last_id?: string | null;
|
|
120
|
-
/**
|
|
121
|
-
* The object type, which is always 'list'.
|
|
122
|
-
*/
|
|
123
|
-
object?: 'list';
|
|
124
|
-
}
|
|
125
104
|
export interface TableRetrieveParams {
|
|
126
105
|
/**
|
|
127
|
-
* The unique identifier of the structured
|
|
106
|
+
* The unique identifier of the structured sheet conversion.
|
|
128
107
|
*/
|
|
129
|
-
|
|
108
|
+
structured_sheet_id: string;
|
|
109
|
+
}
|
|
110
|
+
export interface TableListParams extends CursorIDPageParams {
|
|
130
111
|
}
|
|
131
112
|
export interface TableDownloadParams {
|
|
132
113
|
/**
|
|
133
|
-
* Path param: The unique identifier of the structured
|
|
114
|
+
* Path param: The unique identifier of the structured sheet conversion.
|
|
134
115
|
*/
|
|
135
|
-
|
|
116
|
+
structured_sheet_id: string;
|
|
136
117
|
/**
|
|
137
118
|
* Query param: The format to download the table data in.
|
|
138
119
|
*/
|
|
139
|
-
format
|
|
120
|
+
format: 'parquet' | 'csv';
|
|
140
121
|
}
|
|
141
122
|
export declare namespace Tables {
|
|
142
|
-
export { type TableResponse as TableResponse, type
|
|
123
|
+
export { type TableResponse as TableResponse, type TableResponsesCursorIDPage as TableResponsesCursorIDPage, type TableRetrieveParams as TableRetrieveParams, type TableListParams as TableListParams, type TableDownloadParams as TableDownloadParams, };
|
|
143
124
|
}
|
|
144
125
|
//# sourceMappingURL=tables.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tables.d.mts","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"tables.d.mts","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;IAK5B;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,iBAAiB,EAAE,MAAM,EACzB,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,aAAa,CAAC;IAQzD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CASvG;AAED,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;AAErE;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,YAAY,GAAG,aAAa,GAAG,WAAW,CAAC;IAEjD;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;CAAG;AAE9D,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,KAAK,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.js";
|
|
2
2
|
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/pagination.js";
|
|
3
4
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
5
|
export declare class Tables extends APIResource {
|
|
5
6
|
/**
|
|
@@ -12,7 +13,7 @@ export declare class Tables extends APIResource {
|
|
|
12
13
|
* await client.structuredSheets.tables.retrieve(
|
|
13
14
|
* 'tbl_01kfxgjd94fn9stqm45rqr2pnz',
|
|
14
15
|
* {
|
|
15
|
-
*
|
|
16
|
+
* structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
16
17
|
* },
|
|
17
18
|
* );
|
|
18
19
|
* ```
|
|
@@ -24,12 +25,15 @@ export declare class Tables extends APIResource {
|
|
|
24
25
|
*
|
|
25
26
|
* @example
|
|
26
27
|
* ```ts
|
|
27
|
-
*
|
|
28
|
+
* // Automatically fetches more pages as needed.
|
|
29
|
+
* for await (const tableResponse of client.structuredSheets.tables.list(
|
|
28
30
|
* 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
29
|
-
* )
|
|
31
|
+
* )) {
|
|
32
|
+
* // ...
|
|
33
|
+
* }
|
|
30
34
|
* ```
|
|
31
35
|
*/
|
|
32
|
-
list(
|
|
36
|
+
list(structuredSheetID: string, query?: TableListParams | null | undefined, options?: RequestOptions): PagePromise<TableResponsesCursorIDPage, TableResponse>;
|
|
33
37
|
/**
|
|
34
38
|
* Download the table data in the specified format.
|
|
35
39
|
*
|
|
@@ -44,7 +48,8 @@ export declare class Tables extends APIResource {
|
|
|
44
48
|
* await client.structuredSheets.tables.download(
|
|
45
49
|
* 'tbl_01kfxgjd94fn9stqm45rqr2pnz',
|
|
46
50
|
* {
|
|
47
|
-
*
|
|
51
|
+
* structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
52
|
+
* format: 'parquet',
|
|
48
53
|
* },
|
|
49
54
|
* );
|
|
50
55
|
*
|
|
@@ -54,6 +59,7 @@ export declare class Tables extends APIResource {
|
|
|
54
59
|
*/
|
|
55
60
|
download(tableID: string, params: TableDownloadParams, options?: RequestOptions): APIPromise<Response>;
|
|
56
61
|
}
|
|
62
|
+
export type TableResponsesCursorIDPage = CursorIDPage<TableResponse>;
|
|
57
63
|
/**
|
|
58
64
|
* Response representing a table extracted from a structured sheet.
|
|
59
65
|
*
|
|
@@ -95,50 +101,25 @@ export interface TableResponse {
|
|
|
95
101
|
*/
|
|
96
102
|
object?: 'table';
|
|
97
103
|
}
|
|
98
|
-
/**
|
|
99
|
-
* Paginated response for listing tables from a structured sheet.
|
|
100
|
-
*
|
|
101
|
-
* Uses cursor-based pagination for efficient iteration through results.
|
|
102
|
-
*/
|
|
103
|
-
export interface TableListResponse {
|
|
104
|
-
/**
|
|
105
|
-
* List of tables.
|
|
106
|
-
*/
|
|
107
|
-
data: Array<TableResponse>;
|
|
108
|
-
/**
|
|
109
|
-
* Whether there are more results available after this page.
|
|
110
|
-
*/
|
|
111
|
-
has_more: boolean;
|
|
112
|
-
/**
|
|
113
|
-
* Unique identifier for a table.
|
|
114
|
-
*/
|
|
115
|
-
first_id?: string | null;
|
|
116
|
-
/**
|
|
117
|
-
* Unique identifier for a table.
|
|
118
|
-
*/
|
|
119
|
-
last_id?: string | null;
|
|
120
|
-
/**
|
|
121
|
-
* The object type, which is always 'list'.
|
|
122
|
-
*/
|
|
123
|
-
object?: 'list';
|
|
124
|
-
}
|
|
125
104
|
export interface TableRetrieveParams {
|
|
126
105
|
/**
|
|
127
|
-
* The unique identifier of the structured
|
|
106
|
+
* The unique identifier of the structured sheet conversion.
|
|
128
107
|
*/
|
|
129
|
-
|
|
108
|
+
structured_sheet_id: string;
|
|
109
|
+
}
|
|
110
|
+
export interface TableListParams extends CursorIDPageParams {
|
|
130
111
|
}
|
|
131
112
|
export interface TableDownloadParams {
|
|
132
113
|
/**
|
|
133
|
-
* Path param: The unique identifier of the structured
|
|
114
|
+
* Path param: The unique identifier of the structured sheet conversion.
|
|
134
115
|
*/
|
|
135
|
-
|
|
116
|
+
structured_sheet_id: string;
|
|
136
117
|
/**
|
|
137
118
|
* Query param: The format to download the table data in.
|
|
138
119
|
*/
|
|
139
|
-
format
|
|
120
|
+
format: 'parquet' | 'csv';
|
|
140
121
|
}
|
|
141
122
|
export declare namespace Tables {
|
|
142
|
-
export { type TableResponse as TableResponse, type
|
|
123
|
+
export { type TableResponse as TableResponse, type TableResponsesCursorIDPage as TableResponsesCursorIDPage, type TableRetrieveParams as TableRetrieveParams, type TableListParams as TableListParams, type TableDownloadParams as TableDownloadParams, };
|
|
143
124
|
}
|
|
144
125
|
//# sourceMappingURL=tables.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tables.d.ts","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"tables.d.ts","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;IAK5B;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,iBAAiB,EAAE,MAAM,EACzB,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,aAAa,CAAC;IAQzD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CASvG;AAED,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;AAErE;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,YAAY,GAAG,aAAa,GAAG,WAAW,CAAC;IAEjD;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;CAAG;AAE9D,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,KAAK,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.Tables = void 0;
|
|
5
5
|
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
6
7
|
const headers_1 = require("../../internal/headers.js");
|
|
7
8
|
const path_1 = require("../../internal/utils/path.js");
|
|
8
9
|
class Tables extends resource_1.APIResource {
|
|
@@ -16,14 +17,14 @@ class Tables extends resource_1.APIResource {
|
|
|
16
17
|
* await client.structuredSheets.tables.retrieve(
|
|
17
18
|
* 'tbl_01kfxgjd94fn9stqm45rqr2pnz',
|
|
18
19
|
* {
|
|
19
|
-
*
|
|
20
|
+
* structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
20
21
|
* },
|
|
21
22
|
* );
|
|
22
23
|
* ```
|
|
23
24
|
*/
|
|
24
25
|
retrieve(tableID, params, options) {
|
|
25
|
-
const {
|
|
26
|
-
return this._client.get((0, path_1.path) `/v1/structured-sheets/${
|
|
26
|
+
const { structured_sheet_id } = params;
|
|
27
|
+
return this._client.get((0, path_1.path) `/v1/structured-sheets/${structured_sheet_id}/tables/${tableID}`, options);
|
|
27
28
|
}
|
|
28
29
|
/**
|
|
29
30
|
* List all tables extracted from the structured sheet. Only available when
|
|
@@ -31,13 +32,16 @@ class Tables extends resource_1.APIResource {
|
|
|
31
32
|
*
|
|
32
33
|
* @example
|
|
33
34
|
* ```ts
|
|
34
|
-
*
|
|
35
|
+
* // Automatically fetches more pages as needed.
|
|
36
|
+
* for await (const tableResponse of client.structuredSheets.tables.list(
|
|
35
37
|
* 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
36
|
-
* )
|
|
38
|
+
* )) {
|
|
39
|
+
* // ...
|
|
40
|
+
* }
|
|
37
41
|
* ```
|
|
38
42
|
*/
|
|
39
|
-
list(
|
|
40
|
-
return this._client.
|
|
43
|
+
list(structuredSheetID, query = {}, options) {
|
|
44
|
+
return this._client.getAPIList((0, path_1.path) `/v1/structured-sheets/${structuredSheetID}/tables`, (pagination_1.CursorIDPage), { query, ...options });
|
|
41
45
|
}
|
|
42
46
|
/**
|
|
43
47
|
* Download the table data in the specified format.
|
|
@@ -53,7 +57,8 @@ class Tables extends resource_1.APIResource {
|
|
|
53
57
|
* await client.structuredSheets.tables.download(
|
|
54
58
|
* 'tbl_01kfxgjd94fn9stqm45rqr2pnz',
|
|
55
59
|
* {
|
|
56
|
-
*
|
|
60
|
+
* structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
61
|
+
* format: 'parquet',
|
|
57
62
|
* },
|
|
58
63
|
* );
|
|
59
64
|
*
|
|
@@ -62,8 +67,8 @@ class Tables extends resource_1.APIResource {
|
|
|
62
67
|
* ```
|
|
63
68
|
*/
|
|
64
69
|
download(tableID, params, options) {
|
|
65
|
-
const {
|
|
66
|
-
return this._client.get((0, path_1.path) `/v1/structured-sheets/${
|
|
70
|
+
const { structured_sheet_id, ...query } = params;
|
|
71
|
+
return this._client.get((0, path_1.path) `/v1/structured-sheets/${structured_sheet_id}/tables/${tableID}/download`, {
|
|
67
72
|
query,
|
|
68
73
|
...options,
|
|
69
74
|
headers: (0, headers_1.buildHeaders)([{ Accept: 'application/vnd.apache.parquet' }, options?.headers]),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tables.js","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,
|
|
1
|
+
{"version":3,"file":"tables.js","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA2F;AAC3F,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,mBAAmB,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,iBAAyB,EACzB,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,yBAAyB,iBAAiB,SAAS,EACvD,CAAA,yBAA2B,CAAA,EAC3B,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,OAAe,EAAE,MAA2B,EAAE,OAAwB;QAC7E,MAAM,EAAE,mBAAmB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,mBAAmB,WAAW,OAAO,WAAW,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,gCAAgC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACvF,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AAnFD,wBAmFC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
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 { CursorIDPage } from "../../core/pagination.mjs";
|
|
3
4
|
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
5
|
import { path } from "../../internal/utils/path.mjs";
|
|
5
6
|
export class Tables extends APIResource {
|
|
@@ -13,14 +14,14 @@ export class Tables extends APIResource {
|
|
|
13
14
|
* await client.structuredSheets.tables.retrieve(
|
|
14
15
|
* 'tbl_01kfxgjd94fn9stqm45rqr2pnz',
|
|
15
16
|
* {
|
|
16
|
-
*
|
|
17
|
+
* structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
17
18
|
* },
|
|
18
19
|
* );
|
|
19
20
|
* ```
|
|
20
21
|
*/
|
|
21
22
|
retrieve(tableID, params, options) {
|
|
22
|
-
const {
|
|
23
|
-
return this._client.get(path `/v1/structured-sheets/${
|
|
23
|
+
const { structured_sheet_id } = params;
|
|
24
|
+
return this._client.get(path `/v1/structured-sheets/${structured_sheet_id}/tables/${tableID}`, options);
|
|
24
25
|
}
|
|
25
26
|
/**
|
|
26
27
|
* List all tables extracted from the structured sheet. Only available when
|
|
@@ -28,13 +29,16 @@ export class Tables extends APIResource {
|
|
|
28
29
|
*
|
|
29
30
|
* @example
|
|
30
31
|
* ```ts
|
|
31
|
-
*
|
|
32
|
+
* // Automatically fetches more pages as needed.
|
|
33
|
+
* for await (const tableResponse of client.structuredSheets.tables.list(
|
|
32
34
|
* 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
33
|
-
* )
|
|
35
|
+
* )) {
|
|
36
|
+
* // ...
|
|
37
|
+
* }
|
|
34
38
|
* ```
|
|
35
39
|
*/
|
|
36
|
-
list(
|
|
37
|
-
return this._client.
|
|
40
|
+
list(structuredSheetID, query = {}, options) {
|
|
41
|
+
return this._client.getAPIList(path `/v1/structured-sheets/${structuredSheetID}/tables`, (CursorIDPage), { query, ...options });
|
|
38
42
|
}
|
|
39
43
|
/**
|
|
40
44
|
* Download the table data in the specified format.
|
|
@@ -50,7 +54,8 @@ export class Tables extends APIResource {
|
|
|
50
54
|
* await client.structuredSheets.tables.download(
|
|
51
55
|
* 'tbl_01kfxgjd94fn9stqm45rqr2pnz',
|
|
52
56
|
* {
|
|
53
|
-
*
|
|
57
|
+
* structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
|
|
58
|
+
* format: 'parquet',
|
|
54
59
|
* },
|
|
55
60
|
* );
|
|
56
61
|
*
|
|
@@ -59,8 +64,8 @@ export class Tables extends APIResource {
|
|
|
59
64
|
* ```
|
|
60
65
|
*/
|
|
61
66
|
download(tableID, params, options) {
|
|
62
|
-
const {
|
|
63
|
-
return this._client.get(path `/v1/structured-sheets/${
|
|
67
|
+
const { structured_sheet_id, ...query } = params;
|
|
68
|
+
return this._client.get(path `/v1/structured-sheets/${structured_sheet_id}/tables/${tableID}/download`, {
|
|
64
69
|
query,
|
|
65
70
|
...options,
|
|
66
71
|
headers: buildHeaders([{ Accept: 'application/vnd.apache.parquet' }, options?.headers]),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tables.mjs","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,
|
|
1
|
+
{"version":3,"file":"tables.mjs","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAwC;OACtD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,mBAAmB,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,iBAAyB,EACzB,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,yBAAyB,iBAAiB,SAAS,EACvD,CAAA,YAA2B,CAAA,EAC3B,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,OAAe,EAAE,MAA2B,EAAE,OAAwB;QAC7E,MAAM,EAAE,mBAAmB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,mBAAmB,WAAW,OAAO,WAAW,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,gCAAgC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACvF,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/src/client.ts
CHANGED
|
@@ -18,14 +18,22 @@ import { AbstractPage, type CursorIDPageParams, CursorIDPageResponse } from './c
|
|
|
18
18
|
import * as Uploads from './core/uploads';
|
|
19
19
|
import * as API from './resources/index';
|
|
20
20
|
import { APIPromise } from './core/api-promise';
|
|
21
|
-
import {
|
|
21
|
+
import {
|
|
22
|
+
File,
|
|
23
|
+
FileDeleteResponse,
|
|
24
|
+
FileListParams,
|
|
25
|
+
FileUploadParams,
|
|
26
|
+
Files,
|
|
27
|
+
FilesCursorIDPage,
|
|
28
|
+
} from './resources/files';
|
|
22
29
|
import {
|
|
23
30
|
StructuredSheetCreateParams,
|
|
31
|
+
StructuredSheetDeleteResponse,
|
|
24
32
|
StructuredSheetDownloadParams,
|
|
25
33
|
StructuredSheetListParams,
|
|
34
|
+
StructuredSheetResponse,
|
|
35
|
+
StructuredSheetResponsesCursorIDPage,
|
|
26
36
|
StructuredSheets,
|
|
27
|
-
StructuredSheetsResponse,
|
|
28
|
-
StructuredSheetsResponsesCursorIDPage,
|
|
29
37
|
} from './resources/structured-sheets/structured-sheets';
|
|
30
38
|
import { type Fetch } from './internal/builtin-types';
|
|
31
39
|
import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
|
|
@@ -759,6 +767,7 @@ export declare namespace DeepTable {
|
|
|
759
767
|
export {
|
|
760
768
|
Files as Files,
|
|
761
769
|
type File as File,
|
|
770
|
+
type FileDeleteResponse as FileDeleteResponse,
|
|
762
771
|
type FilesCursorIDPage as FilesCursorIDPage,
|
|
763
772
|
type FileListParams as FileListParams,
|
|
764
773
|
type FileUploadParams as FileUploadParams,
|
|
@@ -766,8 +775,9 @@ export declare namespace DeepTable {
|
|
|
766
775
|
|
|
767
776
|
export {
|
|
768
777
|
StructuredSheets as StructuredSheets,
|
|
769
|
-
type
|
|
770
|
-
type
|
|
778
|
+
type StructuredSheetResponse as StructuredSheetResponse,
|
|
779
|
+
type StructuredSheetDeleteResponse as StructuredSheetDeleteResponse,
|
|
780
|
+
type StructuredSheetResponsesCursorIDPage as StructuredSheetResponsesCursorIDPage,
|
|
771
781
|
type StructuredSheetCreateParams as StructuredSheetCreateParams,
|
|
772
782
|
type StructuredSheetListParams as StructuredSheetListParams,
|
|
773
783
|
type StructuredSheetDownloadParams as StructuredSheetDownloadParams,
|
package/src/resources/files.ts
CHANGED
|
@@ -47,16 +47,13 @@ export class Files extends APIResource {
|
|
|
47
47
|
*
|
|
48
48
|
* @example
|
|
49
49
|
* ```ts
|
|
50
|
-
* await client.files.delete(
|
|
50
|
+
* const file = await client.files.delete(
|
|
51
51
|
* 'file_01kfxgjd94fn9stqm414vjb0s8',
|
|
52
52
|
* );
|
|
53
53
|
* ```
|
|
54
54
|
*/
|
|
55
|
-
delete(fileID: string, options?: RequestOptions): APIPromise<
|
|
56
|
-
return this._client.delete(path`/v1/files/${fileID}`,
|
|
57
|
-
...options,
|
|
58
|
-
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
59
|
-
});
|
|
55
|
+
delete(fileID: string, options?: RequestOptions): APIPromise<FileDeleteResponse> {
|
|
56
|
+
return this._client.delete(path`/v1/files/${fileID}`, options);
|
|
60
57
|
}
|
|
61
58
|
|
|
62
59
|
/**
|
|
@@ -143,6 +140,28 @@ export interface File {
|
|
|
143
140
|
object?: 'file';
|
|
144
141
|
}
|
|
145
142
|
|
|
143
|
+
/**
|
|
144
|
+
* Response from deleting a file.
|
|
145
|
+
*
|
|
146
|
+
* Following the OpenAI API convention for delete responses.
|
|
147
|
+
*/
|
|
148
|
+
export interface FileDeleteResponse {
|
|
149
|
+
/**
|
|
150
|
+
* The unique identifier of the deleted file.
|
|
151
|
+
*/
|
|
152
|
+
id: string;
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Whether the file was successfully deleted.
|
|
156
|
+
*/
|
|
157
|
+
deleted?: true;
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* The object type, which is always 'file'.
|
|
161
|
+
*/
|
|
162
|
+
object?: 'file';
|
|
163
|
+
}
|
|
164
|
+
|
|
146
165
|
export interface FileListParams extends CursorIDPageParams {}
|
|
147
166
|
|
|
148
167
|
export interface FileUploadParams {
|
|
@@ -155,6 +174,7 @@ export interface FileUploadParams {
|
|
|
155
174
|
export declare namespace Files {
|
|
156
175
|
export {
|
|
157
176
|
type File as File,
|
|
177
|
+
type FileDeleteResponse as FileDeleteResponse,
|
|
158
178
|
type FilesCursorIDPage as FilesCursorIDPage,
|
|
159
179
|
type FileListParams as FileListParams,
|
|
160
180
|
type FileUploadParams as FileUploadParams,
|
package/src/resources/index.ts
CHANGED
|
@@ -3,15 +3,17 @@
|
|
|
3
3
|
export {
|
|
4
4
|
Files,
|
|
5
5
|
type File,
|
|
6
|
+
type FileDeleteResponse,
|
|
6
7
|
type FileListParams,
|
|
7
8
|
type FileUploadParams,
|
|
8
9
|
type FilesCursorIDPage,
|
|
9
10
|
} from './files';
|
|
10
11
|
export {
|
|
11
12
|
StructuredSheets,
|
|
12
|
-
type
|
|
13
|
+
type StructuredSheetResponse,
|
|
14
|
+
type StructuredSheetDeleteResponse,
|
|
13
15
|
type StructuredSheetCreateParams,
|
|
14
16
|
type StructuredSheetListParams,
|
|
15
17
|
type StructuredSheetDownloadParams,
|
|
16
|
-
type
|
|
18
|
+
type StructuredSheetResponsesCursorIDPage,
|
|
17
19
|
} from './structured-sheets/structured-sheets';
|
|
@@ -2,16 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
export {
|
|
4
4
|
StructuredSheets,
|
|
5
|
-
type
|
|
5
|
+
type StructuredSheetResponse,
|
|
6
|
+
type StructuredSheetDeleteResponse,
|
|
6
7
|
type StructuredSheetCreateParams,
|
|
7
8
|
type StructuredSheetListParams,
|
|
8
9
|
type StructuredSheetDownloadParams,
|
|
9
|
-
type
|
|
10
|
+
type StructuredSheetResponsesCursorIDPage,
|
|
10
11
|
} from './structured-sheets';
|
|
11
12
|
export {
|
|
12
13
|
Tables,
|
|
13
14
|
type TableResponse,
|
|
14
|
-
type TableListResponse,
|
|
15
15
|
type TableRetrieveParams,
|
|
16
|
+
type TableListParams,
|
|
16
17
|
type TableDownloadParams,
|
|
18
|
+
type TableResponsesCursorIDPage,
|
|
17
19
|
} from './tables';
|