extend-ai 1.6.0 → 1.8.0
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/BaseClient.js +2 -2
- package/Client.d.ts +9 -0
- package/Client.js +64 -46
- package/api/client/requests/ParseRequest.d.ts +2 -0
- package/api/resources/batchProcessorRun/client/Client.d.ts +2 -1
- package/api/resources/batchProcessorRun/client/Client.js +10 -5
- package/api/resources/batchProcessorRun/client/index.d.ts +1 -1
- package/api/resources/batchProcessorRun/client/index.js +15 -0
- package/api/resources/batchProcessorRun/client/requests/BatchProcessorRunGetRequest.d.ts +8 -0
- package/api/resources/batchProcessorRun/client/requests/index.d.ts +1 -0
- package/api/resources/batchProcessorRun/client/requests/index.js +2 -0
- package/api/resources/batchRuns/client/Client.d.ts +49 -0
- package/api/resources/batchRuns/client/Client.js +142 -0
- package/api/resources/batchRuns/client/index.d.ts +1 -0
- package/api/resources/batchRuns/client/index.js +2 -0
- package/api/resources/batchRuns/index.d.ts +1 -0
- package/api/resources/batchRuns/index.js +17 -0
- package/api/resources/classifierVersions/client/Client.d.ts +8 -4
- package/api/resources/classifierVersions/client/Client.js +38 -12
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsCreateRequest.d.ts +2 -0
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsListRequest.d.ts +2 -0
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsRetrieveRequest.d.ts +8 -0
- package/api/resources/classifierVersions/client/requests/index.d.ts +1 -0
- package/api/resources/classifiers/client/Client.d.ts +2 -1
- package/api/resources/classifiers/client/Client.js +32 -9
- package/api/resources/classifiers/client/requests/ClassifiersListRequest.d.ts +2 -0
- package/api/resources/classifiers/client/requests/ClassifiersRetrieveRequest.d.ts +8 -0
- package/api/resources/classifiers/client/requests/ClassifiersUpdateRequest.d.ts +2 -0
- package/api/resources/classifiers/client/requests/index.d.ts +1 -0
- package/api/resources/classifyRuns/client/Client.d.ts +63 -3
- package/api/resources/classifyRuns/client/Client.js +145 -17
- package/api/resources/classifyRuns/client/requests/ClassifyRunsCancelRequest.d.ts +8 -0
- package/api/resources/classifyRuns/client/requests/ClassifyRunsCreateBatchRequest.d.ts +38 -0
- package/api/resources/classifyRuns/client/requests/ClassifyRunsDeleteRequest.d.ts +8 -0
- package/api/resources/classifyRuns/client/requests/ClassifyRunsListRequest.d.ts +8 -0
- package/api/resources/classifyRuns/client/requests/ClassifyRunsRetrieveRequest.d.ts +8 -0
- package/api/resources/classifyRuns/client/requests/ClassifyRunsRetrieveRequest.js +3 -0
- package/api/resources/classifyRuns/client/requests/index.d.ts +4 -0
- package/api/resources/classifyRuns/types/ClassifyRunsCreateBatchRequestClassifier.d.ts +11 -0
- package/api/resources/classifyRuns/types/ClassifyRunsCreateBatchRequestClassifier.js +3 -0
- package/api/resources/classifyRuns/types/ClassifyRunsCreateBatchRequestInputsItem.d.ts +6 -0
- package/api/resources/classifyRuns/types/ClassifyRunsCreateBatchRequestInputsItem.js +3 -0
- package/api/resources/classifyRuns/types/ClassifyRunsCreateBatchRequestInputsItemFile.d.ts +5 -0
- package/api/resources/classifyRuns/types/ClassifyRunsCreateBatchRequestInputsItemFile.js +3 -0
- package/api/resources/classifyRuns/types/index.d.ts +3 -0
- package/api/resources/classifyRuns/types/index.js +3 -0
- package/api/resources/editRuns/client/Client.d.ts +4 -2
- package/api/resources/editRuns/client/Client.js +20 -10
- package/api/resources/editRuns/client/requests/EditRunsDeleteRequest.d.ts +8 -0
- package/api/resources/editRuns/client/requests/EditRunsDeleteRequest.js +3 -0
- package/api/resources/editRuns/client/requests/EditRunsRetrieveRequest.d.ts +8 -0
- package/api/resources/editRuns/client/requests/EditRunsRetrieveRequest.js +3 -0
- package/api/resources/editRuns/client/requests/index.d.ts +2 -0
- package/api/resources/editSchemas/client/Client.d.ts +49 -0
- package/api/resources/editSchemas/client/Client.js +147 -0
- package/api/resources/editSchemas/client/index.d.ts +1 -0
- package/api/resources/editSchemas/client/index.js +17 -0
- package/api/resources/editSchemas/client/requests/EditSchemasGenerateRequest.d.ts +20 -0
- package/api/resources/editSchemas/client/requests/EditSchemasGenerateRequest.js +3 -0
- package/api/resources/editSchemas/client/requests/index.d.ts +1 -0
- package/api/resources/editSchemas/client/requests/index.js +2 -0
- package/api/resources/editSchemas/index.d.ts +2 -0
- package/api/resources/editSchemas/index.js +18 -0
- package/api/resources/editSchemas/types/EditSchemasGenerateRequestFile.d.ts +5 -0
- package/api/resources/editSchemas/types/EditSchemasGenerateRequestFile.js +3 -0
- package/api/resources/editSchemas/types/index.d.ts +1 -0
- package/api/resources/editSchemas/types/index.js +17 -0
- package/api/resources/evaluationSetItems/client/Client.d.ts +4 -2
- package/api/resources/evaluationSetItems/client/Client.js +48 -16
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts +2 -0
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsDeleteRequest.d.ts +8 -0
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsDeleteRequest.js +3 -0
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsListRequest.d.ts +2 -0
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsRetrieveRequest.d.ts +8 -0
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsRetrieveRequest.js +3 -0
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts +2 -0
- package/api/resources/evaluationSetItems/client/requests/index.d.ts +2 -0
- package/api/resources/evaluationSetRuns/client/Client.d.ts +2 -1
- package/api/resources/evaluationSetRuns/client/Client.js +10 -5
- package/api/resources/evaluationSetRuns/client/index.d.ts +1 -1
- package/api/resources/evaluationSetRuns/client/index.js +15 -0
- package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsRetrieveRequest.d.ts +8 -0
- package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsRetrieveRequest.js +3 -0
- package/api/resources/evaluationSetRuns/client/requests/index.d.ts +1 -0
- package/api/resources/evaluationSetRuns/client/requests/index.js +2 -0
- package/api/resources/evaluationSets/client/Client.d.ts +2 -1
- package/api/resources/evaluationSets/client/Client.js +15 -7
- package/api/resources/evaluationSets/client/requests/EvaluationSetsListRequest.d.ts +2 -0
- package/api/resources/evaluationSets/client/requests/EvaluationSetsRetrieveRequest.d.ts +8 -0
- package/api/resources/evaluationSets/client/requests/EvaluationSetsRetrieveRequest.js +3 -0
- package/api/resources/evaluationSets/client/requests/index.d.ts +1 -0
- package/api/resources/extractRuns/client/Client.d.ts +63 -3
- package/api/resources/extractRuns/client/Client.js +145 -17
- package/api/resources/extractRuns/client/requests/ExtractRunsCancelRequest.d.ts +8 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsCancelRequest.js +3 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsCreateBatchRequest.d.ts +38 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsCreateBatchRequest.js +3 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsDeleteRequest.d.ts +8 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsDeleteRequest.js +3 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsListRequest.d.ts +8 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsRetrieveRequest.d.ts +8 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsRetrieveRequest.js +3 -0
- package/api/resources/extractRuns/client/requests/index.d.ts +4 -0
- package/api/resources/extractRuns/types/ExtractRunsCreateBatchRequestExtractor.d.ts +11 -0
- package/api/resources/extractRuns/types/ExtractRunsCreateBatchRequestExtractor.js +3 -0
- package/api/resources/extractRuns/types/ExtractRunsCreateBatchRequestInputsItem.d.ts +6 -0
- package/api/resources/extractRuns/types/ExtractRunsCreateBatchRequestInputsItem.js +3 -0
- package/api/resources/extractRuns/types/ExtractRunsCreateBatchRequestInputsItemFile.d.ts +5 -0
- package/api/resources/extractRuns/types/ExtractRunsCreateBatchRequestInputsItemFile.js +3 -0
- package/api/resources/extractRuns/types/index.d.ts +3 -0
- package/api/resources/extractRuns/types/index.js +3 -0
- package/api/resources/extractorVersions/client/Client.d.ts +8 -4
- package/api/resources/extractorVersions/client/Client.js +38 -12
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsCreateRequest.d.ts +2 -0
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsListRequest.d.ts +2 -0
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsRetrieveRequest.d.ts +8 -0
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsRetrieveRequest.js +3 -0
- package/api/resources/extractorVersions/client/requests/index.d.ts +1 -0
- package/api/resources/extractors/client/Client.d.ts +2 -1
- package/api/resources/extractors/client/Client.js +32 -9
- package/api/resources/extractors/client/requests/ExtractorsListRequest.d.ts +2 -0
- package/api/resources/extractors/client/requests/ExtractorsRetrieveRequest.d.ts +8 -0
- package/api/resources/extractors/client/requests/ExtractorsRetrieveRequest.js +3 -0
- package/api/resources/extractors/client/requests/ExtractorsUpdateRequest.d.ts +2 -0
- package/api/resources/extractors/client/requests/index.d.ts +1 -0
- package/api/resources/files/client/Client.d.ts +2 -1
- package/api/resources/files/client/Client.js +21 -10
- package/api/resources/files/client/requests/FilesDeleteRequest.d.ts +8 -0
- package/api/resources/files/client/requests/FilesDeleteRequest.js +3 -0
- package/api/resources/files/client/requests/FilesListRequest.d.ts +2 -0
- package/api/resources/files/client/requests/FilesRetrieveRequest.d.ts +2 -0
- package/api/resources/files/client/requests/FilesUploadRequest.d.ts +2 -0
- package/api/resources/files/client/requests/index.d.ts +1 -0
- package/api/resources/index.d.ts +10 -0
- package/api/resources/index.js +11 -1
- package/api/resources/parseRuns/client/Client.d.ts +2 -1
- package/api/resources/parseRuns/client/Client.js +15 -7
- package/api/resources/parseRuns/client/requests/ParseRunsDeleteRequest.d.ts +8 -0
- package/api/resources/parseRuns/client/requests/ParseRunsDeleteRequest.js +3 -0
- package/api/resources/parseRuns/client/requests/ParseRunsRetrieveRequest.d.ts +2 -0
- package/api/resources/parseRuns/client/requests/index.d.ts +1 -0
- package/api/resources/processor/client/Client.js +22 -4
- package/api/resources/processor/client/requests/ProcessorListRequest.d.ts +2 -0
- package/api/resources/processor/client/requests/ProcessorUpdateRequest.d.ts +2 -0
- package/api/resources/processorRun/client/Client.d.ts +6 -3
- package/api/resources/processorRun/client/Client.js +35 -17
- package/api/resources/processorRun/client/requests/ProcessorRunCancelRequest.d.ts +8 -0
- package/api/resources/processorRun/client/requests/ProcessorRunCancelRequest.js +3 -0
- package/api/resources/processorRun/client/requests/ProcessorRunDeleteRequest.d.ts +8 -0
- package/api/resources/processorRun/client/requests/ProcessorRunDeleteRequest.js +3 -0
- package/api/resources/processorRun/client/requests/ProcessorRunGetRequest.d.ts +8 -0
- package/api/resources/processorRun/client/requests/ProcessorRunGetRequest.js +3 -0
- package/api/resources/processorRun/client/requests/ProcessorRunListRequest.d.ts +2 -0
- package/api/resources/processorRun/client/requests/index.d.ts +3 -0
- package/api/resources/processorVersion/client/Client.d.ts +4 -2
- package/api/resources/processorVersion/client/Client.js +37 -12
- package/api/resources/processorVersion/client/requests/ProcessorVersionCreateRequest.d.ts +2 -0
- package/api/resources/processorVersion/client/requests/ProcessorVersionGetRequest.d.ts +8 -0
- package/api/resources/processorVersion/client/requests/ProcessorVersionGetRequest.js +3 -0
- package/api/resources/processorVersion/client/requests/ProcessorVersionListRequest.d.ts +8 -0
- package/api/resources/processorVersion/client/requests/ProcessorVersionListRequest.js +3 -0
- package/api/resources/processorVersion/client/requests/index.d.ts +2 -0
- package/api/resources/splitRuns/client/Client.d.ts +64 -3
- package/api/resources/splitRuns/client/Client.js +146 -17
- package/api/resources/splitRuns/client/requests/SplitRunsCancelRequest.d.ts +8 -0
- package/api/resources/splitRuns/client/requests/SplitRunsCancelRequest.js +3 -0
- package/api/resources/splitRuns/client/requests/SplitRunsCreateBatchRequest.d.ts +38 -0
- package/api/resources/splitRuns/client/requests/SplitRunsCreateBatchRequest.js +3 -0
- package/api/resources/splitRuns/client/requests/SplitRunsDeleteRequest.d.ts +8 -0
- package/api/resources/splitRuns/client/requests/SplitRunsDeleteRequest.js +3 -0
- package/api/resources/splitRuns/client/requests/SplitRunsListRequest.d.ts +8 -0
- package/api/resources/splitRuns/client/requests/SplitRunsRetrieveRequest.d.ts +8 -0
- package/api/resources/splitRuns/client/requests/SplitRunsRetrieveRequest.js +3 -0
- package/api/resources/splitRuns/client/requests/index.d.ts +4 -0
- package/api/resources/splitRuns/types/SplitRunsCreateBatchRequestInputsItem.d.ts +6 -0
- package/api/resources/splitRuns/types/SplitRunsCreateBatchRequestInputsItem.js +3 -0
- package/api/resources/splitRuns/types/SplitRunsCreateBatchRequestInputsItemFile.d.ts +5 -0
- package/api/resources/splitRuns/types/SplitRunsCreateBatchRequestInputsItemFile.js +3 -0
- package/api/resources/splitRuns/types/SplitRunsCreateBatchRequestSplitter.d.ts +11 -0
- package/api/resources/splitRuns/types/SplitRunsCreateBatchRequestSplitter.js +3 -0
- package/api/resources/splitRuns/types/index.d.ts +3 -0
- package/api/resources/splitRuns/types/index.js +3 -0
- package/api/resources/splitterVersions/client/Client.d.ts +8 -4
- package/api/resources/splitterVersions/client/Client.js +38 -12
- package/api/resources/splitterVersions/client/requests/SplitterVersionsCreateRequest.d.ts +2 -0
- package/api/resources/splitterVersions/client/requests/SplitterVersionsListRequest.d.ts +2 -0
- package/api/resources/splitterVersions/client/requests/SplitterVersionsRetrieveRequest.d.ts +8 -0
- package/api/resources/splitterVersions/client/requests/SplitterVersionsRetrieveRequest.js +3 -0
- package/api/resources/splitterVersions/client/requests/index.d.ts +1 -0
- package/api/resources/splitters/client/Client.d.ts +2 -1
- package/api/resources/splitters/client/Client.js +32 -9
- package/api/resources/splitters/client/requests/SplittersListRequest.d.ts +2 -0
- package/api/resources/splitters/client/requests/SplittersRetrieveRequest.d.ts +8 -0
- package/api/resources/splitters/client/requests/SplittersRetrieveRequest.js +3 -0
- package/api/resources/splitters/client/requests/SplittersUpdateRequest.d.ts +2 -0
- package/api/resources/splitters/client/requests/index.d.ts +1 -0
- package/api/resources/webhookEndpoints/client/Client.d.ts +4 -2
- package/api/resources/webhookEndpoints/client/Client.js +42 -14
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsDeleteRequest.d.ts +8 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsDeleteRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.d.ts +2 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsRetrieveRequest.d.ts +8 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsRetrieveRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.d.ts +2 -0
- package/api/resources/webhookEndpoints/client/requests/index.d.ts +2 -0
- package/api/resources/webhookSubscriptions/client/Client.d.ts +4 -2
- package/api/resources/webhookSubscriptions/client/Client.js +42 -14
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsDeleteRequest.d.ts +8 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsDeleteRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts +2 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsRetrieveRequest.d.ts +8 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsRetrieveRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts +2 -0
- package/api/resources/webhookSubscriptions/client/requests/index.d.ts +2 -0
- package/api/resources/workflowRuns/client/Client.d.ts +6 -3
- package/api/resources/workflowRuns/client/Client.js +52 -19
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCancelRequest.d.ts +8 -0
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCancelRequest.js +3 -0
- package/api/resources/workflowRuns/client/requests/WorkflowRunsDeleteRequest.d.ts +8 -0
- package/api/resources/workflowRuns/client/requests/WorkflowRunsDeleteRequest.js +3 -0
- package/api/resources/workflowRuns/client/requests/WorkflowRunsListRequest.d.ts +2 -0
- package/api/resources/workflowRuns/client/requests/WorkflowRunsRetrieveRequest.d.ts +8 -0
- package/api/resources/workflowRuns/client/requests/WorkflowRunsRetrieveRequest.js +3 -0
- package/api/resources/workflowRuns/client/requests/WorkflowRunsUpdateRequest.d.ts +2 -0
- package/api/resources/workflowRuns/client/requests/index.d.ts +3 -0
- package/api/resources/workflowVersions/client/Client.d.ts +85 -0
- package/api/resources/workflowVersions/client/Client.js +287 -0
- package/api/resources/workflowVersions/client/index.d.ts +1 -0
- package/api/resources/workflowVersions/client/index.js +17 -0
- package/api/resources/workflowVersions/client/requests/WorkflowVersionsCreateRequest.d.ts +17 -0
- package/api/resources/workflowVersions/client/requests/WorkflowVersionsCreateRequest.js +3 -0
- package/api/resources/workflowVersions/client/requests/WorkflowVersionsListRequest.d.ts +12 -0
- package/api/resources/workflowVersions/client/requests/WorkflowVersionsListRequest.js +3 -0
- package/api/resources/workflowVersions/client/requests/index.d.ts +2 -0
- package/api/resources/workflowVersions/client/requests/index.js +2 -0
- package/api/resources/workflowVersions/index.d.ts +2 -0
- package/api/resources/workflowVersions/index.js +18 -0
- package/api/resources/workflowVersions/types/WorkflowVersionsListResponse.d.ts +6 -0
- package/api/resources/workflowVersions/types/WorkflowVersionsListResponse.js +3 -0
- package/api/resources/workflowVersions/types/index.d.ts +1 -0
- package/api/resources/workflowVersions/types/index.js +17 -0
- package/api/resources/workflows/client/Client.d.ts +124 -2
- package/api/resources/workflows/client/Client.js +281 -2
- package/api/resources/workflows/client/requests/WorkflowsCreateRequest.d.ts +52 -1
- package/api/resources/workflows/client/requests/WorkflowsListRequest.d.ts +13 -0
- package/api/resources/workflows/client/requests/WorkflowsListRequest.js +3 -0
- package/api/resources/workflows/client/requests/WorkflowsUpdateRequest.d.ts +28 -0
- package/api/resources/workflows/client/requests/WorkflowsUpdateRequest.js +3 -0
- package/api/resources/workflows/client/requests/index.d.ts +2 -0
- package/api/resources/workflows/index.d.ts +1 -0
- package/api/resources/workflows/index.js +1 -0
- package/api/resources/workflows/types/WorkflowsListResponse.d.ts +6 -0
- package/api/resources/workflows/types/WorkflowsListResponse.js +3 -0
- package/api/resources/workflows/types/index.d.ts +1 -0
- package/api/resources/workflows/types/index.js +17 -0
- package/api/types/BarcodeDetails.d.ts +13 -0
- package/api/types/BarcodeDetails.js +3 -0
- package/api/types/BatchProcessorRunCompletedWebhookEvent.d.ts +6 -0
- package/api/types/BatchProcessorRunCompletedWebhookEvent.js +3 -0
- package/api/types/BatchProcessorRunFailedWebhookEvent.d.ts +6 -0
- package/api/types/BatchProcessorRunFailedWebhookEvent.js +3 -0
- package/api/types/BatchRun.d.ts +9 -16
- package/api/types/BatchRunStatus.d.ts +7 -5
- package/api/types/BatchRunStatus.js +7 -5
- package/api/types/Block.d.ts +7 -1
- package/api/types/BlockDetails.d.ts +1 -1
- package/api/types/BlockMetadata.d.ts +2 -0
- package/api/types/BlockMetadataTextDirection.d.ts +6 -0
- package/api/types/BlockMetadataTextDirection.js +9 -0
- package/api/types/BlockType.d.ts +13 -1
- package/api/types/BlockType.js +13 -1
- package/api/types/ClassificationNextEntry.d.ts +11 -0
- package/api/types/ClassificationNextEntry.js +3 -0
- package/api/types/ClassifierRef.d.ts +9 -0
- package/api/types/ClassifierRef.js +3 -0
- package/api/types/ClassifyStepDefinition.d.ts +27 -0
- package/api/types/ClassifyStepDefinition.js +3 -0
- package/api/types/ClassifyStepDefinitionConfig.d.ts +13 -0
- package/api/types/ClassifyStepDefinitionConfig.js +3 -0
- package/api/types/CollectStepDefinition.d.ts +10 -0
- package/api/types/CollectStepDefinition.js +3 -0
- package/api/types/ConditionalExtractStepDefinition.d.ts +15 -0
- package/api/types/ConditionalExtractStepDefinition.js +3 -0
- package/api/types/ConditionalExtractStepDefinitionConfig.d.ts +12 -0
- package/api/types/ConditionalExtractStepDefinitionConfig.js +3 -0
- package/api/types/ConditionalExtractStepDefinitionConfigRulesItem.d.ts +11 -0
- package/api/types/ConditionalExtractStepDefinitionConfigRulesItem.js +3 -0
- package/api/types/ConditionalNextEntry.d.ts +11 -0
- package/api/types/ConditionalNextEntry.js +3 -0
- package/api/types/ConditionalStepDefinition.d.ts +16 -0
- package/api/types/ConditionalStepDefinition.js +3 -0
- package/api/types/ConditionalStepDefinitionConfig.d.ts +9 -0
- package/api/types/ConditionalStepDefinitionConfig.js +3 -0
- package/api/types/ConditionalStepDefinitionConfigConditionsItem.d.ts +24 -0
- package/api/types/ConditionalStepDefinitionConfigConditionsItem.js +3 -0
- package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.d.ts +14 -0
- package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.js +17 -0
- package/api/types/ConditionalStepDefinitionConfigConditionsItemType.d.ts +6 -0
- package/api/types/ConditionalStepDefinitionConfigConditionsItemType.js +9 -0
- package/api/types/EditConditionalClause.d.ts +22 -0
- package/api/types/EditConditionalClause.js +3 -0
- package/api/types/EditConditionalObjectProperty.d.ts +16 -0
- package/api/types/EditConditionalObjectProperty.js +3 -0
- package/api/types/EditConditionalProperty.d.ts +51 -0
- package/api/types/EditConditionalProperty.js +3 -0
- package/api/types/EditConfig.d.ts +2 -0
- package/api/types/EditDependentRequired.d.ts +4 -0
- package/api/types/EditDependentRequired.js +3 -0
- package/api/types/EditJson.d.ts +2 -0
- package/api/types/EditJsonExtendEditImage.d.ts +7 -0
- package/api/types/EditJsonExtendEditImage.js +3 -0
- package/api/types/EditRootJson.d.ts +14 -0
- package/api/types/EditSchemaGenerationConfig.d.ts +15 -0
- package/api/types/EditSchemaGenerationConfig.js +3 -0
- package/api/types/EditSchemaGenerationConfigAdvancedOptions.d.ts +11 -0
- package/api/types/EditSchemaGenerationConfigAdvancedOptions.js +3 -0
- package/api/types/EditSchemaGenerationMappingMatch.d.ts +9 -0
- package/api/types/EditSchemaGenerationMappingMatch.js +3 -0
- package/api/types/EditSchemaGenerationMappingResult.d.ts +12 -0
- package/api/types/EditSchemaGenerationMappingResult.js +3 -0
- package/api/types/EditSchemaGenerationResponse.d.ts +12 -0
- package/api/types/EditSchemaGenerationResponse.js +3 -0
- package/api/types/ExternalDataValidationStepDefinition.d.ts +13 -0
- package/api/types/ExternalDataValidationStepDefinition.js +3 -0
- package/api/types/ExternalDataValidationStepDefinitionConfig.d.ts +18 -0
- package/api/types/ExternalDataValidationStepDefinitionConfig.js +3 -0
- package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.d.ts +10 -0
- package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.js +13 -0
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptions.d.ts +23 -0
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptions.js +3 -0
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.d.ts +10 -0
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.js +13 -0
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsMethod.d.ts +6 -0
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsMethod.js +9 -0
- package/api/types/ExtractStepDefinition.d.ts +15 -0
- package/api/types/ExtractStepDefinition.js +3 -0
- package/api/types/ExtractStepDefinitionConfig.d.ts +7 -0
- package/api/types/ExtractStepDefinitionConfig.js +3 -0
- package/api/types/ExtractorRef.d.ts +9 -0
- package/api/types/ExtractorRef.js +3 -0
- package/api/types/FileConversionStepDefinition.d.ts +11 -0
- package/api/types/FileConversionStepDefinition.js +3 -0
- package/api/types/FileConversionStepDefinitionConfig.d.ts +9 -0
- package/api/types/FileConversionStepDefinitionConfig.js +3 -0
- package/api/types/FileConversionStepDefinitionConfigFailureBehavior.d.ts +10 -0
- package/api/types/FileConversionStepDefinitionConfigFailureBehavior.js +13 -0
- package/api/types/FormulaDetails.d.ts +9 -0
- package/api/types/FormulaDetails.js +3 -0
- package/api/types/HumanReviewStepDefinition.d.ts +10 -0
- package/api/types/HumanReviewStepDefinition.js +3 -0
- package/api/types/KeyValueDetails.d.ts +7 -0
- package/api/types/KeyValueDetails.js +3 -0
- package/api/types/LegacyListProcessorsResponse.d.ts +1 -1
- package/api/types/MergeExtractStepDefinition.d.ts +11 -0
- package/api/types/MergeExtractStepDefinition.js +3 -0
- package/api/types/MergeExtractStepDefinitionConfig.d.ts +9 -0
- package/api/types/MergeExtractStepDefinitionConfig.js +3 -0
- package/api/types/MergeExtractStepDefinitionConfigMergeOrder.d.ts +12 -0
- package/api/types/MergeExtractStepDefinitionConfigMergeOrder.js +15 -0
- package/api/types/ParseConfigAdvancedOptions.d.ts +25 -0
- package/api/types/ParseConfigAdvancedOptionsEnrichmentFormat.d.ts +11 -0
- package/api/types/ParseConfigAdvancedOptionsEnrichmentFormat.js +14 -0
- package/api/types/ParseConfigAdvancedOptionsFormattingDetectionItem.d.ts +8 -0
- package/api/types/ParseConfigAdvancedOptionsFormattingDetectionItem.js +3 -0
- package/api/types/ParseConfigAdvancedOptionsImageConversionQuality.d.ts +13 -0
- package/api/types/ParseConfigAdvancedOptionsImageConversionQuality.js +16 -0
- package/api/types/ParseConfigBlockOptions.d.ts +6 -0
- package/api/types/ParseConfigBlockOptionsBarcodes.d.ts +9 -0
- package/api/types/ParseConfigBlockOptionsBarcodes.js +3 -0
- package/api/types/ParseConfigBlockOptionsFigures.d.ts +2 -0
- package/api/types/ParseConfigBlockOptionsFormulas.d.ts +7 -0
- package/api/types/ParseConfigBlockOptionsFormulas.js +3 -0
- package/api/types/ParseConfigBlockOptionsKeyValue.d.ts +7 -0
- package/api/types/ParseConfigBlockOptionsKeyValue.js +3 -0
- package/api/types/ParseStepDefinition.d.ts +11 -0
- package/api/types/ParseStepDefinition.js +3 -0
- package/api/types/ParseStepDefinitionConfig.d.ts +4 -0
- package/api/types/ParseStepDefinitionConfig.js +3 -0
- package/api/types/ProcessorRunStatus.d.ts +2 -0
- package/api/types/ProcessorRunStatus.js +2 -0
- package/api/types/RuleValidationNextEntry.d.ts +12 -0
- package/api/types/RuleValidationNextEntry.js +3 -0
- package/api/types/RuleValidationNextEntryResult.d.ts +6 -0
- package/api/types/RuleValidationNextEntryResult.js +9 -0
- package/api/types/RuleValidationStepDefinition.d.ts +17 -0
- package/api/types/RuleValidationStepDefinition.js +3 -0
- package/api/types/RuleValidationStepDefinitionConfig.d.ts +12 -0
- package/api/types/RuleValidationStepDefinitionConfig.js +3 -0
- package/api/types/RuleValidationStepDefinitionConfigRulesItem.d.ts +10 -0
- package/api/types/RuleValidationStepDefinitionConfigRulesItem.js +3 -0
- package/api/types/SimpleNextEntry.d.ts +7 -0
- package/api/types/SimpleNextEntry.js +3 -0
- package/api/types/SplitStepDefinition.d.ts +27 -0
- package/api/types/SplitStepDefinition.js +3 -0
- package/api/types/SplitStepDefinitionConfig.d.ts +13 -0
- package/api/types/SplitStepDefinitionConfig.js +3 -0
- package/api/types/SplitterRef.d.ts +9 -0
- package/api/types/SplitterRef.js +3 -0
- package/api/types/TriggerStepDefinition.d.ts +12 -0
- package/api/types/TriggerStepDefinition.js +3 -0
- package/api/types/WebhookEndpointEventType.d.ts +2 -0
- package/api/types/WebhookEndpointEventType.js +2 -0
- package/api/types/WebhookEvent.d.ts +7 -1
- package/api/types/WebhookResponseStepDefinition.d.ts +8 -0
- package/api/types/WebhookResponseStepDefinition.js +3 -0
- package/api/types/WebhookSubscriptionEventType.d.ts +5 -3
- package/api/types/WebhookSubscriptionEventType.js +5 -3
- package/api/types/Workflow.d.ts +10 -11
- package/api/types/WorkflowStepBase.d.ts +2 -0
- package/api/types/WorkflowStepDefinition.d.ts +51 -0
- package/api/types/WorkflowStepDefinition.js +3 -0
- package/api/types/WorkflowSummary.d.ts +9 -11
- package/api/types/WorkflowVersion.d.ts +11 -16
- package/api/types/WorkflowVersionSummary.d.ts +9 -16
- package/api/types/index.d.ts +66 -8
- package/api/types/index.js +66 -8
- package/package.json +1 -1
- package/reference.md +1303 -112
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/resources/classifyRuns/ClassifyRunsWrapper.js +1 -1
- package/wrapper/resources/classifyRuns/ClassifyRunsWrapper.test.js +2 -2
- package/wrapper/resources/editRuns/EditRunsWrapper.js +1 -1
- package/wrapper/resources/editRuns/EditRunsWrapper.test.js +2 -2
- package/wrapper/resources/extractRuns/ExtractRunsWrapper.js +1 -1
- package/wrapper/resources/extractRuns/ExtractRunsWrapper.test.js +2 -2
- package/wrapper/resources/splitRuns/SplitRunsWrapper.js +1 -1
- package/wrapper/resources/splitRuns/SplitRunsWrapper.test.js +2 -2
- package/wrapper/resources/workflowRuns/WorkflowRunsWrapper.js +1 -1
- package/wrapper/resources/workflowRuns/WorkflowRunsWrapper.test.js +5 -2
- package/wrapper/webhooks/Webhooks.test.js +3 -0
- package/api/types/BatchProcessorRun.d.ts +0 -66
- package/api/types/BatchProcessorRunMetrics.d.ts +0 -6
- package/api/types/BatchProcessorRunOptions.d.ts +0 -9
- package/api/types/BatchProcessorRunSource.d.ts +0 -12
- package/api/types/BatchProcessorRunSource.js +0 -15
- package/api/types/BatchProcessorRunStatus.d.ts +0 -14
- package/api/types/BatchProcessorRunStatus.js +0 -17
- package/api/types/BatchRunEntity.d.ts +0 -18
- package/api/types/BatchRunEntityVersion.d.ts +0 -18
- package/api/types/BatchRunMetrics.d.ts +0 -6
- /package/api/{types/BatchProcessorRun.js → resources/batchProcessorRun/client/requests/BatchProcessorRunGetRequest.js} +0 -0
- /package/api/{types/BatchProcessorRunMetrics.js → resources/classifierVersions/client/requests/ClassifierVersionsRetrieveRequest.js} +0 -0
- /package/api/{types/BatchProcessorRunOptions.js → resources/classifiers/client/requests/ClassifiersRetrieveRequest.js} +0 -0
- /package/api/{types/BatchRunEntity.js → resources/classifyRuns/client/requests/ClassifyRunsCancelRequest.js} +0 -0
- /package/api/{types/BatchRunEntityVersion.js → resources/classifyRuns/client/requests/ClassifyRunsCreateBatchRequest.js} +0 -0
- /package/api/{types/BatchRunMetrics.js → resources/classifyRuns/client/requests/ClassifyRunsDeleteRequest.js} +0 -0
|
@@ -65,6 +65,7 @@ export declare class EvaluationSetsClient {
|
|
|
65
65
|
* @param {string} id - The ID of the evaluation set.
|
|
66
66
|
*
|
|
67
67
|
* Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
|
|
68
|
+
* @param {Extend.EvaluationSetsRetrieveRequest} request
|
|
68
69
|
* @param {EvaluationSetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
69
70
|
*
|
|
70
71
|
* @throws {@link Extend.BadRequestError}
|
|
@@ -79,6 +80,6 @@ export declare class EvaluationSetsClient {
|
|
|
79
80
|
* @example
|
|
80
81
|
* await client.evaluationSets.retrieve("evaluation_set_id_here")
|
|
81
82
|
*/
|
|
82
|
-
retrieve(id: string, requestOptions?: EvaluationSetsClient.RequestOptions): core.HttpResponsePromise<Extend.EvaluationSet>;
|
|
83
|
+
retrieve(id: string, request?: Extend.EvaluationSetsRetrieveRequest, requestOptions?: EvaluationSetsClient.RequestOptions): core.HttpResponsePromise<Extend.EvaluationSet>;
|
|
83
84
|
private __retrieve;
|
|
84
85
|
}
|
|
@@ -82,7 +82,7 @@ class EvaluationSetsClient {
|
|
|
82
82
|
__list() {
|
|
83
83
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
84
84
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
85
|
-
const { entityId, sortBy, sortDir, nextPageToken, maxPageSize } = request;
|
|
85
|
+
const { entityId, sortBy, sortDir, nextPageToken, maxPageSize, "x-extend-workspace-id": extendWorkspaceId, } = request;
|
|
86
86
|
const _queryParams = {
|
|
87
87
|
entityId,
|
|
88
88
|
sortBy: sortBy != null ? sortBy : undefined,
|
|
@@ -91,7 +91,10 @@ class EvaluationSetsClient {
|
|
|
91
91
|
maxPageSize,
|
|
92
92
|
};
|
|
93
93
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
94
|
-
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
94
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
95
|
+
"x-extend-workspace-id": extendWorkspaceId,
|
|
96
|
+
"x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09",
|
|
97
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
95
98
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
96
99
|
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, "evaluation_sets"),
|
|
97
100
|
method: "GET",
|
|
@@ -219,6 +222,7 @@ class EvaluationSetsClient {
|
|
|
219
222
|
* @param {string} id - The ID of the evaluation set.
|
|
220
223
|
*
|
|
221
224
|
* Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
|
|
225
|
+
* @param {Extend.EvaluationSetsRetrieveRequest} request
|
|
222
226
|
* @param {EvaluationSetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
223
227
|
*
|
|
224
228
|
* @throws {@link Extend.BadRequestError}
|
|
@@ -233,14 +237,18 @@ class EvaluationSetsClient {
|
|
|
233
237
|
* @example
|
|
234
238
|
* await client.evaluationSets.retrieve("evaluation_set_id_here")
|
|
235
239
|
*/
|
|
236
|
-
retrieve(id, requestOptions) {
|
|
237
|
-
return core.HttpResponsePromise.fromPromise(this.__retrieve(id, requestOptions));
|
|
240
|
+
retrieve(id, request = {}, requestOptions) {
|
|
241
|
+
return core.HttpResponsePromise.fromPromise(this.__retrieve(id, request, requestOptions));
|
|
238
242
|
}
|
|
239
|
-
__retrieve(
|
|
240
|
-
return __awaiter(this,
|
|
243
|
+
__retrieve(id_1) {
|
|
244
|
+
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
|
|
241
245
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
246
|
+
const { "x-extend-workspace-id": extendWorkspaceId } = request;
|
|
242
247
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
243
|
-
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
248
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
249
|
+
"x-extend-workspace-id": extendWorkspaceId,
|
|
250
|
+
"x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09",
|
|
251
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
244
252
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
245
253
|
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, `evaluation_sets/${core.url.encodePathParam(id)}`),
|
|
246
254
|
method: "GET",
|
|
@@ -17,4 +17,6 @@ export interface EvaluationSetsListRequest {
|
|
|
17
17
|
sortDir?: Extend.SortDir;
|
|
18
18
|
nextPageToken?: Extend.NextPageToken;
|
|
19
19
|
maxPageSize?: Extend.MaxPageSize;
|
|
20
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/developers/authentication) for details on API key scopes. */
|
|
21
|
+
"x-extend-workspace-id"?: string;
|
|
20
22
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface EvaluationSetsRetrieveRequest {
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/developers/authentication) for details on API key scopes. */
|
|
7
|
+
"x-extend-workspace-id"?: string;
|
|
8
|
+
}
|
|
@@ -71,6 +71,7 @@ export declare class ExtractRunsClient {
|
|
|
71
71
|
* @param {string} id - The unique identifier for this extract run.
|
|
72
72
|
*
|
|
73
73
|
* Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
74
|
+
* @param {Extend.ExtractRunsRetrieveRequest} request
|
|
74
75
|
* @param {ExtractRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
75
76
|
*
|
|
76
77
|
* @throws {@link Extend.BadRequestError}
|
|
@@ -85,7 +86,7 @@ export declare class ExtractRunsClient {
|
|
|
85
86
|
* @example
|
|
86
87
|
* await client.extractRuns.retrieve("extract_run_id_here")
|
|
87
88
|
*/
|
|
88
|
-
retrieve(id: string, requestOptions?: ExtractRunsClient.RequestOptions): core.HttpResponsePromise<Extend.ExtractRun>;
|
|
89
|
+
retrieve(id: string, request?: Extend.ExtractRunsRetrieveRequest, requestOptions?: ExtractRunsClient.RequestOptions): core.HttpResponsePromise<Extend.ExtractRun>;
|
|
89
90
|
private __retrieve;
|
|
90
91
|
/**
|
|
91
92
|
* Delete an extract run and all associated data from Extend. This operation is permanent and cannot be undone.
|
|
@@ -93,6 +94,7 @@ export declare class ExtractRunsClient {
|
|
|
93
94
|
* This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
|
|
94
95
|
*
|
|
95
96
|
* @param {string} id - The ID of the extract run.
|
|
97
|
+
* @param {Extend.ExtractRunsDeleteRequest} request
|
|
96
98
|
* @param {ExtractRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
97
99
|
*
|
|
98
100
|
* @throws {@link Extend.BadRequestError}
|
|
@@ -107,7 +109,7 @@ export declare class ExtractRunsClient {
|
|
|
107
109
|
* @example
|
|
108
110
|
* await client.extractRuns.delete("id")
|
|
109
111
|
*/
|
|
110
|
-
delete(id: string, requestOptions?: ExtractRunsClient.RequestOptions): core.HttpResponsePromise<Extend.ExtractRunsDeleteResponse>;
|
|
112
|
+
delete(id: string, request?: Extend.ExtractRunsDeleteRequest, requestOptions?: ExtractRunsClient.RequestOptions): core.HttpResponsePromise<Extend.ExtractRunsDeleteResponse>;
|
|
111
113
|
private __delete;
|
|
112
114
|
/**
|
|
113
115
|
* Cancel an in-progress extract run.
|
|
@@ -117,6 +119,7 @@ export declare class ExtractRunsClient {
|
|
|
117
119
|
* @param {string} id - The ID of the extract run to cancel.
|
|
118
120
|
*
|
|
119
121
|
* Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
122
|
+
* @param {Extend.ExtractRunsCancelRequest} request
|
|
120
123
|
* @param {ExtractRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
121
124
|
*
|
|
122
125
|
* @throws {@link Extend.BadRequestError}
|
|
@@ -131,6 +134,63 @@ export declare class ExtractRunsClient {
|
|
|
131
134
|
* @example
|
|
132
135
|
* await client.extractRuns.cancel("extract_run_id_here")
|
|
133
136
|
*/
|
|
134
|
-
cancel(id: string, requestOptions?: ExtractRunsClient.RequestOptions): core.HttpResponsePromise<Extend.ExtractRun>;
|
|
137
|
+
cancel(id: string, request?: Extend.ExtractRunsCancelRequest, requestOptions?: ExtractRunsClient.RequestOptions): core.HttpResponsePromise<Extend.ExtractRun>;
|
|
135
138
|
private __cancel;
|
|
139
|
+
/**
|
|
140
|
+
* Submit up to **1,000 files** for extraction in a single request. Each file is processed as an independent extract run using the same extractor and configuration.
|
|
141
|
+
*
|
|
142
|
+
* Unlike the single [Extract File (Async)](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/extract/create-extract-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
|
|
143
|
+
*
|
|
144
|
+
* **Monitoring results:**
|
|
145
|
+
* - **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /extract_runs?batchId={id}`.
|
|
146
|
+
* - **Polling:** Call `GET /batch_runs/{id}` to check the overall batch status, and use `GET /extract_runs` filtered by `batchId` to retrieve individual run results.
|
|
147
|
+
*
|
|
148
|
+
* **Notes:**
|
|
149
|
+
* - A processor reference (`extractor.id`) is required — inline `config` is not supported for batch requests.
|
|
150
|
+
* - `inputs` must contain between 1 and 1,000 items.
|
|
151
|
+
* - All inputs in a batch use the same extractor version and override config.
|
|
152
|
+
*
|
|
153
|
+
* @param {Extend.ExtractRunsCreateBatchRequest} request
|
|
154
|
+
* @param {ExtractRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
155
|
+
*
|
|
156
|
+
* @throws {@link Extend.BadRequestError}
|
|
157
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
158
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
159
|
+
* @throws {@link Extend.ForbiddenError}
|
|
160
|
+
* @throws {@link Extend.NotFoundError}
|
|
161
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
162
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
163
|
+
* @throws {@link Extend.InternalServerError}
|
|
164
|
+
*
|
|
165
|
+
* @example
|
|
166
|
+
* await client.extractRuns.createBatch({
|
|
167
|
+
* extractor: {
|
|
168
|
+
* id: "ex_xK9mLPqRtN3vS8wF5hB2cQ"
|
|
169
|
+
* },
|
|
170
|
+
* inputs: [{
|
|
171
|
+
* file: {
|
|
172
|
+
* url: "https://example.com/invoice1.pdf"
|
|
173
|
+
* },
|
|
174
|
+
* metadata: {
|
|
175
|
+
* "customerId": "cust_abc123"
|
|
176
|
+
* }
|
|
177
|
+
* }, {
|
|
178
|
+
* file: {
|
|
179
|
+
* url: "https://example.com/invoice2.pdf"
|
|
180
|
+
* },
|
|
181
|
+
* metadata: {
|
|
182
|
+
* "customerId": "cust_def456"
|
|
183
|
+
* }
|
|
184
|
+
* }, {
|
|
185
|
+
* file: {
|
|
186
|
+
* url: "https://example.com/invoice3.pdf"
|
|
187
|
+
* },
|
|
188
|
+
* metadata: {
|
|
189
|
+
* "customerId": "cust_ghi789"
|
|
190
|
+
* }
|
|
191
|
+
* }]
|
|
192
|
+
* })
|
|
193
|
+
*/
|
|
194
|
+
createBatch(request: Extend.ExtractRunsCreateBatchRequest, requestOptions?: ExtractRunsClient.RequestOptions): core.HttpResponsePromise<Extend.BatchRun>;
|
|
195
|
+
private __createBatch;
|
|
136
196
|
}
|
|
@@ -83,10 +83,11 @@ class ExtractRunsClient {
|
|
|
83
83
|
__list() {
|
|
84
84
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
85
85
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
86
|
-
const { status, extractorId, sourceId, source, fileNameContains, sortBy, sortDir, nextPageToken, maxPageSize } = request;
|
|
86
|
+
const { status, extractorId, batchId, sourceId, source, fileNameContains, sortBy, sortDir, nextPageToken, maxPageSize, "x-extend-workspace-id": extendWorkspaceId, } = request;
|
|
87
87
|
const _queryParams = {
|
|
88
88
|
status: status != null ? status : undefined,
|
|
89
89
|
extractorId,
|
|
90
|
+
batchId,
|
|
90
91
|
sourceId,
|
|
91
92
|
source: source != null ? source : undefined,
|
|
92
93
|
fileNameContains,
|
|
@@ -96,7 +97,10 @@ class ExtractRunsClient {
|
|
|
96
97
|
maxPageSize,
|
|
97
98
|
};
|
|
98
99
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
99
|
-
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
100
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
101
|
+
"x-extend-workspace-id": extendWorkspaceId,
|
|
102
|
+
"x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09",
|
|
103
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
100
104
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
101
105
|
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, "extract_runs"),
|
|
102
106
|
method: "GET",
|
|
@@ -229,6 +233,7 @@ class ExtractRunsClient {
|
|
|
229
233
|
* @param {string} id - The unique identifier for this extract run.
|
|
230
234
|
*
|
|
231
235
|
* Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
236
|
+
* @param {Extend.ExtractRunsRetrieveRequest} request
|
|
232
237
|
* @param {ExtractRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
233
238
|
*
|
|
234
239
|
* @throws {@link Extend.BadRequestError}
|
|
@@ -243,14 +248,18 @@ class ExtractRunsClient {
|
|
|
243
248
|
* @example
|
|
244
249
|
* await client.extractRuns.retrieve("extract_run_id_here")
|
|
245
250
|
*/
|
|
246
|
-
retrieve(id, requestOptions) {
|
|
247
|
-
return core.HttpResponsePromise.fromPromise(this.__retrieve(id, requestOptions));
|
|
251
|
+
retrieve(id, request = {}, requestOptions) {
|
|
252
|
+
return core.HttpResponsePromise.fromPromise(this.__retrieve(id, request, requestOptions));
|
|
248
253
|
}
|
|
249
|
-
__retrieve(
|
|
250
|
-
return __awaiter(this,
|
|
254
|
+
__retrieve(id_1) {
|
|
255
|
+
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
|
|
251
256
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
257
|
+
const { "x-extend-workspace-id": extendWorkspaceId } = request;
|
|
252
258
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
253
|
-
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
259
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
260
|
+
"x-extend-workspace-id": extendWorkspaceId,
|
|
261
|
+
"x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09",
|
|
262
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
254
263
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
255
264
|
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, `extract_runs/${core.url.encodePathParam(id)}`),
|
|
256
265
|
method: "GET",
|
|
@@ -300,6 +309,7 @@ class ExtractRunsClient {
|
|
|
300
309
|
* This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
|
|
301
310
|
*
|
|
302
311
|
* @param {string} id - The ID of the extract run.
|
|
312
|
+
* @param {Extend.ExtractRunsDeleteRequest} request
|
|
303
313
|
* @param {ExtractRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
304
314
|
*
|
|
305
315
|
* @throws {@link Extend.BadRequestError}
|
|
@@ -314,14 +324,18 @@ class ExtractRunsClient {
|
|
|
314
324
|
* @example
|
|
315
325
|
* await client.extractRuns.delete("id")
|
|
316
326
|
*/
|
|
317
|
-
delete(id, requestOptions) {
|
|
318
|
-
return core.HttpResponsePromise.fromPromise(this.__delete(id, requestOptions));
|
|
327
|
+
delete(id, request = {}, requestOptions) {
|
|
328
|
+
return core.HttpResponsePromise.fromPromise(this.__delete(id, request, requestOptions));
|
|
319
329
|
}
|
|
320
|
-
__delete(
|
|
321
|
-
return __awaiter(this,
|
|
330
|
+
__delete(id_1) {
|
|
331
|
+
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
|
|
322
332
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
333
|
+
const { "x-extend-workspace-id": extendWorkspaceId } = request;
|
|
323
334
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
324
|
-
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
335
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
336
|
+
"x-extend-workspace-id": extendWorkspaceId,
|
|
337
|
+
"x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09",
|
|
338
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
325
339
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
326
340
|
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, `extract_runs/${core.url.encodePathParam(id)}`),
|
|
327
341
|
method: "DELETE",
|
|
@@ -373,6 +387,7 @@ class ExtractRunsClient {
|
|
|
373
387
|
* @param {string} id - The ID of the extract run to cancel.
|
|
374
388
|
*
|
|
375
389
|
* Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
390
|
+
* @param {Extend.ExtractRunsCancelRequest} request
|
|
376
391
|
* @param {ExtractRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
377
392
|
*
|
|
378
393
|
* @throws {@link Extend.BadRequestError}
|
|
@@ -387,14 +402,18 @@ class ExtractRunsClient {
|
|
|
387
402
|
* @example
|
|
388
403
|
* await client.extractRuns.cancel("extract_run_id_here")
|
|
389
404
|
*/
|
|
390
|
-
cancel(id, requestOptions) {
|
|
391
|
-
return core.HttpResponsePromise.fromPromise(this.__cancel(id, requestOptions));
|
|
405
|
+
cancel(id, request = {}, requestOptions) {
|
|
406
|
+
return core.HttpResponsePromise.fromPromise(this.__cancel(id, request, requestOptions));
|
|
392
407
|
}
|
|
393
|
-
__cancel(
|
|
394
|
-
return __awaiter(this,
|
|
408
|
+
__cancel(id_1) {
|
|
409
|
+
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
|
|
395
410
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
411
|
+
const { "x-extend-workspace-id": extendWorkspaceId } = request;
|
|
396
412
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
397
|
-
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
413
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
|
|
414
|
+
"x-extend-workspace-id": extendWorkspaceId,
|
|
415
|
+
"x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09",
|
|
416
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
398
417
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
399
418
|
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, `extract_runs/${core.url.encodePathParam(id)}/cancel`),
|
|
400
419
|
method: "POST",
|
|
@@ -438,5 +457,114 @@ class ExtractRunsClient {
|
|
|
438
457
|
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/extract_runs/{id}/cancel");
|
|
439
458
|
});
|
|
440
459
|
}
|
|
460
|
+
/**
|
|
461
|
+
* Submit up to **1,000 files** for extraction in a single request. Each file is processed as an independent extract run using the same extractor and configuration.
|
|
462
|
+
*
|
|
463
|
+
* Unlike the single [Extract File (Async)](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/extract/create-extract-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
|
|
464
|
+
*
|
|
465
|
+
* **Monitoring results:**
|
|
466
|
+
* - **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /extract_runs?batchId={id}`.
|
|
467
|
+
* - **Polling:** Call `GET /batch_runs/{id}` to check the overall batch status, and use `GET /extract_runs` filtered by `batchId` to retrieve individual run results.
|
|
468
|
+
*
|
|
469
|
+
* **Notes:**
|
|
470
|
+
* - A processor reference (`extractor.id`) is required — inline `config` is not supported for batch requests.
|
|
471
|
+
* - `inputs` must contain between 1 and 1,000 items.
|
|
472
|
+
* - All inputs in a batch use the same extractor version and override config.
|
|
473
|
+
*
|
|
474
|
+
* @param {Extend.ExtractRunsCreateBatchRequest} request
|
|
475
|
+
* @param {ExtractRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
476
|
+
*
|
|
477
|
+
* @throws {@link Extend.BadRequestError}
|
|
478
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
479
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
480
|
+
* @throws {@link Extend.ForbiddenError}
|
|
481
|
+
* @throws {@link Extend.NotFoundError}
|
|
482
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
483
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
484
|
+
* @throws {@link Extend.InternalServerError}
|
|
485
|
+
*
|
|
486
|
+
* @example
|
|
487
|
+
* await client.extractRuns.createBatch({
|
|
488
|
+
* extractor: {
|
|
489
|
+
* id: "ex_xK9mLPqRtN3vS8wF5hB2cQ"
|
|
490
|
+
* },
|
|
491
|
+
* inputs: [{
|
|
492
|
+
* file: {
|
|
493
|
+
* url: "https://example.com/invoice1.pdf"
|
|
494
|
+
* },
|
|
495
|
+
* metadata: {
|
|
496
|
+
* "customerId": "cust_abc123"
|
|
497
|
+
* }
|
|
498
|
+
* }, {
|
|
499
|
+
* file: {
|
|
500
|
+
* url: "https://example.com/invoice2.pdf"
|
|
501
|
+
* },
|
|
502
|
+
* metadata: {
|
|
503
|
+
* "customerId": "cust_def456"
|
|
504
|
+
* }
|
|
505
|
+
* }, {
|
|
506
|
+
* file: {
|
|
507
|
+
* url: "https://example.com/invoice3.pdf"
|
|
508
|
+
* },
|
|
509
|
+
* metadata: {
|
|
510
|
+
* "customerId": "cust_ghi789"
|
|
511
|
+
* }
|
|
512
|
+
* }]
|
|
513
|
+
* })
|
|
514
|
+
*/
|
|
515
|
+
createBatch(request, requestOptions) {
|
|
516
|
+
return core.HttpResponsePromise.fromPromise(this.__createBatch(request, requestOptions));
|
|
517
|
+
}
|
|
518
|
+
__createBatch(request, requestOptions) {
|
|
519
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
520
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
521
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
522
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
523
|
+
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
524
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, "extract_runs/batch"),
|
|
525
|
+
method: "POST",
|
|
526
|
+
headers: _headers,
|
|
527
|
+
contentType: "application/json",
|
|
528
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
529
|
+
requestType: "json",
|
|
530
|
+
body: request,
|
|
531
|
+
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 300) * 1000,
|
|
532
|
+
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
533
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
534
|
+
fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
|
|
535
|
+
logging: this._options.logging,
|
|
536
|
+
});
|
|
537
|
+
if (_response.ok) {
|
|
538
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
539
|
+
}
|
|
540
|
+
if (_response.error.reason === "status-code") {
|
|
541
|
+
switch (_response.error.statusCode) {
|
|
542
|
+
case 400:
|
|
543
|
+
throw new Extend.BadRequestError(_response.error.body, _response.rawResponse);
|
|
544
|
+
case 401:
|
|
545
|
+
throw new Extend.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
546
|
+
case 402:
|
|
547
|
+
throw new Extend.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
548
|
+
case 403:
|
|
549
|
+
throw new Extend.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
550
|
+
case 404:
|
|
551
|
+
throw new Extend.NotFoundError(_response.error.body, _response.rawResponse);
|
|
552
|
+
case 422:
|
|
553
|
+
throw new Extend.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
554
|
+
case 429:
|
|
555
|
+
throw new Extend.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
556
|
+
case 500:
|
|
557
|
+
throw new Extend.InternalServerError(_response.error.body, _response.rawResponse);
|
|
558
|
+
default:
|
|
559
|
+
throw new errors.ExtendError({
|
|
560
|
+
statusCode: _response.error.statusCode,
|
|
561
|
+
body: _response.error.body,
|
|
562
|
+
rawResponse: _response.rawResponse,
|
|
563
|
+
});
|
|
564
|
+
}
|
|
565
|
+
}
|
|
566
|
+
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/extract_runs/batch");
|
|
567
|
+
});
|
|
568
|
+
}
|
|
441
569
|
}
|
|
442
570
|
exports.ExtractRunsClient = ExtractRunsClient;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface ExtractRunsCancelRequest {
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/developers/authentication) for details on API key scopes. */
|
|
7
|
+
"x-extend-workspace-id"?: string;
|
|
8
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type * as Extend from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* extractor: {
|
|
6
|
+
* id: "ex_xK9mLPqRtN3vS8wF5hB2cQ"
|
|
7
|
+
* },
|
|
8
|
+
* inputs: [{
|
|
9
|
+
* file: {
|
|
10
|
+
* url: "https://example.com/invoice1.pdf"
|
|
11
|
+
* },
|
|
12
|
+
* metadata: {
|
|
13
|
+
* "customerId": "cust_abc123"
|
|
14
|
+
* }
|
|
15
|
+
* }, {
|
|
16
|
+
* file: {
|
|
17
|
+
* url: "https://example.com/invoice2.pdf"
|
|
18
|
+
* },
|
|
19
|
+
* metadata: {
|
|
20
|
+
* "customerId": "cust_def456"
|
|
21
|
+
* }
|
|
22
|
+
* }, {
|
|
23
|
+
* file: {
|
|
24
|
+
* url: "https://example.com/invoice3.pdf"
|
|
25
|
+
* },
|
|
26
|
+
* metadata: {
|
|
27
|
+
* "customerId": "cust_ghi789"
|
|
28
|
+
* }
|
|
29
|
+
* }]
|
|
30
|
+
* }
|
|
31
|
+
*/
|
|
32
|
+
export interface ExtractRunsCreateBatchRequest {
|
|
33
|
+
/** Reference to the extractor to run against every input in this batch. */
|
|
34
|
+
extractor: Extend.ExtractRunsCreateBatchRequestExtractor;
|
|
35
|
+
/** An array of inputs to process. Each item produces one extract run. Must contain between 1 and 1,000 items. */
|
|
36
|
+
inputs: Extend.ExtractRunsCreateBatchRequestInputsItem[];
|
|
37
|
+
priority?: Extend.RunPriority;
|
|
38
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface ExtractRunsDeleteRequest {
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/developers/authentication) for details on API key scopes. */
|
|
7
|
+
"x-extend-workspace-id"?: string;
|
|
8
|
+
}
|
|
@@ -13,6 +13,12 @@ export interface ExtractRunsListRequest {
|
|
|
13
13
|
* Example: `"ex_BMdfq_yWM3sT-ZzvCnA3f"`
|
|
14
14
|
*/
|
|
15
15
|
extractorId?: string;
|
|
16
|
+
/**
|
|
17
|
+
* Filters runs by the batch they belong to. Only returns runs created as part of the specified batch.
|
|
18
|
+
*
|
|
19
|
+
* Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
20
|
+
*/
|
|
21
|
+
batchId?: string;
|
|
16
22
|
/** Filters runs by the source ID. */
|
|
17
23
|
sourceId?: Extend.RunSourceId;
|
|
18
24
|
/** Filters runs by the source that created them. If not provided, runs from all sources are returned. */
|
|
@@ -27,4 +33,6 @@ export interface ExtractRunsListRequest {
|
|
|
27
33
|
sortDir?: Extend.SortDir;
|
|
28
34
|
nextPageToken?: Extend.NextPageToken;
|
|
29
35
|
maxPageSize?: Extend.MaxPageSize;
|
|
36
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/developers/authentication) for details on API key scopes. */
|
|
37
|
+
"x-extend-workspace-id"?: string;
|
|
30
38
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface ExtractRunsRetrieveRequest {
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/developers/authentication) for details on API key scopes. */
|
|
7
|
+
"x-extend-workspace-id"?: string;
|
|
8
|
+
}
|
|
@@ -1,2 +1,6 @@
|
|
|
1
|
+
export type { ExtractRunsCancelRequest } from "./ExtractRunsCancelRequest";
|
|
2
|
+
export type { ExtractRunsCreateBatchRequest } from "./ExtractRunsCreateBatchRequest";
|
|
1
3
|
export type { ExtractRunsCreateRequest } from "./ExtractRunsCreateRequest";
|
|
4
|
+
export type { ExtractRunsDeleteRequest } from "./ExtractRunsDeleteRequest";
|
|
2
5
|
export type { ExtractRunsListRequest } from "./ExtractRunsListRequest";
|
|
6
|
+
export type { ExtractRunsRetrieveRequest } from "./ExtractRunsRetrieveRequest";
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Extend from "../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* Reference to the extractor to run against every input in this batch.
|
|
4
|
+
*/
|
|
5
|
+
export interface ExtractRunsCreateBatchRequestExtractor {
|
|
6
|
+
/** The ID of the extractor to use. */
|
|
7
|
+
id: string;
|
|
8
|
+
version?: Extend.ProcessorVersionString;
|
|
9
|
+
/** Optional partial configuration override applied to every run in this batch. Only the fields you provide will override the extractor's saved configuration. */
|
|
10
|
+
overrideConfig?: Extend.ExtractOverrideConfigJson;
|
|
11
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type * as Extend from "../../../index";
|
|
2
|
+
export interface ExtractRunsCreateBatchRequestInputsItem {
|
|
3
|
+
/** The file to extract from. Can be a URL, an Extend file ID, or raw text. */
|
|
4
|
+
file: Extend.ExtractRunsCreateBatchRequestInputsItemFile;
|
|
5
|
+
metadata?: Extend.RunMetadata;
|
|
6
|
+
}
|
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
export * from "./ExtractRunsCreateBatchRequestExtractor";
|
|
2
|
+
export * from "./ExtractRunsCreateBatchRequestInputsItem";
|
|
3
|
+
export * from "./ExtractRunsCreateBatchRequestInputsItemFile";
|
|
1
4
|
export * from "./ExtractRunsCreateRequestExtractor";
|
|
2
5
|
export * from "./ExtractRunsCreateRequestFile";
|
|
3
6
|
export * from "./ExtractRunsDeleteResponse";
|
|
@@ -14,6 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./ExtractRunsCreateBatchRequestExtractor"), exports);
|
|
18
|
+
__exportStar(require("./ExtractRunsCreateBatchRequestInputsItem"), exports);
|
|
19
|
+
__exportStar(require("./ExtractRunsCreateBatchRequestInputsItemFile"), exports);
|
|
17
20
|
__exportStar(require("./ExtractRunsCreateRequestExtractor"), exports);
|
|
18
21
|
__exportStar(require("./ExtractRunsCreateRequestFile"), exports);
|
|
19
22
|
__exportStar(require("./ExtractRunsDeleteResponse"), exports);
|