@deeptable/deeptable 0.1.0-alpha.1
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 +16 -0
- package/LICENSE +7 -0
- package/README.md +430 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +189 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +189 -0
- package/client.d.ts.map +1 -0
- package/client.js +472 -0
- package/client.js.map +1 -0
- package/client.mjs +468 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/pagination.d.mts +54 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +54 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +101 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +95 -0
- package/core/pagination.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +7 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +7 -0
- package/index.d.ts.map +1 -0
- package/index.js +32 -0
- package/index.js.map +1 -0
- package/index.mjs +8 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +147 -0
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/files.d.mts +102 -0
- package/resources/files.d.mts.map +1 -0
- package/resources/files.d.ts +102 -0
- package/resources/files.d.ts.map +1 -0
- package/resources/files.js +75 -0
- package/resources/files.js.map +1 -0
- package/resources/files.mjs +71 -0
- package/resources/files.mjs.map +1 -0
- package/resources/index.d.mts +3 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +3 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +9 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +4 -0
- package/resources/index.mjs.map +1 -0
- package/resources/structured-sheets/exports.d.mts +22 -0
- package/resources/structured-sheets/exports.d.mts.map +1 -0
- package/resources/structured-sheets/exports.d.ts +22 -0
- package/resources/structured-sheets/exports.d.ts.map +1 -0
- package/resources/structured-sheets/exports.js +33 -0
- package/resources/structured-sheets/exports.js.map +1 -0
- package/resources/structured-sheets/exports.mjs +29 -0
- package/resources/structured-sheets/exports.mjs.map +1 -0
- package/resources/structured-sheets/index.d.mts +3 -0
- package/resources/structured-sheets/index.d.mts.map +1 -0
- package/resources/structured-sheets/index.d.ts +3 -0
- package/resources/structured-sheets/index.d.ts.map +1 -0
- package/resources/structured-sheets/index.js +9 -0
- package/resources/structured-sheets/index.js.map +1 -0
- package/resources/structured-sheets/index.mjs +4 -0
- package/resources/structured-sheets/index.mjs.map +1 -0
- package/resources/structured-sheets/structured-sheets.d.mts +136 -0
- package/resources/structured-sheets/structured-sheets.d.mts.map +1 -0
- package/resources/structured-sheets/structured-sheets.d.ts +136 -0
- package/resources/structured-sheets/structured-sheets.d.ts.map +1 -0
- package/resources/structured-sheets/structured-sheets.js +85 -0
- package/resources/structured-sheets/structured-sheets.js.map +1 -0
- package/resources/structured-sheets/structured-sheets.mjs +80 -0
- package/resources/structured-sheets/structured-sheets.mjs.map +1 -0
- package/resources/structured-sheets.d.mts +2 -0
- package/resources/structured-sheets.d.mts.map +1 -0
- package/resources/structured-sheets.d.ts +2 -0
- package/resources/structured-sheets.d.ts.map +1 -0
- package/resources/structured-sheets.js +6 -0
- package/resources/structured-sheets.js.map +1 -0
- package/resources/structured-sheets.mjs +3 -0
- package/resources/structured-sheets.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +773 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/pagination.ts +156 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +23 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/pagination.ts +2 -0
- package/src/resource.ts +2 -0
- package/src/resources/files.ts +138 -0
- package/src/resources/index.ts +16 -0
- package/src/resources/structured-sheets/exports.ts +32 -0
- package/src/resources/structured-sheets/index.ts +10 -0
- package/src/resources/structured-sheets/structured-sheets.ts +184 -0
- package/src/resources/structured-sheets.ts +3 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as ExportsAPI from "./exports.mjs";
|
|
3
|
+
import { Exports } from "./exports.mjs";
|
|
4
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
5
|
+
import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
7
|
+
export declare class StructuredSheets extends APIResource {
|
|
8
|
+
exports: ExportsAPI.Exports;
|
|
9
|
+
/**
|
|
10
|
+
* Start converting a spreadsheet workbook into structured data. This initiates an
|
|
11
|
+
* asynchronous conversion process. Poll the returned resource using the `id` to
|
|
12
|
+
* check completion status.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const structuredSheetResponse =
|
|
17
|
+
* await client.structuredSheets.create({
|
|
18
|
+
* file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Get the status and details of a structured sheets conversion.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const structuredSheetResponse =
|
|
29
|
+
* await client.structuredSheets.retrieve(
|
|
30
|
+
* 'ss_01abc2def3ghjkmnpqrs4uvwxy',
|
|
31
|
+
* );
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
retrieve(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* List all structured sheets conversions for the authenticated user. Results are
|
|
37
|
+
* paginated using cursor-based pagination.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* // Automatically fetches more pages as needed.
|
|
42
|
+
* for await (const structuredSheetResponse of client.structuredSheets.list()) {
|
|
43
|
+
* // ...
|
|
44
|
+
* }
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
list(query?: StructuredSheetListParams | null | undefined, options?: RequestOptions): PagePromise<StructuredSheetResponsesCursorIDPage, StructuredSheetResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* Delete a structured sheets conversion and its associated exports. This action
|
|
50
|
+
* cannot be undone.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* await client.structuredSheets.delete(
|
|
55
|
+
* 'ss_01abc2def3ghjkmnpqrs4uvwxy',
|
|
56
|
+
* );
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
delete(structuredSheetsID: string, options?: RequestOptions): APIPromise<void>;
|
|
60
|
+
}
|
|
61
|
+
export type StructuredSheetResponsesCursorIDPage = CursorIDPage<StructuredSheetResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Response representing a structured sheets conversion job.
|
|
64
|
+
*
|
|
65
|
+
* This is returned from POST (create), GET (retrieve), and list endpoints.
|
|
66
|
+
*/
|
|
67
|
+
export interface StructuredSheetResponse {
|
|
68
|
+
/**
|
|
69
|
+
* The unique identifier for this structured sheets conversion.
|
|
70
|
+
*/
|
|
71
|
+
id: string;
|
|
72
|
+
/**
|
|
73
|
+
* The timestamp when the conversion was started.
|
|
74
|
+
*/
|
|
75
|
+
created_at: string;
|
|
76
|
+
/**
|
|
77
|
+
* The unique identifier for the source file.
|
|
78
|
+
*/
|
|
79
|
+
file_id: string;
|
|
80
|
+
/**
|
|
81
|
+
* The current processing status.
|
|
82
|
+
*/
|
|
83
|
+
status: 'pending' | 'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
|
|
84
|
+
/**
|
|
85
|
+
* The timestamp when the conversion was last updated.
|
|
86
|
+
*/
|
|
87
|
+
updated_at: string;
|
|
88
|
+
/**
|
|
89
|
+
* List of export formats available for download (e.g., ['sqlite']).
|
|
90
|
+
*/
|
|
91
|
+
exports_available?: Array<string>;
|
|
92
|
+
/**
|
|
93
|
+
* Error information when processing fails.
|
|
94
|
+
*/
|
|
95
|
+
last_error?: StructuredSheetResponse.LastError | null;
|
|
96
|
+
/**
|
|
97
|
+
* The object type, which is always 'structured_sheet'.
|
|
98
|
+
*/
|
|
99
|
+
object?: 'structured_sheet';
|
|
100
|
+
/**
|
|
101
|
+
* List of sheet names included in this conversion.
|
|
102
|
+
*/
|
|
103
|
+
sheet_names?: Array<string>;
|
|
104
|
+
}
|
|
105
|
+
export declare namespace StructuredSheetResponse {
|
|
106
|
+
/**
|
|
107
|
+
* Error information when processing fails.
|
|
108
|
+
*/
|
|
109
|
+
interface LastError {
|
|
110
|
+
/**
|
|
111
|
+
* A machine-readable error code.
|
|
112
|
+
*/
|
|
113
|
+
code: string;
|
|
114
|
+
/**
|
|
115
|
+
* A human-readable description of the error.
|
|
116
|
+
*/
|
|
117
|
+
message: string;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
export interface StructuredSheetCreateParams {
|
|
121
|
+
/**
|
|
122
|
+
* The unique identifier of the file to convert.
|
|
123
|
+
*/
|
|
124
|
+
file_id: string;
|
|
125
|
+
/**
|
|
126
|
+
* List of sheet names to convert. If None, all sheets will be converted.
|
|
127
|
+
*/
|
|
128
|
+
sheet_names?: Array<string> | null;
|
|
129
|
+
}
|
|
130
|
+
export interface StructuredSheetListParams extends CursorIDPageParams {
|
|
131
|
+
}
|
|
132
|
+
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 };
|
|
135
|
+
}
|
|
136
|
+
//# sourceMappingURL=structured-sheets.d.mts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as ExportsAPI from "./exports.js";
|
|
3
|
+
import { Exports } from "./exports.js";
|
|
4
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
5
|
+
import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/pagination.js";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
7
|
+
export declare class StructuredSheets extends APIResource {
|
|
8
|
+
exports: ExportsAPI.Exports;
|
|
9
|
+
/**
|
|
10
|
+
* Start converting a spreadsheet workbook into structured data. This initiates an
|
|
11
|
+
* asynchronous conversion process. Poll the returned resource using the `id` to
|
|
12
|
+
* check completion status.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const structuredSheetResponse =
|
|
17
|
+
* await client.structuredSheets.create({
|
|
18
|
+
* file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
create(body: StructuredSheetCreateParams, options?: RequestOptions): APIPromise<StructuredSheetResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Get the status and details of a structured sheets conversion.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const structuredSheetResponse =
|
|
29
|
+
* await client.structuredSheets.retrieve(
|
|
30
|
+
* 'ss_01abc2def3ghjkmnpqrs4uvwxy',
|
|
31
|
+
* );
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
retrieve(structuredSheetsID: string, options?: RequestOptions): APIPromise<StructuredSheetResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* List all structured sheets conversions for the authenticated user. Results are
|
|
37
|
+
* paginated using cursor-based pagination.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* // Automatically fetches more pages as needed.
|
|
42
|
+
* for await (const structuredSheetResponse of client.structuredSheets.list()) {
|
|
43
|
+
* // ...
|
|
44
|
+
* }
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
list(query?: StructuredSheetListParams | null | undefined, options?: RequestOptions): PagePromise<StructuredSheetResponsesCursorIDPage, StructuredSheetResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* Delete a structured sheets conversion and its associated exports. This action
|
|
50
|
+
* cannot be undone.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* await client.structuredSheets.delete(
|
|
55
|
+
* 'ss_01abc2def3ghjkmnpqrs4uvwxy',
|
|
56
|
+
* );
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
delete(structuredSheetsID: string, options?: RequestOptions): APIPromise<void>;
|
|
60
|
+
}
|
|
61
|
+
export type StructuredSheetResponsesCursorIDPage = CursorIDPage<StructuredSheetResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Response representing a structured sheets conversion job.
|
|
64
|
+
*
|
|
65
|
+
* This is returned from POST (create), GET (retrieve), and list endpoints.
|
|
66
|
+
*/
|
|
67
|
+
export interface StructuredSheetResponse {
|
|
68
|
+
/**
|
|
69
|
+
* The unique identifier for this structured sheets conversion.
|
|
70
|
+
*/
|
|
71
|
+
id: string;
|
|
72
|
+
/**
|
|
73
|
+
* The timestamp when the conversion was started.
|
|
74
|
+
*/
|
|
75
|
+
created_at: string;
|
|
76
|
+
/**
|
|
77
|
+
* The unique identifier for the source file.
|
|
78
|
+
*/
|
|
79
|
+
file_id: string;
|
|
80
|
+
/**
|
|
81
|
+
* The current processing status.
|
|
82
|
+
*/
|
|
83
|
+
status: 'pending' | 'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
|
|
84
|
+
/**
|
|
85
|
+
* The timestamp when the conversion was last updated.
|
|
86
|
+
*/
|
|
87
|
+
updated_at: string;
|
|
88
|
+
/**
|
|
89
|
+
* List of export formats available for download (e.g., ['sqlite']).
|
|
90
|
+
*/
|
|
91
|
+
exports_available?: Array<string>;
|
|
92
|
+
/**
|
|
93
|
+
* Error information when processing fails.
|
|
94
|
+
*/
|
|
95
|
+
last_error?: StructuredSheetResponse.LastError | null;
|
|
96
|
+
/**
|
|
97
|
+
* The object type, which is always 'structured_sheet'.
|
|
98
|
+
*/
|
|
99
|
+
object?: 'structured_sheet';
|
|
100
|
+
/**
|
|
101
|
+
* List of sheet names included in this conversion.
|
|
102
|
+
*/
|
|
103
|
+
sheet_names?: Array<string>;
|
|
104
|
+
}
|
|
105
|
+
export declare namespace StructuredSheetResponse {
|
|
106
|
+
/**
|
|
107
|
+
* Error information when processing fails.
|
|
108
|
+
*/
|
|
109
|
+
interface LastError {
|
|
110
|
+
/**
|
|
111
|
+
* A machine-readable error code.
|
|
112
|
+
*/
|
|
113
|
+
code: string;
|
|
114
|
+
/**
|
|
115
|
+
* A human-readable description of the error.
|
|
116
|
+
*/
|
|
117
|
+
message: string;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
export interface StructuredSheetCreateParams {
|
|
121
|
+
/**
|
|
122
|
+
* The unique identifier of the file to convert.
|
|
123
|
+
*/
|
|
124
|
+
file_id: string;
|
|
125
|
+
/**
|
|
126
|
+
* List of sheet names to convert. If None, all sheets will be converted.
|
|
127
|
+
*/
|
|
128
|
+
sheet_names?: Array<string> | null;
|
|
129
|
+
}
|
|
130
|
+
export interface StructuredSheetListParams extends CursorIDPageParams {
|
|
131
|
+
}
|
|
132
|
+
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 };
|
|
135
|
+
}
|
|
136
|
+
//# sourceMappingURL=structured-sheets.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.StructuredSheets = void 0;
|
|
5
|
+
const tslib_1 = require("../../internal/tslib.js");
|
|
6
|
+
const resource_1 = require("../../core/resource.js");
|
|
7
|
+
const ExportsAPI = tslib_1.__importStar(require("./exports.js"));
|
|
8
|
+
const exports_1 = require("./exports.js");
|
|
9
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
10
|
+
const headers_1 = require("../../internal/headers.js");
|
|
11
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
12
|
+
class StructuredSheets extends resource_1.APIResource {
|
|
13
|
+
constructor() {
|
|
14
|
+
super(...arguments);
|
|
15
|
+
this.exports = new ExportsAPI.Exports(this._client);
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Start converting a spreadsheet workbook into structured data. This initiates an
|
|
19
|
+
* asynchronous conversion process. Poll the returned resource using the `id` to
|
|
20
|
+
* check completion status.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* const structuredSheetResponse =
|
|
25
|
+
* await client.structuredSheets.create({
|
|
26
|
+
* file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
|
|
27
|
+
* });
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
create(body, options) {
|
|
31
|
+
return this._client.post('/v1/structured-sheets', { body, ...options });
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Get the status and details of a structured sheets conversion.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* const structuredSheetResponse =
|
|
39
|
+
* await client.structuredSheets.retrieve(
|
|
40
|
+
* 'ss_01abc2def3ghjkmnpqrs4uvwxy',
|
|
41
|
+
* );
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
retrieve(structuredSheetsID, options) {
|
|
45
|
+
return this._client.get((0, path_1.path) `/v1/structured-sheets/${structuredSheetsID}`, options);
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* List all structured sheets conversions for the authenticated user. Results are
|
|
49
|
+
* paginated using cursor-based pagination.
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* // Automatically fetches more pages as needed.
|
|
54
|
+
* for await (const structuredSheetResponse of client.structuredSheets.list()) {
|
|
55
|
+
* // ...
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
list(query = {}, options) {
|
|
60
|
+
return this._client.getAPIList('/v1/structured-sheets', (pagination_1.CursorIDPage), {
|
|
61
|
+
query,
|
|
62
|
+
...options,
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Delete a structured sheets conversion and its associated exports. This action
|
|
67
|
+
* cannot be undone.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```ts
|
|
71
|
+
* await client.structuredSheets.delete(
|
|
72
|
+
* 'ss_01abc2def3ghjkmnpqrs4uvwxy',
|
|
73
|
+
* );
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
delete(structuredSheetsID, options) {
|
|
77
|
+
return this._client.delete((0, path_1.path) `/v1/structured-sheets/${structuredSheetsID}`, {
|
|
78
|
+
...options,
|
|
79
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
exports.StructuredSheets = StructuredSheets;
|
|
84
|
+
StructuredSheets.Exports = exports_1.Exports;
|
|
85
|
+
//# sourceMappingURL=structured-sheets.js.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import * as ExportsAPI from "./exports.mjs";
|
|
4
|
+
import { Exports } from "./exports.mjs";
|
|
5
|
+
import { CursorIDPage } from "../../core/pagination.mjs";
|
|
6
|
+
import { buildHeaders } from "../../internal/headers.mjs";
|
|
7
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
8
|
+
export class StructuredSheets extends APIResource {
|
|
9
|
+
constructor() {
|
|
10
|
+
super(...arguments);
|
|
11
|
+
this.exports = new ExportsAPI.Exports(this._client);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Start converting a spreadsheet workbook into structured data. This initiates an
|
|
15
|
+
* asynchronous conversion process. Poll the returned resource using the `id` to
|
|
16
|
+
* check completion status.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```ts
|
|
20
|
+
* const structuredSheetResponse =
|
|
21
|
+
* await client.structuredSheets.create({
|
|
22
|
+
* file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
|
|
23
|
+
* });
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
create(body, options) {
|
|
27
|
+
return this._client.post('/v1/structured-sheets', { body, ...options });
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Get the status and details of a structured sheets conversion.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const structuredSheetResponse =
|
|
35
|
+
* await client.structuredSheets.retrieve(
|
|
36
|
+
* 'ss_01abc2def3ghjkmnpqrs4uvwxy',
|
|
37
|
+
* );
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
retrieve(structuredSheetsID, options) {
|
|
41
|
+
return this._client.get(path `/v1/structured-sheets/${structuredSheetsID}`, options);
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* List all structured sheets conversions for the authenticated user. Results are
|
|
45
|
+
* paginated using cursor-based pagination.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* // Automatically fetches more pages as needed.
|
|
50
|
+
* for await (const structuredSheetResponse of client.structuredSheets.list()) {
|
|
51
|
+
* // ...
|
|
52
|
+
* }
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
list(query = {}, options) {
|
|
56
|
+
return this._client.getAPIList('/v1/structured-sheets', (CursorIDPage), {
|
|
57
|
+
query,
|
|
58
|
+
...options,
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Delete a structured sheets conversion and its associated exports. This action
|
|
63
|
+
* cannot be undone.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* await client.structuredSheets.delete(
|
|
68
|
+
* 'ss_01abc2def3ghjkmnpqrs4uvwxy',
|
|
69
|
+
* );
|
|
70
|
+
* ```
|
|
71
|
+
*/
|
|
72
|
+
delete(structuredSheetsID, options) {
|
|
73
|
+
return this._client.delete(path `/v1/structured-sheets/${structuredSheetsID}`, {
|
|
74
|
+
...options,
|
|
75
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
StructuredSheets.Exports = Exports;
|
|
80
|
+
//# sourceMappingURL=structured-sheets.mjs.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"structured-sheets.d.mts","sourceRoot":"","sources":["../src/resources/structured-sheets.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"structured-sheets.d.ts","sourceRoot":"","sources":["../src/resources/structured-sheets.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
const tslib_1 = require("../internal/tslib.js");
|
|
5
|
+
tslib_1.__exportStar(require("./structured-sheets/index.js"), exports);
|
|
6
|
+
//# sourceMappingURL=structured-sheets.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"structured-sheets.js","sourceRoot":"","sources":["../src/resources/structured-sheets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,uEAA0C"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"structured-sheets.mjs","sourceRoot":"","sources":["../src/resources/structured-sheets.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
|
package/resources.d.mts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.mts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|
package/resources.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|
package/resources.js
ADDED
package/resources.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;AAAA,+DAAkC"}
|
package/resources.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|