pulse-ts-sdk 1.0.8 → 1.0.10
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/README.md +22 -22
- package/dist/cjs/BaseClient.js +3 -2
- package/dist/cjs/Client.d.ts +12 -0
- package/dist/cjs/Client.js +78 -28
- package/dist/cjs/api/client/requests/ExtractAsyncRequest.d.ts +17 -5
- package/dist/cjs/api/client/requests/ExtractAsyncRequest.js +3 -2
- package/dist/cjs/api/client/requests/ExtractRequest.d.ts +17 -5
- package/dist/cjs/api/client/requests/ExtractRequest.js +3 -2
- package/dist/cjs/api/errors/GoneError.d.ts +6 -0
- package/dist/cjs/api/errors/GoneError.js +54 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -0
- package/dist/cjs/api/resources/batch/client/Client.js +32 -16
- package/dist/cjs/api/resources/form/client/Client.d.ts +148 -0
- package/dist/cjs/api/resources/form/client/Client.js +350 -0
- package/dist/cjs/api/resources/form/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/form/client/index.js +17 -0
- package/dist/cjs/api/resources/form/client/requests/FormClearJsonInput.d.ts +19 -0
- package/dist/cjs/api/resources/form/client/requests/FormClearJsonInput.js +3 -0
- package/dist/cjs/api/resources/form/client/requests/FormDetectJsonInput.d.ts +14 -0
- package/dist/cjs/api/resources/form/client/requests/FormDetectJsonInput.js +3 -0
- package/dist/cjs/api/resources/form/client/requests/FormFillJsonInput.d.ts +21 -0
- package/dist/cjs/api/resources/form/client/requests/FormFillJsonInput.js +3 -0
- package/dist/cjs/api/resources/form/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/form/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/form/index.d.ts +1 -0
- package/dist/cjs/api/resources/form/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +8 -0
- package/dist/cjs/api/resources/index.js +9 -1
- package/dist/cjs/api/resources/jobs/client/Client.js +16 -8
- package/dist/cjs/api/resources/largeResults/client/Client.d.ts +41 -0
- package/dist/cjs/api/resources/largeResults/client/Client.js +131 -0
- package/dist/cjs/api/resources/largeResults/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/largeResults/client/index.js +17 -0
- package/dist/cjs/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.js +3 -0
- package/dist/cjs/api/resources/largeResults/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/largeResults/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/largeResults/index.d.ts +1 -0
- package/dist/cjs/api/resources/largeResults/index.js +17 -0
- package/dist/cjs/api/resources/pipeline/client/Client.d.ts +57 -0
- package/dist/cjs/api/resources/pipeline/client/Client.js +151 -0
- package/dist/cjs/api/resources/pipeline/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/pipeline/client/index.js +17 -0
- package/dist/cjs/api/resources/pipeline/client/requests/PipelineExecuteInput.d.ts +17 -0
- package/dist/cjs/api/resources/pipeline/client/requests/PipelineExecuteInput.js +3 -0
- package/dist/cjs/api/resources/pipeline/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/pipeline/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/pipeline/index.d.ts +1 -0
- package/dist/cjs/api/resources/pipeline/index.js +17 -0
- package/dist/cjs/api/resources/results/client/Client.d.ts +27 -0
- package/dist/cjs/api/resources/results/client/Client.js +116 -0
- package/dist/cjs/api/resources/results/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/results/client/index.js +17 -0
- package/dist/cjs/api/resources/results/client/requests/GetPdfResultsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/results/client/requests/GetPdfResultsRequest.js +3 -0
- package/dist/cjs/api/resources/results/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/results/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/results/index.d.ts +1 -0
- package/dist/cjs/api/resources/results/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +8 -4
- package/dist/cjs/api/types/AsyncSubmissionResponse.d.ts +2 -0
- package/dist/cjs/api/types/ExtractInput.d.ts +17 -5
- package/dist/cjs/api/types/ExtractInput.js +3 -2
- package/dist/cjs/api/types/ExtractLargeResultResponse.d.ts +25 -0
- package/dist/cjs/api/types/ExtractLargeResultResponse.js +3 -0
- package/dist/cjs/api/types/ExtractOptions.d.ts +17 -5
- package/dist/cjs/api/types/ExtractOptions.js +3 -2
- package/dist/cjs/api/types/ExtractResponse.d.ts +3 -3
- package/dist/cjs/api/types/ExtractResultCore.d.ts +112 -0
- package/dist/cjs/api/types/ExtractResultCore.js +3 -0
- package/dist/cjs/api/types/FormCell.d.ts +40 -0
- package/dist/cjs/api/types/FormCell.js +13 -0
- package/dist/cjs/api/types/FormCheckboxDetail.d.ts +11 -0
- package/dist/cjs/api/types/FormCheckboxDetail.js +3 -0
- package/dist/cjs/api/types/FormClearMultipartInput.d.ts +21 -0
- package/dist/cjs/api/types/FormClearMultipartInput.js +3 -0
- package/dist/cjs/api/types/FormDetectMultipartInput.d.ts +16 -0
- package/dist/cjs/api/types/FormDetectMultipartInput.js +3 -0
- package/dist/cjs/api/types/FormFillMultipartInput.d.ts +21 -0
- package/dist/cjs/api/types/FormFillMultipartInput.js +3 -0
- package/dist/cjs/api/types/FormFillSharedOptions.d.ts +12 -0
- package/dist/cjs/api/types/FormFillSharedOptions.js +3 -0
- package/dist/cjs/api/types/FormPlanInfo.d.ts +11 -0
- package/dist/cjs/api/types/FormPlanInfo.js +3 -0
- package/dist/cjs/api/types/FormResult.d.ts +24 -0
- package/dist/cjs/api/types/FormResult.js +3 -0
- package/dist/cjs/api/types/FormSharedOptions.d.ts +9 -0
- package/dist/cjs/api/types/FormSharedOptions.js +3 -0
- package/dist/cjs/api/types/GoneErrorBody.d.ts +9 -0
- package/dist/cjs/api/types/GoneErrorBody.js +3 -0
- package/dist/cjs/api/types/JobStatusResponse.d.ts +1 -1
- package/dist/cjs/api/types/PipelineBatchExtractResult.d.ts +13 -0
- package/dist/cjs/api/types/PipelineBatchExtractResult.js +3 -0
- package/dist/cjs/api/types/PipelineExecuteMultipartInput.d.ts +13 -0
- package/dist/cjs/api/types/PipelineExecuteMultipartInput.js +3 -0
- package/dist/cjs/api/types/PipelineExecuteResponse.d.ts +21 -0
- package/dist/cjs/api/types/PipelineExecuteResponse.js +11 -0
- package/dist/cjs/api/types/PipelineExtractResult.d.ts +118 -0
- package/dist/cjs/api/types/PipelineExtractResult.js +3 -0
- package/dist/cjs/api/types/PipelineResults.d.ts +16 -0
- package/dist/cjs/api/types/PipelineResults.js +3 -0
- package/dist/cjs/api/types/PipelineSchemaResult.d.ts +14 -0
- package/dist/cjs/api/types/PipelineSchemaResult.js +3 -0
- package/dist/cjs/api/types/PipelineSplitResult.d.ts +18 -0
- package/dist/cjs/api/types/PipelineSplitResult.js +3 -0
- package/dist/cjs/api/types/PipelineStepBatchExtractConfig.d.ts +147 -0
- package/dist/cjs/api/types/PipelineStepBatchExtractConfig.js +27 -0
- package/dist/cjs/api/types/PipelineSteps.d.ts +16 -0
- package/dist/cjs/api/types/PipelineSteps.js +3 -0
- package/dist/cjs/api/types/PipelineTablesResult.d.ts +33 -0
- package/dist/cjs/api/types/PipelineTablesResult.js +3 -0
- package/dist/cjs/api/types/SingleSchemaResponse.d.ts +2 -0
- package/dist/cjs/api/types/SplitResponse.d.ts +1 -6
- package/dist/cjs/api/types/SplitResultCore.d.ts +12 -0
- package/dist/cjs/api/types/SplitResultCore.js +3 -0
- package/dist/cjs/api/types/SplitSchemaResponse.d.ts +2 -0
- package/dist/cjs/api/types/TablesConfig.d.ts +5 -2
- package/dist/cjs/api/types/TablesConfig.js +2 -1
- package/dist/cjs/api/types/TablesResponse.d.ts +4 -2
- package/dist/cjs/api/types/index.d.ts +23 -0
- package/dist/cjs/api/types/index.js +23 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +3 -2
- package/dist/esm/Client.d.mts +12 -0
- package/dist/esm/Client.mjs +74 -24
- package/dist/esm/api/client/requests/ExtractAsyncRequest.d.mts +17 -5
- package/dist/esm/api/client/requests/ExtractAsyncRequest.mjs +3 -2
- package/dist/esm/api/client/requests/ExtractRequest.d.mts +17 -5
- package/dist/esm/api/client/requests/ExtractRequest.mjs +3 -2
- package/dist/esm/api/errors/GoneError.d.mts +6 -0
- package/dist/esm/api/errors/GoneError.mjs +17 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/resources/batch/client/Client.mjs +32 -16
- package/dist/esm/api/resources/form/client/Client.d.mts +148 -0
- package/dist/esm/api/resources/form/client/Client.mjs +313 -0
- package/dist/esm/api/resources/form/client/index.d.mts +1 -0
- package/dist/esm/api/resources/form/client/index.mjs +1 -0
- package/dist/esm/api/resources/form/client/requests/FormClearJsonInput.d.mts +19 -0
- package/dist/esm/api/resources/form/client/requests/FormClearJsonInput.mjs +2 -0
- package/dist/esm/api/resources/form/client/requests/FormDetectJsonInput.d.mts +14 -0
- package/dist/esm/api/resources/form/client/requests/FormDetectJsonInput.mjs +2 -0
- package/dist/esm/api/resources/form/client/requests/FormFillJsonInput.d.mts +21 -0
- package/dist/esm/api/resources/form/client/requests/FormFillJsonInput.mjs +2 -0
- package/dist/esm/api/resources/form/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/form/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/form/index.d.mts +1 -0
- package/dist/esm/api/resources/form/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +8 -0
- package/dist/esm/api/resources/index.mjs +8 -0
- package/dist/esm/api/resources/jobs/client/Client.mjs +16 -8
- package/dist/esm/api/resources/largeResults/client/Client.d.mts +41 -0
- package/dist/esm/api/resources/largeResults/client/Client.mjs +94 -0
- package/dist/esm/api/resources/largeResults/client/index.d.mts +1 -0
- package/dist/esm/api/resources/largeResults/client/index.mjs +1 -0
- package/dist/esm/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.d.mts +10 -0
- package/dist/esm/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.mjs +2 -0
- package/dist/esm/api/resources/largeResults/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/largeResults/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/largeResults/index.d.mts +1 -0
- package/dist/esm/api/resources/largeResults/index.mjs +1 -0
- package/dist/esm/api/resources/pipeline/client/Client.d.mts +57 -0
- package/dist/esm/api/resources/pipeline/client/Client.mjs +114 -0
- package/dist/esm/api/resources/pipeline/client/index.d.mts +1 -0
- package/dist/esm/api/resources/pipeline/client/index.mjs +1 -0
- package/dist/esm/api/resources/pipeline/client/requests/PipelineExecuteInput.d.mts +17 -0
- package/dist/esm/api/resources/pipeline/client/requests/PipelineExecuteInput.mjs +2 -0
- package/dist/esm/api/resources/pipeline/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/pipeline/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/pipeline/index.d.mts +1 -0
- package/dist/esm/api/resources/pipeline/index.mjs +1 -0
- package/dist/esm/api/resources/results/client/Client.d.mts +27 -0
- package/dist/esm/api/resources/results/client/Client.mjs +79 -0
- package/dist/esm/api/resources/results/client/index.d.mts +1 -0
- package/dist/esm/api/resources/results/client/index.mjs +1 -0
- package/dist/esm/api/resources/results/client/requests/GetPdfResultsRequest.d.mts +10 -0
- package/dist/esm/api/resources/results/client/requests/GetPdfResultsRequest.mjs +2 -0
- package/dist/esm/api/resources/results/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/results/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/results/index.d.mts +1 -0
- package/dist/esm/api/resources/results/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +8 -4
- package/dist/esm/api/types/AsyncSubmissionResponse.d.mts +2 -0
- package/dist/esm/api/types/ExtractInput.d.mts +17 -5
- package/dist/esm/api/types/ExtractInput.mjs +3 -2
- package/dist/esm/api/types/ExtractLargeResultResponse.d.mts +25 -0
- package/dist/esm/api/types/ExtractLargeResultResponse.mjs +2 -0
- package/dist/esm/api/types/ExtractOptions.d.mts +17 -5
- package/dist/esm/api/types/ExtractOptions.mjs +3 -2
- package/dist/esm/api/types/ExtractResponse.d.mts +3 -3
- package/dist/esm/api/types/ExtractResultCore.d.mts +112 -0
- package/dist/esm/api/types/ExtractResultCore.mjs +2 -0
- package/dist/esm/api/types/FormCell.d.mts +40 -0
- package/dist/esm/api/types/FormCell.mjs +10 -0
- package/dist/esm/api/types/FormCheckboxDetail.d.mts +11 -0
- package/dist/esm/api/types/FormCheckboxDetail.mjs +2 -0
- package/dist/esm/api/types/FormClearMultipartInput.d.mts +21 -0
- package/dist/esm/api/types/FormClearMultipartInput.mjs +2 -0
- package/dist/esm/api/types/FormDetectMultipartInput.d.mts +16 -0
- package/dist/esm/api/types/FormDetectMultipartInput.mjs +2 -0
- package/dist/esm/api/types/FormFillMultipartInput.d.mts +21 -0
- package/dist/esm/api/types/FormFillMultipartInput.mjs +2 -0
- package/dist/esm/api/types/FormFillSharedOptions.d.mts +12 -0
- package/dist/esm/api/types/FormFillSharedOptions.mjs +2 -0
- package/dist/esm/api/types/FormPlanInfo.d.mts +11 -0
- package/dist/esm/api/types/FormPlanInfo.mjs +2 -0
- package/dist/esm/api/types/FormResult.d.mts +24 -0
- package/dist/esm/api/types/FormResult.mjs +2 -0
- package/dist/esm/api/types/FormSharedOptions.d.mts +9 -0
- package/dist/esm/api/types/FormSharedOptions.mjs +2 -0
- package/dist/esm/api/types/GoneErrorBody.d.mts +9 -0
- package/dist/esm/api/types/GoneErrorBody.mjs +2 -0
- package/dist/esm/api/types/JobStatusResponse.d.mts +1 -1
- package/dist/esm/api/types/PipelineBatchExtractResult.d.mts +13 -0
- package/dist/esm/api/types/PipelineBatchExtractResult.mjs +2 -0
- package/dist/esm/api/types/PipelineExecuteMultipartInput.d.mts +13 -0
- package/dist/esm/api/types/PipelineExecuteMultipartInput.mjs +2 -0
- package/dist/esm/api/types/PipelineExecuteResponse.d.mts +21 -0
- package/dist/esm/api/types/PipelineExecuteResponse.mjs +8 -0
- package/dist/esm/api/types/PipelineExtractResult.d.mts +118 -0
- package/dist/esm/api/types/PipelineExtractResult.mjs +2 -0
- package/dist/esm/api/types/PipelineResults.d.mts +16 -0
- package/dist/esm/api/types/PipelineResults.mjs +2 -0
- package/dist/esm/api/types/PipelineSchemaResult.d.mts +14 -0
- package/dist/esm/api/types/PipelineSchemaResult.mjs +2 -0
- package/dist/esm/api/types/PipelineSplitResult.d.mts +18 -0
- package/dist/esm/api/types/PipelineSplitResult.mjs +2 -0
- package/dist/esm/api/types/PipelineStepBatchExtractConfig.d.mts +147 -0
- package/dist/esm/api/types/PipelineStepBatchExtractConfig.mjs +24 -0
- package/dist/esm/api/types/PipelineSteps.d.mts +16 -0
- package/dist/esm/api/types/PipelineSteps.mjs +2 -0
- package/dist/esm/api/types/PipelineTablesResult.d.mts +33 -0
- package/dist/esm/api/types/PipelineTablesResult.mjs +2 -0
- package/dist/esm/api/types/SingleSchemaResponse.d.mts +2 -0
- package/dist/esm/api/types/SplitResponse.d.mts +1 -6
- package/dist/esm/api/types/SplitResultCore.d.mts +12 -0
- package/dist/esm/api/types/SplitResultCore.mjs +2 -0
- package/dist/esm/api/types/SplitSchemaResponse.d.mts +2 -0
- package/dist/esm/api/types/TablesConfig.d.mts +5 -2
- package/dist/esm/api/types/TablesConfig.mjs +2 -1
- package/dist/esm/api/types/TablesResponse.d.mts +4 -2
- package/dist/esm/api/types/index.d.mts +23 -0
- package/dist/esm/api/types/index.mjs +23 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +513 -0
package/README.md
CHANGED
|
@@ -55,7 +55,7 @@ following namespace:
|
|
|
55
55
|
```typescript
|
|
56
56
|
import { Pulse } from "pulse-ts-sdk";
|
|
57
57
|
|
|
58
|
-
const request: Pulse.
|
|
58
|
+
const request: Pulse.FormDetectJsonInput = {
|
|
59
59
|
...
|
|
60
60
|
};
|
|
61
61
|
```
|
|
@@ -126,7 +126,7 @@ For example, `fs.ReadStream` has a `path` property which the SDK uses to retriev
|
|
|
126
126
|
You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
|
|
127
127
|
|
|
128
128
|
```typescript
|
|
129
|
-
const response = await client.
|
|
129
|
+
const response = await client.results.getPdf(...);
|
|
130
130
|
const stream: ReadableStream<Uint8Array> = response.stream();
|
|
131
131
|
// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
|
|
132
132
|
// const blob: Blob = response.blob();
|
|
@@ -151,7 +151,7 @@ import { createWriteStream } from 'fs';
|
|
|
151
151
|
import { Readable } from 'stream';
|
|
152
152
|
import { pipeline } from 'stream/promises';
|
|
153
153
|
|
|
154
|
-
const response = await client.
|
|
154
|
+
const response = await client.results.getPdf(...);
|
|
155
155
|
|
|
156
156
|
const stream = response.stream();
|
|
157
157
|
const nodeStream = Readable.fromWeb(stream);
|
|
@@ -170,7 +170,7 @@ await pipeline(nodeStream, writeStream);
|
|
|
170
170
|
```ts
|
|
171
171
|
import { writeFile } from 'fs/promises';
|
|
172
172
|
|
|
173
|
-
const response = await client.
|
|
173
|
+
const response = await client.results.getPdf(...);
|
|
174
174
|
|
|
175
175
|
const arrayBuffer = await response.arrayBuffer();
|
|
176
176
|
await writeFile('path/to/file', Buffer.from(arrayBuffer));
|
|
@@ -186,7 +186,7 @@ await writeFile('path/to/file', Buffer.from(arrayBuffer));
|
|
|
186
186
|
```ts
|
|
187
187
|
import { writeFile } from 'fs/promises';
|
|
188
188
|
|
|
189
|
-
const response = await client.
|
|
189
|
+
const response = await client.results.getPdf(...);
|
|
190
190
|
|
|
191
191
|
const blob = await response.blob();
|
|
192
192
|
const arrayBuffer = await blob.arrayBuffer();
|
|
@@ -203,7 +203,7 @@ await writeFile('output.bin', Buffer.from(arrayBuffer));
|
|
|
203
203
|
```ts
|
|
204
204
|
import { writeFile } from 'fs/promises';
|
|
205
205
|
|
|
206
|
-
const response = await client.
|
|
206
|
+
const response = await client.results.getPdf(...);
|
|
207
207
|
|
|
208
208
|
const bytes = await response.bytes();
|
|
209
209
|
await writeFile('path/to/file', bytes);
|
|
@@ -224,7 +224,7 @@ await writeFile('path/to/file', bytes);
|
|
|
224
224
|
<summary>ReadableStream (most-efficient)</summary>
|
|
225
225
|
|
|
226
226
|
```ts
|
|
227
|
-
const response = await client.
|
|
227
|
+
const response = await client.results.getPdf(...);
|
|
228
228
|
|
|
229
229
|
const stream = response.stream();
|
|
230
230
|
await Bun.write('path/to/file', stream);
|
|
@@ -238,7 +238,7 @@ await Bun.write('path/to/file', stream);
|
|
|
238
238
|
<summary>ArrayBuffer</summary>
|
|
239
239
|
|
|
240
240
|
```ts
|
|
241
|
-
const response = await client.
|
|
241
|
+
const response = await client.results.getPdf(...);
|
|
242
242
|
|
|
243
243
|
const arrayBuffer = await response.arrayBuffer();
|
|
244
244
|
await Bun.write('path/to/file', arrayBuffer);
|
|
@@ -252,7 +252,7 @@ await Bun.write('path/to/file', arrayBuffer);
|
|
|
252
252
|
<summary>Blob</summary>
|
|
253
253
|
|
|
254
254
|
```ts
|
|
255
|
-
const response = await client.
|
|
255
|
+
const response = await client.results.getPdf(...);
|
|
256
256
|
|
|
257
257
|
const blob = await response.blob();
|
|
258
258
|
await Bun.write('path/to/file', blob);
|
|
@@ -266,7 +266,7 @@ await Bun.write('path/to/file', blob);
|
|
|
266
266
|
<summary>Bytes (UIntArray8)</summary>
|
|
267
267
|
|
|
268
268
|
```ts
|
|
269
|
-
const response = await client.
|
|
269
|
+
const response = await client.results.getPdf(...);
|
|
270
270
|
|
|
271
271
|
const bytes = await response.bytes();
|
|
272
272
|
await Bun.write('path/to/file', bytes);
|
|
@@ -287,7 +287,7 @@ await Bun.write('path/to/file', bytes);
|
|
|
287
287
|
<summary>ReadableStream (most-efficient)</summary>
|
|
288
288
|
|
|
289
289
|
```ts
|
|
290
|
-
const response = await client.
|
|
290
|
+
const response = await client.results.getPdf(...);
|
|
291
291
|
|
|
292
292
|
const stream = response.stream();
|
|
293
293
|
const file = await Deno.open('path/to/file', { write: true, create: true });
|
|
@@ -302,7 +302,7 @@ await stream.pipeTo(file.writable);
|
|
|
302
302
|
<summary>ArrayBuffer</summary>
|
|
303
303
|
|
|
304
304
|
```ts
|
|
305
|
-
const response = await client.
|
|
305
|
+
const response = await client.results.getPdf(...);
|
|
306
306
|
|
|
307
307
|
const arrayBuffer = await response.arrayBuffer();
|
|
308
308
|
await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
|
|
@@ -316,7 +316,7 @@ await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
|
|
|
316
316
|
<summary>Blob</summary>
|
|
317
317
|
|
|
318
318
|
```ts
|
|
319
|
-
const response = await client.
|
|
319
|
+
const response = await client.results.getPdf(...);
|
|
320
320
|
|
|
321
321
|
const blob = await response.blob();
|
|
322
322
|
const arrayBuffer = await blob.arrayBuffer();
|
|
@@ -331,7 +331,7 @@ await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
|
|
|
331
331
|
<summary>Bytes (UIntArray8)</summary>
|
|
332
332
|
|
|
333
333
|
```ts
|
|
334
|
-
const response = await client.
|
|
334
|
+
const response = await client.results.getPdf(...);
|
|
335
335
|
|
|
336
336
|
const bytes = await response.bytes();
|
|
337
337
|
await Deno.writeFile('path/to/file', bytes);
|
|
@@ -352,7 +352,7 @@ await Deno.writeFile('path/to/file', bytes);
|
|
|
352
352
|
<summary>Blob (most-efficient)</summary>
|
|
353
353
|
|
|
354
354
|
```ts
|
|
355
|
-
const response = await client.
|
|
355
|
+
const response = await client.results.getPdf(...);
|
|
356
356
|
|
|
357
357
|
const blob = await response.blob();
|
|
358
358
|
const url = URL.createObjectURL(blob);
|
|
@@ -373,7 +373,7 @@ URL.revokeObjectURL(url);
|
|
|
373
373
|
<summary>ReadableStream</summary>
|
|
374
374
|
|
|
375
375
|
```ts
|
|
376
|
-
const response = await client.
|
|
376
|
+
const response = await client.results.getPdf(...);
|
|
377
377
|
|
|
378
378
|
const stream = response.stream();
|
|
379
379
|
const reader = stream.getReader();
|
|
@@ -404,7 +404,7 @@ URL.revokeObjectURL(url);
|
|
|
404
404
|
<summary>ArrayBuffer</summary>
|
|
405
405
|
|
|
406
406
|
```ts
|
|
407
|
-
const response = await client.
|
|
407
|
+
const response = await client.results.getPdf(...);
|
|
408
408
|
|
|
409
409
|
const arrayBuffer = await response.arrayBuffer();
|
|
410
410
|
const blob = new Blob([arrayBuffer]);
|
|
@@ -426,7 +426,7 @@ URL.revokeObjectURL(url);
|
|
|
426
426
|
<summary>Bytes (UIntArray8)</summary>
|
|
427
427
|
|
|
428
428
|
```ts
|
|
429
|
-
const response = await client.
|
|
429
|
+
const response = await client.results.getPdf(...);
|
|
430
430
|
|
|
431
431
|
const bytes = await response.bytes();
|
|
432
432
|
const blob = new Blob([bytes]);
|
|
@@ -457,7 +457,7 @@ URL.revokeObjectURL(url);
|
|
|
457
457
|
<summary>ReadableStream</summary>
|
|
458
458
|
|
|
459
459
|
```ts
|
|
460
|
-
const response = await client.
|
|
460
|
+
const response = await client.results.getPdf(...);
|
|
461
461
|
|
|
462
462
|
const stream = response.stream();
|
|
463
463
|
const text = await new Response(stream).text();
|
|
@@ -471,7 +471,7 @@ const text = await new Response(stream).text();
|
|
|
471
471
|
<summary>ArrayBuffer</summary>
|
|
472
472
|
|
|
473
473
|
```ts
|
|
474
|
-
const response = await client.
|
|
474
|
+
const response = await client.results.getPdf(...);
|
|
475
475
|
|
|
476
476
|
const arrayBuffer = await response.arrayBuffer();
|
|
477
477
|
const text = new TextDecoder().decode(arrayBuffer);
|
|
@@ -485,7 +485,7 @@ const text = new TextDecoder().decode(arrayBuffer);
|
|
|
485
485
|
<summary>Blob</summary>
|
|
486
486
|
|
|
487
487
|
```ts
|
|
488
|
-
const response = await client.
|
|
488
|
+
const response = await client.results.getPdf(...);
|
|
489
489
|
|
|
490
490
|
const blob = await response.blob();
|
|
491
491
|
const text = await blob.text();
|
|
@@ -499,7 +499,7 @@ const text = await blob.text();
|
|
|
499
499
|
<summary>Bytes (UIntArray8)</summary>
|
|
500
500
|
|
|
501
501
|
```ts
|
|
502
|
-
const response = await client.
|
|
502
|
+
const response = await client.results.getPdf(...);
|
|
503
503
|
|
|
504
504
|
const bytes = await response.bytes();
|
|
505
505
|
const text = new TextDecoder().decode(bytes);
|
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,10 +43,11 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "pulse-ts-sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "1.0.
|
|
47
|
-
"User-Agent": "pulse-ts-sdk/1.0.
|
|
46
|
+
"X-Fern-SDK-Version": "1.0.9",
|
|
47
|
+
"User-Agent": "pulse-ts-sdk/1.0.9",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
|
+
"X-Pulse-Source": "sdk-typescript",
|
|
50
51
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
51
52
|
return Object.assign(Object.assign({}, options), { logging: core.logging.createLogger(options === null || options === void 0 ? void 0 : options.logging), headers });
|
|
52
53
|
}
|
package/dist/cjs/Client.d.ts
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import * as Pulse from "./api/index.js";
|
|
2
2
|
import { BatchClient } from "./api/resources/batch/client/Client.js";
|
|
3
|
+
import { FormClient } from "./api/resources/form/client/Client.js";
|
|
3
4
|
import { JobsClient } from "./api/resources/jobs/client/Client.js";
|
|
5
|
+
import { LargeResultsClient } from "./api/resources/largeResults/client/Client.js";
|
|
6
|
+
import { PipelineClient } from "./api/resources/pipeline/client/Client.js";
|
|
7
|
+
import { ResultsClient } from "./api/resources/results/client/Client.js";
|
|
4
8
|
import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
|
|
5
9
|
import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
|
|
6
10
|
import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
|
|
@@ -12,12 +16,20 @@ export declare namespace PulseClient {
|
|
|
12
16
|
}
|
|
13
17
|
export declare class PulseClient {
|
|
14
18
|
protected readonly _options: NormalizedClientOptionsWithAuth<PulseClient.Options>;
|
|
19
|
+
protected _form: FormClient | undefined;
|
|
15
20
|
protected _batch: BatchClient | undefined;
|
|
21
|
+
protected _pipeline: PipelineClient | undefined;
|
|
16
22
|
protected _jobs: JobsClient | undefined;
|
|
23
|
+
protected _results: ResultsClient | undefined;
|
|
24
|
+
protected _largeResults: LargeResultsClient | undefined;
|
|
17
25
|
protected _webhooks: WebhooksClient | undefined;
|
|
18
26
|
constructor(options?: PulseClient.Options);
|
|
27
|
+
get form(): FormClient;
|
|
19
28
|
get batch(): BatchClient;
|
|
29
|
+
get pipeline(): PipelineClient;
|
|
20
30
|
get jobs(): JobsClient;
|
|
31
|
+
get results(): ResultsClient;
|
|
32
|
+
get largeResults(): LargeResultsClient;
|
|
21
33
|
get webhooks(): WebhooksClient;
|
|
22
34
|
/**
|
|
23
35
|
* The primary endpoint for the Pulse API. Parses uploaded documents or remote
|
package/dist/cjs/Client.js
CHANGED
|
@@ -46,8 +46,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
46
46
|
exports.PulseClient = void 0;
|
|
47
47
|
const Pulse = __importStar(require("./api/index.js"));
|
|
48
48
|
const Client_js_1 = require("./api/resources/batch/client/Client.js");
|
|
49
|
-
const Client_js_2 = require("./api/resources/
|
|
50
|
-
const Client_js_3 = require("./api/resources/
|
|
49
|
+
const Client_js_2 = require("./api/resources/form/client/Client.js");
|
|
50
|
+
const Client_js_3 = require("./api/resources/jobs/client/Client.js");
|
|
51
|
+
const Client_js_4 = require("./api/resources/largeResults/client/Client.js");
|
|
52
|
+
const Client_js_5 = require("./api/resources/pipeline/client/Client.js");
|
|
53
|
+
const Client_js_6 = require("./api/resources/results/client/Client.js");
|
|
54
|
+
const Client_js_7 = require("./api/resources/webhooks/client/Client.js");
|
|
51
55
|
const BaseClient_js_1 = require("./BaseClient.js");
|
|
52
56
|
const headers_js_1 = require("./core/headers.js");
|
|
53
57
|
const core = __importStar(require("./core/index.js"));
|
|
@@ -59,17 +63,33 @@ class PulseClient {
|
|
|
59
63
|
constructor(options = {}) {
|
|
60
64
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
61
65
|
}
|
|
66
|
+
get form() {
|
|
67
|
+
var _a;
|
|
68
|
+
return ((_a = this._form) !== null && _a !== void 0 ? _a : (this._form = new Client_js_2.FormClient(this._options)));
|
|
69
|
+
}
|
|
62
70
|
get batch() {
|
|
63
71
|
var _a;
|
|
64
72
|
return ((_a = this._batch) !== null && _a !== void 0 ? _a : (this._batch = new Client_js_1.BatchClient(this._options)));
|
|
65
73
|
}
|
|
74
|
+
get pipeline() {
|
|
75
|
+
var _a;
|
|
76
|
+
return ((_a = this._pipeline) !== null && _a !== void 0 ? _a : (this._pipeline = new Client_js_5.PipelineClient(this._options)));
|
|
77
|
+
}
|
|
66
78
|
get jobs() {
|
|
67
79
|
var _a;
|
|
68
|
-
return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new
|
|
80
|
+
return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new Client_js_3.JobsClient(this._options)));
|
|
81
|
+
}
|
|
82
|
+
get results() {
|
|
83
|
+
var _a;
|
|
84
|
+
return ((_a = this._results) !== null && _a !== void 0 ? _a : (this._results = new Client_js_6.ResultsClient(this._options)));
|
|
85
|
+
}
|
|
86
|
+
get largeResults() {
|
|
87
|
+
var _a;
|
|
88
|
+
return ((_a = this._largeResults) !== null && _a !== void 0 ? _a : (this._largeResults = new Client_js_4.LargeResultsClient(this._options)));
|
|
69
89
|
}
|
|
70
90
|
get webhooks() {
|
|
71
91
|
var _a;
|
|
72
|
-
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new
|
|
92
|
+
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_7.WebhooksClient(this._options)));
|
|
73
93
|
}
|
|
74
94
|
/**
|
|
75
95
|
* The primary endpoint for the Pulse API. Parses uploaded documents or remote
|
|
@@ -98,7 +118,7 @@ class PulseClient {
|
|
|
98
118
|
}
|
|
99
119
|
__extract(request, requestOptions) {
|
|
100
120
|
return __awaiter(this, void 0, void 0, function* () {
|
|
101
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
121
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
102
122
|
const _request = yield core.newFormData();
|
|
103
123
|
if (request.file != null) {
|
|
104
124
|
yield _request.appendFile("file", request.file);
|
|
@@ -118,6 +138,9 @@ class PulseClient {
|
|
|
118
138
|
if (request.extensions != null) {
|
|
119
139
|
_request.append("extensions", (0, json_js_1.toJson)(request.extensions));
|
|
120
140
|
}
|
|
141
|
+
if (request.spreadsheet != null) {
|
|
142
|
+
_request.append("spreadsheet", (0, json_js_1.toJson)(request.spreadsheet));
|
|
143
|
+
}
|
|
121
144
|
if (request.storage != null) {
|
|
122
145
|
_request.append("storage", (0, json_js_1.toJson)(request.storage));
|
|
123
146
|
}
|
|
@@ -168,10 +191,14 @@ class PulseClient {
|
|
|
168
191
|
requestType: "file",
|
|
169
192
|
duplex: _maybeEncodedRequest.duplex,
|
|
170
193
|
body: _maybeEncodedRequest.body,
|
|
171
|
-
timeoutMs: (
|
|
172
|
-
|
|
194
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
195
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
196
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
197
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
198
|
+
: undefined,
|
|
199
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
173
200
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
174
|
-
fetchFn: (
|
|
201
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
175
202
|
logging: this._options.logging,
|
|
176
203
|
});
|
|
177
204
|
if (_response.ok) {
|
|
@@ -219,7 +246,7 @@ class PulseClient {
|
|
|
219
246
|
}
|
|
220
247
|
__extractAsync(request, requestOptions) {
|
|
221
248
|
return __awaiter(this, void 0, void 0, function* () {
|
|
222
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
249
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
223
250
|
const _request = yield core.newFormData();
|
|
224
251
|
if (request.file != null) {
|
|
225
252
|
yield _request.appendFile("file", request.file);
|
|
@@ -239,6 +266,9 @@ class PulseClient {
|
|
|
239
266
|
if (request.extensions != null) {
|
|
240
267
|
_request.append("extensions", (0, json_js_1.toJson)(request.extensions));
|
|
241
268
|
}
|
|
269
|
+
if (request.spreadsheet != null) {
|
|
270
|
+
_request.append("spreadsheet", (0, json_js_1.toJson)(request.spreadsheet));
|
|
271
|
+
}
|
|
242
272
|
if (request.storage != null) {
|
|
243
273
|
_request.append("storage", (0, json_js_1.toJson)(request.storage));
|
|
244
274
|
}
|
|
@@ -289,10 +319,14 @@ class PulseClient {
|
|
|
289
319
|
requestType: "file",
|
|
290
320
|
duplex: _maybeEncodedRequest.duplex,
|
|
291
321
|
body: _maybeEncodedRequest.body,
|
|
292
|
-
timeoutMs: (
|
|
293
|
-
|
|
322
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
323
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
324
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
325
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
326
|
+
: undefined,
|
|
327
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
294
328
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
295
|
-
fetchFn: (
|
|
329
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
296
330
|
logging: this._options.logging,
|
|
297
331
|
});
|
|
298
332
|
if (_response.ok) {
|
|
@@ -350,7 +384,7 @@ class PulseClient {
|
|
|
350
384
|
}
|
|
351
385
|
__split(request, requestOptions) {
|
|
352
386
|
return __awaiter(this, void 0, void 0, function* () {
|
|
353
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
387
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
354
388
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
355
389
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
356
390
|
const _response = yield core.fetcher({
|
|
@@ -361,10 +395,14 @@ class PulseClient {
|
|
|
361
395
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
362
396
|
requestType: "json",
|
|
363
397
|
body: request,
|
|
364
|
-
timeoutMs: (
|
|
365
|
-
|
|
398
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
399
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
400
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
401
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
402
|
+
: undefined,
|
|
403
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
366
404
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
367
|
-
fetchFn: (
|
|
405
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
368
406
|
logging: this._options.logging,
|
|
369
407
|
});
|
|
370
408
|
if (_response.ok) {
|
|
@@ -438,7 +476,7 @@ class PulseClient {
|
|
|
438
476
|
}
|
|
439
477
|
__schema() {
|
|
440
478
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
441
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
479
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
442
480
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
443
481
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
444
482
|
const _response = yield core.fetcher({
|
|
@@ -449,10 +487,14 @@ class PulseClient {
|
|
|
449
487
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
450
488
|
requestType: "json",
|
|
451
489
|
body: request,
|
|
452
|
-
timeoutMs: (
|
|
453
|
-
|
|
490
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
491
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
492
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
493
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
494
|
+
: undefined,
|
|
495
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
454
496
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
455
|
-
fetchFn: (
|
|
497
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
456
498
|
logging: this._options.logging,
|
|
457
499
|
});
|
|
458
500
|
if (_response.ok) {
|
|
@@ -494,7 +536,7 @@ class PulseClient {
|
|
|
494
536
|
}
|
|
495
537
|
__downloadSchemaExcel(request, requestOptions) {
|
|
496
538
|
return __awaiter(this, void 0, void 0, function* () {
|
|
497
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
539
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
498
540
|
const { schemaId } = request;
|
|
499
541
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
500
542
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -504,10 +546,14 @@ class PulseClient {
|
|
|
504
546
|
headers: _headers,
|
|
505
547
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
506
548
|
responseType: "binary-response",
|
|
507
|
-
timeoutMs: (
|
|
508
|
-
|
|
549
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
550
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
551
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
552
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
553
|
+
: undefined,
|
|
554
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
509
555
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
510
|
-
fetchFn: (
|
|
556
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
511
557
|
logging: this._options.logging,
|
|
512
558
|
});
|
|
513
559
|
if (_response.ok) {
|
|
@@ -564,7 +610,7 @@ class PulseClient {
|
|
|
564
610
|
}
|
|
565
611
|
__tables(request, requestOptions) {
|
|
566
612
|
return __awaiter(this, void 0, void 0, function* () {
|
|
567
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
613
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
568
614
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
569
615
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
570
616
|
const _response = yield core.fetcher({
|
|
@@ -575,10 +621,14 @@ class PulseClient {
|
|
|
575
621
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
576
622
|
requestType: "json",
|
|
577
623
|
body: request,
|
|
578
|
-
timeoutMs: (
|
|
579
|
-
|
|
624
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
625
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
626
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
627
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
628
|
+
: undefined,
|
|
629
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
580
630
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
581
|
-
fetchFn: (
|
|
631
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
582
632
|
logging: this._options.logging,
|
|
583
633
|
});
|
|
584
634
|
if (_response.ok) {
|
|
@@ -8,7 +8,7 @@ export interface ExtractAsyncRequest {
|
|
|
8
8
|
file?: core.file.Uploadable | undefined;
|
|
9
9
|
/** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
|
|
10
10
|
fileUrl?: string;
|
|
11
|
-
/** Extraction model to use. When set to `
|
|
11
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
12
12
|
model?: ExtractAsyncRequest.Model;
|
|
13
13
|
/** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
|
|
14
14
|
pages?: string;
|
|
@@ -16,6 +16,8 @@ export interface ExtractAsyncRequest {
|
|
|
16
16
|
figureProcessing?: ExtractAsyncRequest.FigureProcessing;
|
|
17
17
|
/** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
|
|
18
18
|
extensions?: ExtractAsyncRequest.Extensions;
|
|
19
|
+
/** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names. */
|
|
20
|
+
spreadsheet?: ExtractAsyncRequest.Spreadsheet;
|
|
19
21
|
/** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
|
|
20
22
|
storage?: ExtractAsyncRequest.Storage;
|
|
21
23
|
/** If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously. */
|
|
@@ -44,9 +46,10 @@ export interface ExtractAsyncRequest {
|
|
|
44
46
|
thinking?: boolean;
|
|
45
47
|
}
|
|
46
48
|
export declare namespace ExtractAsyncRequest {
|
|
47
|
-
/** Extraction model to use. When set to `
|
|
49
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
48
50
|
const Model: {
|
|
49
|
-
readonly
|
|
51
|
+
readonly Default: "default";
|
|
52
|
+
readonly PulseUltra2: "pulse-ultra-2";
|
|
50
53
|
};
|
|
51
54
|
type Model = (typeof Model)[keyof typeof Model];
|
|
52
55
|
/**
|
|
@@ -62,8 +65,6 @@ export declare namespace ExtractAsyncRequest {
|
|
|
62
65
|
* Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`.
|
|
63
66
|
*/
|
|
64
67
|
interface Extensions {
|
|
65
|
-
/** Merge tables that span multiple pages into a single table. */
|
|
66
|
-
mergeTables?: boolean;
|
|
67
68
|
/** Link footnote markers to their corresponding footnote text. */
|
|
68
69
|
footnoteReferences?: boolean;
|
|
69
70
|
/** Chunking configuration. When provided, the document is split into chunks using the specified strategies. Results appear in `response.extensions.chunking`. */
|
|
@@ -105,6 +106,17 @@ export declare namespace ExtractAsyncRequest {
|
|
|
105
106
|
returnXml?: boolean;
|
|
106
107
|
}
|
|
107
108
|
}
|
|
109
|
+
/**
|
|
110
|
+
* Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names.
|
|
111
|
+
*/
|
|
112
|
+
interface Spreadsheet {
|
|
113
|
+
/** Include rows that are hidden in the Excel workbook. */
|
|
114
|
+
includeHiddenRows?: boolean;
|
|
115
|
+
/** Include columns that are hidden in the Excel workbook. */
|
|
116
|
+
includeHiddenCols?: boolean;
|
|
117
|
+
/** Include sheets that are hidden in the Excel workbook. */
|
|
118
|
+
includeHiddenSheets?: boolean;
|
|
119
|
+
}
|
|
108
120
|
/**
|
|
109
121
|
* Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
|
|
110
122
|
*/
|
|
@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.ExtractAsyncRequest = void 0;
|
|
5
5
|
var ExtractAsyncRequest;
|
|
6
6
|
(function (ExtractAsyncRequest) {
|
|
7
|
-
/** Extraction model to use. When set to `
|
|
7
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
8
8
|
ExtractAsyncRequest.Model = {
|
|
9
|
-
|
|
9
|
+
Default: "default",
|
|
10
|
+
PulseUltra2: "pulse-ultra-2",
|
|
10
11
|
};
|
|
11
12
|
let Extensions;
|
|
12
13
|
(function (Extensions) {
|
|
@@ -8,7 +8,7 @@ export interface ExtractRequest {
|
|
|
8
8
|
file?: core.file.Uploadable | undefined;
|
|
9
9
|
/** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
|
|
10
10
|
fileUrl?: string;
|
|
11
|
-
/** Extraction model to use. When set to `
|
|
11
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
12
12
|
model?: ExtractRequest.Model;
|
|
13
13
|
/** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
|
|
14
14
|
pages?: string;
|
|
@@ -16,6 +16,8 @@ export interface ExtractRequest {
|
|
|
16
16
|
figureProcessing?: ExtractRequest.FigureProcessing;
|
|
17
17
|
/** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
|
|
18
18
|
extensions?: ExtractRequest.Extensions;
|
|
19
|
+
/** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names. */
|
|
20
|
+
spreadsheet?: ExtractRequest.Spreadsheet;
|
|
19
21
|
/** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
|
|
20
22
|
storage?: ExtractRequest.Storage;
|
|
21
23
|
/** If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously. */
|
|
@@ -44,9 +46,10 @@ export interface ExtractRequest {
|
|
|
44
46
|
thinking?: boolean;
|
|
45
47
|
}
|
|
46
48
|
export declare namespace ExtractRequest {
|
|
47
|
-
/** Extraction model to use. When set to `
|
|
49
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
48
50
|
const Model: {
|
|
49
|
-
readonly
|
|
51
|
+
readonly Default: "default";
|
|
52
|
+
readonly PulseUltra2: "pulse-ultra-2";
|
|
50
53
|
};
|
|
51
54
|
type Model = (typeof Model)[keyof typeof Model];
|
|
52
55
|
/**
|
|
@@ -62,8 +65,6 @@ export declare namespace ExtractRequest {
|
|
|
62
65
|
* Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`.
|
|
63
66
|
*/
|
|
64
67
|
interface Extensions {
|
|
65
|
-
/** Merge tables that span multiple pages into a single table. */
|
|
66
|
-
mergeTables?: boolean;
|
|
67
68
|
/** Link footnote markers to their corresponding footnote text. */
|
|
68
69
|
footnoteReferences?: boolean;
|
|
69
70
|
/** Chunking configuration. When provided, the document is split into chunks using the specified strategies. Results appear in `response.extensions.chunking`. */
|
|
@@ -105,6 +106,17 @@ export declare namespace ExtractRequest {
|
|
|
105
106
|
returnXml?: boolean;
|
|
106
107
|
}
|
|
107
108
|
}
|
|
109
|
+
/**
|
|
110
|
+
* Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names.
|
|
111
|
+
*/
|
|
112
|
+
interface Spreadsheet {
|
|
113
|
+
/** Include rows that are hidden in the Excel workbook. */
|
|
114
|
+
includeHiddenRows?: boolean;
|
|
115
|
+
/** Include columns that are hidden in the Excel workbook. */
|
|
116
|
+
includeHiddenCols?: boolean;
|
|
117
|
+
/** Include sheets that are hidden in the Excel workbook. */
|
|
118
|
+
includeHiddenSheets?: boolean;
|
|
119
|
+
}
|
|
108
120
|
/**
|
|
109
121
|
* Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
|
|
110
122
|
*/
|
|
@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.ExtractRequest = void 0;
|
|
5
5
|
var ExtractRequest;
|
|
6
6
|
(function (ExtractRequest) {
|
|
7
|
-
/** Extraction model to use. When set to `
|
|
7
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
8
8
|
ExtractRequest.Model = {
|
|
9
|
-
|
|
9
|
+
Default: "default",
|
|
10
|
+
PulseUltra2: "pulse-ultra-2",
|
|
10
11
|
};
|
|
11
12
|
let Extensions;
|
|
12
13
|
(function (Extensions) {
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type * as core from "../../core/index.js";
|
|
2
|
+
import * as errors from "../../errors/index.js";
|
|
3
|
+
import type * as Pulse from "../index.js";
|
|
4
|
+
export declare class GoneError extends errors.PulseError {
|
|
5
|
+
constructor(body: Pulse.GoneErrorBody, rawResponse?: core.RawResponse);
|
|
6
|
+
}
|