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
package/reference.md
CHANGED
|
@@ -563,7 +563,7 @@ Example: `"file_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
563
563
|
</dl>
|
|
564
564
|
</details>
|
|
565
565
|
|
|
566
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id) -> Extend.FilesDeleteResponse</code></summary>
|
|
566
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id, { ...params }) -> Extend.FilesDeleteResponse</code></summary>
|
|
567
567
|
<dl>
|
|
568
568
|
<dd>
|
|
569
569
|
|
|
@@ -620,6 +620,14 @@ Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
620
620
|
<dl>
|
|
621
621
|
<dd>
|
|
622
622
|
|
|
623
|
+
**request:** `Extend.FilesDeleteRequest`
|
|
624
|
+
|
|
625
|
+
</dd>
|
|
626
|
+
</dl>
|
|
627
|
+
|
|
628
|
+
<dl>
|
|
629
|
+
<dd>
|
|
630
|
+
|
|
623
631
|
**requestOptions:** `FilesClient.RequestOptions`
|
|
624
632
|
|
|
625
633
|
</dd>
|
|
@@ -861,7 +869,7 @@ Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
861
869
|
</dl>
|
|
862
870
|
</details>
|
|
863
871
|
|
|
864
|
-
<details><summary><code>client.parseRuns.<a href="/src/api/resources/parseRuns/client/Client.ts">delete</a>(id) -> Extend.ParseRunsDeleteResponse</code></summary>
|
|
872
|
+
<details><summary><code>client.parseRuns.<a href="/src/api/resources/parseRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.ParseRunsDeleteResponse</code></summary>
|
|
865
873
|
<dl>
|
|
866
874
|
<dd>
|
|
867
875
|
|
|
@@ -918,6 +926,14 @@ Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
918
926
|
<dl>
|
|
919
927
|
<dd>
|
|
920
928
|
|
|
929
|
+
**request:** `Extend.ParseRunsDeleteRequest`
|
|
930
|
+
|
|
931
|
+
</dd>
|
|
932
|
+
</dl>
|
|
933
|
+
|
|
934
|
+
<dl>
|
|
935
|
+
<dd>
|
|
936
|
+
|
|
921
937
|
**requestOptions:** `ParseRunsClient.RequestOptions`
|
|
922
938
|
|
|
923
939
|
</dd>
|
|
@@ -1008,7 +1024,7 @@ await client.editRuns.create({
|
|
|
1008
1024
|
</dl>
|
|
1009
1025
|
</details>
|
|
1010
1026
|
|
|
1011
|
-
<details><summary><code>client.editRuns.<a href="/src/api/resources/editRuns/client/Client.ts">retrieve</a>(id) -> Extend.EditRun</code></summary>
|
|
1027
|
+
<details><summary><code>client.editRuns.<a href="/src/api/resources/editRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.EditRun</code></summary>
|
|
1012
1028
|
<dl>
|
|
1013
1029
|
<dd>
|
|
1014
1030
|
|
|
@@ -1065,6 +1081,14 @@ Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1065
1081
|
<dl>
|
|
1066
1082
|
<dd>
|
|
1067
1083
|
|
|
1084
|
+
**request:** `Extend.EditRunsRetrieveRequest`
|
|
1085
|
+
|
|
1086
|
+
</dd>
|
|
1087
|
+
</dl>
|
|
1088
|
+
|
|
1089
|
+
<dl>
|
|
1090
|
+
<dd>
|
|
1091
|
+
|
|
1068
1092
|
**requestOptions:** `EditRunsClient.RequestOptions`
|
|
1069
1093
|
|
|
1070
1094
|
</dd>
|
|
@@ -1077,7 +1101,7 @@ Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1077
1101
|
</dl>
|
|
1078
1102
|
</details>
|
|
1079
1103
|
|
|
1080
|
-
<details><summary><code>client.editRuns.<a href="/src/api/resources/editRuns/client/Client.ts">delete</a>(id) -> Extend.EditRunsDeleteResponse</code></summary>
|
|
1104
|
+
<details><summary><code>client.editRuns.<a href="/src/api/resources/editRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.EditRunsDeleteResponse</code></summary>
|
|
1081
1105
|
<dl>
|
|
1082
1106
|
<dd>
|
|
1083
1107
|
|
|
@@ -1134,6 +1158,14 @@ Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1134
1158
|
<dl>
|
|
1135
1159
|
<dd>
|
|
1136
1160
|
|
|
1161
|
+
**request:** `Extend.EditRunsDeleteRequest`
|
|
1162
|
+
|
|
1163
|
+
</dd>
|
|
1164
|
+
</dl>
|
|
1165
|
+
|
|
1166
|
+
<dl>
|
|
1167
|
+
<dd>
|
|
1168
|
+
|
|
1137
1169
|
**requestOptions:** `EditRunsClient.RequestOptions`
|
|
1138
1170
|
|
|
1139
1171
|
</dd>
|
|
@@ -1142,6 +1174,86 @@ Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1142
1174
|
</dl>
|
|
1143
1175
|
|
|
1144
1176
|
|
|
1177
|
+
</dd>
|
|
1178
|
+
</dl>
|
|
1179
|
+
</details>
|
|
1180
|
+
|
|
1181
|
+
## EditSchemas
|
|
1182
|
+
<details><summary><code>client.editSchemas.<a href="/src/api/resources/editSchemas/client/Client.ts">generate</a>({ ...params }) -> Extend.EditSchemaGenerationResponse</code></summary>
|
|
1183
|
+
<dl>
|
|
1184
|
+
<dd>
|
|
1185
|
+
|
|
1186
|
+
#### 📝 Description
|
|
1187
|
+
|
|
1188
|
+
<dl>
|
|
1189
|
+
<dd>
|
|
1190
|
+
|
|
1191
|
+
<dl>
|
|
1192
|
+
<dd>
|
|
1193
|
+
|
|
1194
|
+
Detect fields in a PDF form and synchronously return an edit schema payload.
|
|
1195
|
+
|
|
1196
|
+
Use this endpoint when you want Extend to bootstrap an `EditRootJSON` schema from an existing form, optionally mapping an existing schema onto the detected fields.
|
|
1197
|
+
|
|
1198
|
+
This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.
|
|
1199
|
+
|
|
1200
|
+
For more details, see the [Generate Edit Schema guide](https://docs.extend.ai/2026-02-09/product/editing/generate-edit-schema) and the [Edit File guide](https://docs.extend.ai/2026-02-09/product/editing/edit).
|
|
1201
|
+
</dd>
|
|
1202
|
+
</dl>
|
|
1203
|
+
</dd>
|
|
1204
|
+
</dl>
|
|
1205
|
+
|
|
1206
|
+
#### 🔌 Usage
|
|
1207
|
+
|
|
1208
|
+
<dl>
|
|
1209
|
+
<dd>
|
|
1210
|
+
|
|
1211
|
+
<dl>
|
|
1212
|
+
<dd>
|
|
1213
|
+
|
|
1214
|
+
```typescript
|
|
1215
|
+
await client.editSchemas.generate({
|
|
1216
|
+
file: {
|
|
1217
|
+
url: "https://example.com/form.pdf"
|
|
1218
|
+
},
|
|
1219
|
+
config: {
|
|
1220
|
+
instructions: "Detect the form fields and use human-readable field names.",
|
|
1221
|
+
advancedOptions: {
|
|
1222
|
+
radioEnumsEnabled: true
|
|
1223
|
+
}
|
|
1224
|
+
}
|
|
1225
|
+
});
|
|
1226
|
+
|
|
1227
|
+
```
|
|
1228
|
+
</dd>
|
|
1229
|
+
</dl>
|
|
1230
|
+
</dd>
|
|
1231
|
+
</dl>
|
|
1232
|
+
|
|
1233
|
+
#### ⚙️ Parameters
|
|
1234
|
+
|
|
1235
|
+
<dl>
|
|
1236
|
+
<dd>
|
|
1237
|
+
|
|
1238
|
+
<dl>
|
|
1239
|
+
<dd>
|
|
1240
|
+
|
|
1241
|
+
**request:** `Extend.EditSchemasGenerateRequest`
|
|
1242
|
+
|
|
1243
|
+
</dd>
|
|
1244
|
+
</dl>
|
|
1245
|
+
|
|
1246
|
+
<dl>
|
|
1247
|
+
<dd>
|
|
1248
|
+
|
|
1249
|
+
**requestOptions:** `EditSchemasClient.RequestOptions`
|
|
1250
|
+
|
|
1251
|
+
</dd>
|
|
1252
|
+
</dl>
|
|
1253
|
+
</dd>
|
|
1254
|
+
</dl>
|
|
1255
|
+
|
|
1256
|
+
|
|
1145
1257
|
</dd>
|
|
1146
1258
|
</dl>
|
|
1147
1259
|
</details>
|
|
@@ -1286,7 +1398,7 @@ await client.extractRuns.create({
|
|
|
1286
1398
|
</dl>
|
|
1287
1399
|
</details>
|
|
1288
1400
|
|
|
1289
|
-
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">retrieve</a>(id) -> Extend.ExtractRun</code></summary>
|
|
1401
|
+
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.ExtractRun</code></summary>
|
|
1290
1402
|
<dl>
|
|
1291
1403
|
<dd>
|
|
1292
1404
|
|
|
@@ -1343,6 +1455,14 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1343
1455
|
<dl>
|
|
1344
1456
|
<dd>
|
|
1345
1457
|
|
|
1458
|
+
**request:** `Extend.ExtractRunsRetrieveRequest`
|
|
1459
|
+
|
|
1460
|
+
</dd>
|
|
1461
|
+
</dl>
|
|
1462
|
+
|
|
1463
|
+
<dl>
|
|
1464
|
+
<dd>
|
|
1465
|
+
|
|
1346
1466
|
**requestOptions:** `ExtractRunsClient.RequestOptions`
|
|
1347
1467
|
|
|
1348
1468
|
</dd>
|
|
@@ -1355,7 +1475,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1355
1475
|
</dl>
|
|
1356
1476
|
</details>
|
|
1357
1477
|
|
|
1358
|
-
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">delete</a>(id) -> Extend.ExtractRunsDeleteResponse</code></summary>
|
|
1478
|
+
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.ExtractRunsDeleteResponse</code></summary>
|
|
1359
1479
|
<dl>
|
|
1360
1480
|
<dd>
|
|
1361
1481
|
|
|
@@ -1408,6 +1528,14 @@ await client.extractRuns.delete("id");
|
|
|
1408
1528
|
<dl>
|
|
1409
1529
|
<dd>
|
|
1410
1530
|
|
|
1531
|
+
**request:** `Extend.ExtractRunsDeleteRequest`
|
|
1532
|
+
|
|
1533
|
+
</dd>
|
|
1534
|
+
</dl>
|
|
1535
|
+
|
|
1536
|
+
<dl>
|
|
1537
|
+
<dd>
|
|
1538
|
+
|
|
1411
1539
|
**requestOptions:** `ExtractRunsClient.RequestOptions`
|
|
1412
1540
|
|
|
1413
1541
|
</dd>
|
|
@@ -1420,7 +1548,7 @@ await client.extractRuns.delete("id");
|
|
|
1420
1548
|
</dl>
|
|
1421
1549
|
</details>
|
|
1422
1550
|
|
|
1423
|
-
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">cancel</a>(id) -> Extend.ExtractRun</code></summary>
|
|
1551
|
+
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.ExtractRun</code></summary>
|
|
1424
1552
|
<dl>
|
|
1425
1553
|
<dd>
|
|
1426
1554
|
|
|
@@ -1477,6 +1605,114 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1477
1605
|
<dl>
|
|
1478
1606
|
<dd>
|
|
1479
1607
|
|
|
1608
|
+
**request:** `Extend.ExtractRunsCancelRequest`
|
|
1609
|
+
|
|
1610
|
+
</dd>
|
|
1611
|
+
</dl>
|
|
1612
|
+
|
|
1613
|
+
<dl>
|
|
1614
|
+
<dd>
|
|
1615
|
+
|
|
1616
|
+
**requestOptions:** `ExtractRunsClient.RequestOptions`
|
|
1617
|
+
|
|
1618
|
+
</dd>
|
|
1619
|
+
</dl>
|
|
1620
|
+
</dd>
|
|
1621
|
+
</dl>
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
</dd>
|
|
1625
|
+
</dl>
|
|
1626
|
+
</details>
|
|
1627
|
+
|
|
1628
|
+
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">createBatch</a>({ ...params }) -> Extend.BatchRun</code></summary>
|
|
1629
|
+
<dl>
|
|
1630
|
+
<dd>
|
|
1631
|
+
|
|
1632
|
+
#### 📝 Description
|
|
1633
|
+
|
|
1634
|
+
<dl>
|
|
1635
|
+
<dd>
|
|
1636
|
+
|
|
1637
|
+
<dl>
|
|
1638
|
+
<dd>
|
|
1639
|
+
|
|
1640
|
+
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.
|
|
1641
|
+
|
|
1642
|
+
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.
|
|
1643
|
+
|
|
1644
|
+
**Monitoring results:**
|
|
1645
|
+
- **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}`.
|
|
1646
|
+
- **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.
|
|
1647
|
+
|
|
1648
|
+
**Notes:**
|
|
1649
|
+
- A processor reference (`extractor.id`) is required — inline `config` is not supported for batch requests.
|
|
1650
|
+
- `inputs` must contain between 1 and 1,000 items.
|
|
1651
|
+
- All inputs in a batch use the same extractor version and override config.
|
|
1652
|
+
</dd>
|
|
1653
|
+
</dl>
|
|
1654
|
+
</dd>
|
|
1655
|
+
</dl>
|
|
1656
|
+
|
|
1657
|
+
#### 🔌 Usage
|
|
1658
|
+
|
|
1659
|
+
<dl>
|
|
1660
|
+
<dd>
|
|
1661
|
+
|
|
1662
|
+
<dl>
|
|
1663
|
+
<dd>
|
|
1664
|
+
|
|
1665
|
+
```typescript
|
|
1666
|
+
await client.extractRuns.createBatch({
|
|
1667
|
+
extractor: {
|
|
1668
|
+
id: "ex_xK9mLPqRtN3vS8wF5hB2cQ"
|
|
1669
|
+
},
|
|
1670
|
+
inputs: [{
|
|
1671
|
+
file: {
|
|
1672
|
+
url: "https://example.com/invoice1.pdf"
|
|
1673
|
+
},
|
|
1674
|
+
metadata: {
|
|
1675
|
+
"customerId": "cust_abc123"
|
|
1676
|
+
}
|
|
1677
|
+
}, {
|
|
1678
|
+
file: {
|
|
1679
|
+
url: "https://example.com/invoice2.pdf"
|
|
1680
|
+
},
|
|
1681
|
+
metadata: {
|
|
1682
|
+
"customerId": "cust_def456"
|
|
1683
|
+
}
|
|
1684
|
+
}, {
|
|
1685
|
+
file: {
|
|
1686
|
+
url: "https://example.com/invoice3.pdf"
|
|
1687
|
+
},
|
|
1688
|
+
metadata: {
|
|
1689
|
+
"customerId": "cust_ghi789"
|
|
1690
|
+
}
|
|
1691
|
+
}]
|
|
1692
|
+
});
|
|
1693
|
+
|
|
1694
|
+
```
|
|
1695
|
+
</dd>
|
|
1696
|
+
</dl>
|
|
1697
|
+
</dd>
|
|
1698
|
+
</dl>
|
|
1699
|
+
|
|
1700
|
+
#### ⚙️ Parameters
|
|
1701
|
+
|
|
1702
|
+
<dl>
|
|
1703
|
+
<dd>
|
|
1704
|
+
|
|
1705
|
+
<dl>
|
|
1706
|
+
<dd>
|
|
1707
|
+
|
|
1708
|
+
**request:** `Extend.ExtractRunsCreateBatchRequest`
|
|
1709
|
+
|
|
1710
|
+
</dd>
|
|
1711
|
+
</dl>
|
|
1712
|
+
|
|
1713
|
+
<dl>
|
|
1714
|
+
<dd>
|
|
1715
|
+
|
|
1480
1716
|
**requestOptions:** `ExtractRunsClient.RequestOptions`
|
|
1481
1717
|
|
|
1482
1718
|
</dd>
|
|
@@ -1641,7 +1877,7 @@ await client.extractors.create({
|
|
|
1641
1877
|
</dl>
|
|
1642
1878
|
</details>
|
|
1643
1879
|
|
|
1644
|
-
<details><summary><code>client.extractors.<a href="/src/api/resources/extractors/client/Client.ts">retrieve</a>(id) -> Extend.Extractor</code></summary>
|
|
1880
|
+
<details><summary><code>client.extractors.<a href="/src/api/resources/extractors/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.Extractor</code></summary>
|
|
1645
1881
|
<dl>
|
|
1646
1882
|
<dd>
|
|
1647
1883
|
|
|
@@ -1696,6 +1932,14 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1696
1932
|
<dl>
|
|
1697
1933
|
<dd>
|
|
1698
1934
|
|
|
1935
|
+
**request:** `Extend.ExtractorsRetrieveRequest`
|
|
1936
|
+
|
|
1937
|
+
</dd>
|
|
1938
|
+
</dl>
|
|
1939
|
+
|
|
1940
|
+
<dl>
|
|
1941
|
+
<dd>
|
|
1942
|
+
|
|
1699
1943
|
**requestOptions:** `ExtractorsClient.RequestOptions`
|
|
1700
1944
|
|
|
1701
1945
|
</dd>
|
|
@@ -1945,7 +2189,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1945
2189
|
</dl>
|
|
1946
2190
|
</details>
|
|
1947
2191
|
|
|
1948
|
-
<details><summary><code>client.extractorVersions.<a href="/src/api/resources/extractorVersions/client/Client.ts">retrieve</a>(extractorId, versionId) -> Extend.ExtractorVersion</code></summary>
|
|
2192
|
+
<details><summary><code>client.extractorVersions.<a href="/src/api/resources/extractorVersions/client/Client.ts">retrieve</a>(extractorId, versionId, { ...params }) -> Extend.ExtractorVersion</code></summary>
|
|
1949
2193
|
<dl>
|
|
1950
2194
|
<dd>
|
|
1951
2195
|
|
|
@@ -1972,7 +2216,7 @@ Retrieve a specific version of an extractor in Extend
|
|
|
1972
2216
|
<dd>
|
|
1973
2217
|
|
|
1974
2218
|
```typescript
|
|
1975
|
-
await client.extractorVersions.retrieve("extractor_id_here", "
|
|
2219
|
+
await client.extractorVersions.retrieve("extractor_id_here", "draft");
|
|
1976
2220
|
|
|
1977
2221
|
```
|
|
1978
2222
|
</dd>
|
|
@@ -2002,9 +2246,20 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2002
2246
|
|
|
2003
2247
|
**versionId:** `string`
|
|
2004
2248
|
|
|
2005
|
-
The
|
|
2249
|
+
The version to retrieve. Accepts any of the following:
|
|
2250
|
+
|
|
2251
|
+
- `"draft"` — returns the current draft version
|
|
2252
|
+
- `"latest"` — returns the latest published version (falls back to draft if none published)
|
|
2253
|
+
- A version number (e.g. `"0.1"`, `"1.0"`) — returns that specific published version
|
|
2254
|
+
- A version ID (e.g. `"extv_QYk6jgHA_8CsO8rVWhyNC"`) — returns that specific version by ID
|
|
2255
|
+
|
|
2256
|
+
</dd>
|
|
2257
|
+
</dl>
|
|
2258
|
+
|
|
2259
|
+
<dl>
|
|
2260
|
+
<dd>
|
|
2006
2261
|
|
|
2007
|
-
|
|
2262
|
+
**request:** `Extend.ExtractorVersionsRetrieveRequest`
|
|
2008
2263
|
|
|
2009
2264
|
</dd>
|
|
2010
2265
|
</dl>
|
|
@@ -2164,7 +2419,7 @@ await client.classifyRuns.create({
|
|
|
2164
2419
|
</dl>
|
|
2165
2420
|
</details>
|
|
2166
2421
|
|
|
2167
|
-
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">retrieve</a>(id) -> Extend.ClassifyRun</code></summary>
|
|
2422
|
+
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.ClassifyRun</code></summary>
|
|
2168
2423
|
<dl>
|
|
2169
2424
|
<dd>
|
|
2170
2425
|
|
|
@@ -2221,6 +2476,14 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2221
2476
|
<dl>
|
|
2222
2477
|
<dd>
|
|
2223
2478
|
|
|
2479
|
+
**request:** `Extend.ClassifyRunsRetrieveRequest`
|
|
2480
|
+
|
|
2481
|
+
</dd>
|
|
2482
|
+
</dl>
|
|
2483
|
+
|
|
2484
|
+
<dl>
|
|
2485
|
+
<dd>
|
|
2486
|
+
|
|
2224
2487
|
**requestOptions:** `ClassifyRunsClient.RequestOptions`
|
|
2225
2488
|
|
|
2226
2489
|
</dd>
|
|
@@ -2233,7 +2496,7 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2233
2496
|
</dl>
|
|
2234
2497
|
</details>
|
|
2235
2498
|
|
|
2236
|
-
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">delete</a>(id) -> Extend.ClassifyRunsDeleteResponse</code></summary>
|
|
2499
|
+
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.ClassifyRunsDeleteResponse</code></summary>
|
|
2237
2500
|
<dl>
|
|
2238
2501
|
<dd>
|
|
2239
2502
|
|
|
@@ -2286,6 +2549,14 @@ await client.classifyRuns.delete("id");
|
|
|
2286
2549
|
<dl>
|
|
2287
2550
|
<dd>
|
|
2288
2551
|
|
|
2552
|
+
**request:** `Extend.ClassifyRunsDeleteRequest`
|
|
2553
|
+
|
|
2554
|
+
</dd>
|
|
2555
|
+
</dl>
|
|
2556
|
+
|
|
2557
|
+
<dl>
|
|
2558
|
+
<dd>
|
|
2559
|
+
|
|
2289
2560
|
**requestOptions:** `ClassifyRunsClient.RequestOptions`
|
|
2290
2561
|
|
|
2291
2562
|
</dd>
|
|
@@ -2298,7 +2569,7 @@ await client.classifyRuns.delete("id");
|
|
|
2298
2569
|
</dl>
|
|
2299
2570
|
</details>
|
|
2300
2571
|
|
|
2301
|
-
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">cancel</a>(id) -> Extend.ClassifyRun</code></summary>
|
|
2572
|
+
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.ClassifyRun</code></summary>
|
|
2302
2573
|
<dl>
|
|
2303
2574
|
<dd>
|
|
2304
2575
|
|
|
@@ -2355,6 +2626,14 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2355
2626
|
<dl>
|
|
2356
2627
|
<dd>
|
|
2357
2628
|
|
|
2629
|
+
**request:** `Extend.ClassifyRunsCancelRequest`
|
|
2630
|
+
|
|
2631
|
+
</dd>
|
|
2632
|
+
</dl>
|
|
2633
|
+
|
|
2634
|
+
<dl>
|
|
2635
|
+
<dd>
|
|
2636
|
+
|
|
2358
2637
|
**requestOptions:** `ClassifyRunsClient.RequestOptions`
|
|
2359
2638
|
|
|
2360
2639
|
</dd>
|
|
@@ -2367,8 +2646,7 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2367
2646
|
</dl>
|
|
2368
2647
|
</details>
|
|
2369
2648
|
|
|
2370
|
-
|
|
2371
|
-
<details><summary><code>client.classifiers.<a href="/src/api/resources/classifiers/client/Client.ts">list</a>({ ...params }) -> Extend.ClassifiersListResponse</code></summary>
|
|
2649
|
+
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">createBatch</a>({ ...params }) -> Extend.BatchRun</code></summary>
|
|
2372
2650
|
<dl>
|
|
2373
2651
|
<dd>
|
|
2374
2652
|
|
|
@@ -2380,9 +2658,18 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2380
2658
|
<dl>
|
|
2381
2659
|
<dd>
|
|
2382
2660
|
|
|
2383
|
-
|
|
2661
|
+
Submit up to **1,000 files** for classification in a single request. Each file is processed as an independent classify run using the same classifier and configuration.
|
|
2384
2662
|
|
|
2385
|
-
|
|
2663
|
+
Unlike the single [Classify File (Async)](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/classify/create-classify-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.
|
|
2664
|
+
|
|
2665
|
+
**Monitoring results:**
|
|
2666
|
+
- **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 /classify_runs?batchId={id}`.
|
|
2667
|
+
- **Polling:** Call `GET /batch_runs/{id}` to check the overall batch status, and use `GET /classify_runs` filtered by `batchId` to retrieve individual run results.
|
|
2668
|
+
|
|
2669
|
+
**Notes:**
|
|
2670
|
+
- A processor reference (`classifier.id`) is required — inline `config` is not supported for batch requests.
|
|
2671
|
+
- `inputs` must contain between 1 and 1,000 items.
|
|
2672
|
+
- All inputs in a batch use the same classifier version and override config.
|
|
2386
2673
|
</dd>
|
|
2387
2674
|
</dl>
|
|
2388
2675
|
</dd>
|
|
@@ -2397,18 +2684,110 @@ Returns a summary of each classifier. Use `GET /classifiers/{id}` to retrieve th
|
|
|
2397
2684
|
<dd>
|
|
2398
2685
|
|
|
2399
2686
|
```typescript
|
|
2400
|
-
await client.
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
|
|
2687
|
+
await client.classifyRuns.createBatch({
|
|
2688
|
+
classifier: {
|
|
2689
|
+
id: "cl_xK9mLPqRtN3vS8wF5hB2cQ"
|
|
2690
|
+
},
|
|
2691
|
+
inputs: [{
|
|
2692
|
+
file: {
|
|
2693
|
+
url: "https://example.com/document1.pdf"
|
|
2694
|
+
},
|
|
2695
|
+
metadata: {
|
|
2696
|
+
"customerId": "cust_abc123"
|
|
2697
|
+
}
|
|
2698
|
+
}, {
|
|
2699
|
+
file: {
|
|
2700
|
+
url: "https://example.com/document2.pdf"
|
|
2701
|
+
},
|
|
2702
|
+
metadata: {
|
|
2703
|
+
"customerId": "cust_def456"
|
|
2704
|
+
}
|
|
2705
|
+
}, {
|
|
2706
|
+
file: {
|
|
2707
|
+
url: "https://example.com/document3.pdf"
|
|
2708
|
+
},
|
|
2709
|
+
metadata: {
|
|
2710
|
+
"customerId": "cust_ghi789"
|
|
2711
|
+
}
|
|
2712
|
+
}]
|
|
2713
|
+
});
|
|
2714
|
+
|
|
2715
|
+
```
|
|
2716
|
+
</dd>
|
|
2717
|
+
</dl>
|
|
2718
|
+
</dd>
|
|
2719
|
+
</dl>
|
|
2720
|
+
|
|
2721
|
+
#### ⚙️ Parameters
|
|
2722
|
+
|
|
2723
|
+
<dl>
|
|
2724
|
+
<dd>
|
|
2725
|
+
|
|
2726
|
+
<dl>
|
|
2727
|
+
<dd>
|
|
2728
|
+
|
|
2729
|
+
**request:** `Extend.ClassifyRunsCreateBatchRequest`
|
|
2730
|
+
|
|
2731
|
+
</dd>
|
|
2732
|
+
</dl>
|
|
2733
|
+
|
|
2734
|
+
<dl>
|
|
2735
|
+
<dd>
|
|
2736
|
+
|
|
2737
|
+
**requestOptions:** `ClassifyRunsClient.RequestOptions`
|
|
2738
|
+
|
|
2739
|
+
</dd>
|
|
2740
|
+
</dl>
|
|
2741
|
+
</dd>
|
|
2742
|
+
</dl>
|
|
2743
|
+
|
|
2744
|
+
|
|
2745
|
+
</dd>
|
|
2746
|
+
</dl>
|
|
2747
|
+
</details>
|
|
2748
|
+
|
|
2749
|
+
## Classifiers
|
|
2750
|
+
<details><summary><code>client.classifiers.<a href="/src/api/resources/classifiers/client/Client.ts">list</a>({ ...params }) -> Extend.ClassifiersListResponse</code></summary>
|
|
2751
|
+
<dl>
|
|
2752
|
+
<dd>
|
|
2753
|
+
|
|
2754
|
+
#### 📝 Description
|
|
2755
|
+
|
|
2756
|
+
<dl>
|
|
2757
|
+
<dd>
|
|
2758
|
+
|
|
2759
|
+
<dl>
|
|
2760
|
+
<dd>
|
|
2761
|
+
|
|
2762
|
+
List all classifiers.
|
|
2763
|
+
|
|
2764
|
+
Returns a summary of each classifier. Use `GET /classifiers/{id}` to retrieve the full object including `draftVersion`.
|
|
2765
|
+
</dd>
|
|
2766
|
+
</dl>
|
|
2767
|
+
</dd>
|
|
2768
|
+
</dl>
|
|
2769
|
+
|
|
2770
|
+
#### 🔌 Usage
|
|
2771
|
+
|
|
2772
|
+
<dl>
|
|
2773
|
+
<dd>
|
|
2774
|
+
|
|
2775
|
+
<dl>
|
|
2776
|
+
<dd>
|
|
2777
|
+
|
|
2778
|
+
```typescript
|
|
2779
|
+
await client.classifiers.list({
|
|
2780
|
+
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
2781
|
+
});
|
|
2782
|
+
|
|
2783
|
+
```
|
|
2784
|
+
</dd>
|
|
2785
|
+
</dl>
|
|
2786
|
+
</dd>
|
|
2787
|
+
</dl>
|
|
2788
|
+
|
|
2789
|
+
#### ⚙️ Parameters
|
|
2790
|
+
|
|
2412
2791
|
<dl>
|
|
2413
2792
|
<dd>
|
|
2414
2793
|
|
|
@@ -2515,7 +2894,7 @@ await client.classifiers.create({
|
|
|
2515
2894
|
</dl>
|
|
2516
2895
|
</details>
|
|
2517
2896
|
|
|
2518
|
-
<details><summary><code>client.classifiers.<a href="/src/api/resources/classifiers/client/Client.ts">retrieve</a>(id) -> Extend.Classifier</code></summary>
|
|
2897
|
+
<details><summary><code>client.classifiers.<a href="/src/api/resources/classifiers/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.Classifier</code></summary>
|
|
2519
2898
|
<dl>
|
|
2520
2899
|
<dd>
|
|
2521
2900
|
|
|
@@ -2570,6 +2949,14 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2570
2949
|
<dl>
|
|
2571
2950
|
<dd>
|
|
2572
2951
|
|
|
2952
|
+
**request:** `Extend.ClassifiersRetrieveRequest`
|
|
2953
|
+
|
|
2954
|
+
</dd>
|
|
2955
|
+
</dl>
|
|
2956
|
+
|
|
2957
|
+
<dl>
|
|
2958
|
+
<dd>
|
|
2959
|
+
|
|
2573
2960
|
**requestOptions:** `ClassifiersClient.RequestOptions`
|
|
2574
2961
|
|
|
2575
2962
|
</dd>
|
|
@@ -2819,7 +3206,7 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2819
3206
|
</dl>
|
|
2820
3207
|
</details>
|
|
2821
3208
|
|
|
2822
|
-
<details><summary><code>client.classifierVersions.<a href="/src/api/resources/classifierVersions/client/Client.ts">retrieve</a>(classifierId, versionId) -> Extend.ClassifierVersion</code></summary>
|
|
3209
|
+
<details><summary><code>client.classifierVersions.<a href="/src/api/resources/classifierVersions/client/Client.ts">retrieve</a>(classifierId, versionId, { ...params }) -> Extend.ClassifierVersion</code></summary>
|
|
2823
3210
|
<dl>
|
|
2824
3211
|
<dd>
|
|
2825
3212
|
|
|
@@ -2846,7 +3233,7 @@ Retrieve a specific version of a classifier in Extend
|
|
|
2846
3233
|
<dd>
|
|
2847
3234
|
|
|
2848
3235
|
```typescript
|
|
2849
|
-
await client.classifierVersions.retrieve("classifier_id_here", "
|
|
3236
|
+
await client.classifierVersions.retrieve("classifier_id_here", "draft");
|
|
2850
3237
|
|
|
2851
3238
|
```
|
|
2852
3239
|
</dd>
|
|
@@ -2876,9 +3263,20 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2876
3263
|
|
|
2877
3264
|
**versionId:** `string`
|
|
2878
3265
|
|
|
2879
|
-
The
|
|
3266
|
+
The version to retrieve. Accepts any of the following:
|
|
2880
3267
|
|
|
2881
|
-
|
|
3268
|
+
- `"draft"` — returns the current draft version
|
|
3269
|
+
- `"latest"` — returns the latest published version (falls back to draft if none published)
|
|
3270
|
+
- A version number (e.g. `"0.1"`, `"1.0"`) — returns that specific published version
|
|
3271
|
+
- A version ID (e.g. `"clsv_QYk6jgHA_8CsO8rVWhyNC"`) — returns that specific version by ID
|
|
3272
|
+
|
|
3273
|
+
</dd>
|
|
3274
|
+
</dl>
|
|
3275
|
+
|
|
3276
|
+
<dl>
|
|
3277
|
+
<dd>
|
|
3278
|
+
|
|
3279
|
+
**request:** `Extend.ClassifierVersionsRetrieveRequest`
|
|
2882
3280
|
|
|
2883
3281
|
</dd>
|
|
2884
3282
|
</dl>
|
|
@@ -3038,7 +3436,7 @@ await client.splitRuns.create({
|
|
|
3038
3436
|
</dl>
|
|
3039
3437
|
</details>
|
|
3040
3438
|
|
|
3041
|
-
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">retrieve</a>(id) -> Extend.SplitRun</code></summary>
|
|
3439
|
+
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.SplitRun</code></summary>
|
|
3042
3440
|
<dl>
|
|
3043
3441
|
<dd>
|
|
3044
3442
|
|
|
@@ -3095,6 +3493,14 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3095
3493
|
<dl>
|
|
3096
3494
|
<dd>
|
|
3097
3495
|
|
|
3496
|
+
**request:** `Extend.SplitRunsRetrieveRequest`
|
|
3497
|
+
|
|
3498
|
+
</dd>
|
|
3499
|
+
</dl>
|
|
3500
|
+
|
|
3501
|
+
<dl>
|
|
3502
|
+
<dd>
|
|
3503
|
+
|
|
3098
3504
|
**requestOptions:** `SplitRunsClient.RequestOptions`
|
|
3099
3505
|
|
|
3100
3506
|
</dd>
|
|
@@ -3107,7 +3513,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3107
3513
|
</dl>
|
|
3108
3514
|
</details>
|
|
3109
3515
|
|
|
3110
|
-
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">delete</a>(id) -> Extend.SplitRunsDeleteResponse</code></summary>
|
|
3516
|
+
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.SplitRunsDeleteResponse</code></summary>
|
|
3111
3517
|
<dl>
|
|
3112
3518
|
<dd>
|
|
3113
3519
|
|
|
@@ -3160,6 +3566,14 @@ await client.splitRuns.delete("id");
|
|
|
3160
3566
|
<dl>
|
|
3161
3567
|
<dd>
|
|
3162
3568
|
|
|
3569
|
+
**request:** `Extend.SplitRunsDeleteRequest`
|
|
3570
|
+
|
|
3571
|
+
</dd>
|
|
3572
|
+
</dl>
|
|
3573
|
+
|
|
3574
|
+
<dl>
|
|
3575
|
+
<dd>
|
|
3576
|
+
|
|
3163
3577
|
**requestOptions:** `SplitRunsClient.RequestOptions`
|
|
3164
3578
|
|
|
3165
3579
|
</dd>
|
|
@@ -3172,7 +3586,7 @@ await client.splitRuns.delete("id");
|
|
|
3172
3586
|
</dl>
|
|
3173
3587
|
</details>
|
|
3174
3588
|
|
|
3175
|
-
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">cancel</a>(id) -> Extend.SplitRun</code></summary>
|
|
3589
|
+
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.SplitRun</code></summary>
|
|
3176
3590
|
<dl>
|
|
3177
3591
|
<dd>
|
|
3178
3592
|
|
|
@@ -3229,6 +3643,115 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3229
3643
|
<dl>
|
|
3230
3644
|
<dd>
|
|
3231
3645
|
|
|
3646
|
+
**request:** `Extend.SplitRunsCancelRequest`
|
|
3647
|
+
|
|
3648
|
+
</dd>
|
|
3649
|
+
</dl>
|
|
3650
|
+
|
|
3651
|
+
<dl>
|
|
3652
|
+
<dd>
|
|
3653
|
+
|
|
3654
|
+
**requestOptions:** `SplitRunsClient.RequestOptions`
|
|
3655
|
+
|
|
3656
|
+
</dd>
|
|
3657
|
+
</dl>
|
|
3658
|
+
</dd>
|
|
3659
|
+
</dl>
|
|
3660
|
+
|
|
3661
|
+
|
|
3662
|
+
</dd>
|
|
3663
|
+
</dl>
|
|
3664
|
+
</details>
|
|
3665
|
+
|
|
3666
|
+
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">createBatch</a>({ ...params }) -> Extend.BatchRun</code></summary>
|
|
3667
|
+
<dl>
|
|
3668
|
+
<dd>
|
|
3669
|
+
|
|
3670
|
+
#### 📝 Description
|
|
3671
|
+
|
|
3672
|
+
<dl>
|
|
3673
|
+
<dd>
|
|
3674
|
+
|
|
3675
|
+
<dl>
|
|
3676
|
+
<dd>
|
|
3677
|
+
|
|
3678
|
+
Submit up to **1,000 files** for splitting in a single request. Each file is processed as an independent split run using the same splitter and configuration.
|
|
3679
|
+
|
|
3680
|
+
Unlike the single [Split File (Async)](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/split/create-split-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.
|
|
3681
|
+
|
|
3682
|
+
**Monitoring results:**
|
|
3683
|
+
- **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 /split_runs?batchId={id}`.
|
|
3684
|
+
- **Polling:** Call `GET /batch_runs/{id}` to check the overall batch status, and use `GET /split_runs` filtered by `batchId` to retrieve individual run results.
|
|
3685
|
+
|
|
3686
|
+
**Notes:**
|
|
3687
|
+
- A processor reference (`splitter.id`) is required — inline `config` is not supported for batch requests.
|
|
3688
|
+
- `inputs` must contain between 1 and 1,000 items.
|
|
3689
|
+
- All inputs in a batch use the same splitter version and override config.
|
|
3690
|
+
- Raw text input (`FileFromText`) is not supported for split runs. Use a URL or file ID.
|
|
3691
|
+
</dd>
|
|
3692
|
+
</dl>
|
|
3693
|
+
</dd>
|
|
3694
|
+
</dl>
|
|
3695
|
+
|
|
3696
|
+
#### 🔌 Usage
|
|
3697
|
+
|
|
3698
|
+
<dl>
|
|
3699
|
+
<dd>
|
|
3700
|
+
|
|
3701
|
+
<dl>
|
|
3702
|
+
<dd>
|
|
3703
|
+
|
|
3704
|
+
```typescript
|
|
3705
|
+
await client.splitRuns.createBatch({
|
|
3706
|
+
splitter: {
|
|
3707
|
+
id: "spl_xK9mLPqRtN3vS8wF5hB2cQ"
|
|
3708
|
+
},
|
|
3709
|
+
inputs: [{
|
|
3710
|
+
file: {
|
|
3711
|
+
url: "https://example.com/multi-doc1.pdf"
|
|
3712
|
+
},
|
|
3713
|
+
metadata: {
|
|
3714
|
+
"customerId": "cust_abc123"
|
|
3715
|
+
}
|
|
3716
|
+
}, {
|
|
3717
|
+
file: {
|
|
3718
|
+
url: "https://example.com/multi-doc2.pdf"
|
|
3719
|
+
},
|
|
3720
|
+
metadata: {
|
|
3721
|
+
"customerId": "cust_def456"
|
|
3722
|
+
}
|
|
3723
|
+
}, {
|
|
3724
|
+
file: {
|
|
3725
|
+
url: "https://example.com/multi-doc3.pdf"
|
|
3726
|
+
},
|
|
3727
|
+
metadata: {
|
|
3728
|
+
"customerId": "cust_ghi789"
|
|
3729
|
+
}
|
|
3730
|
+
}]
|
|
3731
|
+
});
|
|
3732
|
+
|
|
3733
|
+
```
|
|
3734
|
+
</dd>
|
|
3735
|
+
</dl>
|
|
3736
|
+
</dd>
|
|
3737
|
+
</dl>
|
|
3738
|
+
|
|
3739
|
+
#### ⚙️ Parameters
|
|
3740
|
+
|
|
3741
|
+
<dl>
|
|
3742
|
+
<dd>
|
|
3743
|
+
|
|
3744
|
+
<dl>
|
|
3745
|
+
<dd>
|
|
3746
|
+
|
|
3747
|
+
**request:** `Extend.SplitRunsCreateBatchRequest`
|
|
3748
|
+
|
|
3749
|
+
</dd>
|
|
3750
|
+
</dl>
|
|
3751
|
+
|
|
3752
|
+
<dl>
|
|
3753
|
+
<dd>
|
|
3754
|
+
|
|
3232
3755
|
**requestOptions:** `SplitRunsClient.RequestOptions`
|
|
3233
3756
|
|
|
3234
3757
|
</dd>
|
|
@@ -3391,7 +3914,7 @@ await client.splitters.create({
|
|
|
3391
3914
|
</dl>
|
|
3392
3915
|
</details>
|
|
3393
3916
|
|
|
3394
|
-
<details><summary><code>client.splitters.<a href="/src/api/resources/splitters/client/Client.ts">retrieve</a>(id) -> Extend.Splitter</code></summary>
|
|
3917
|
+
<details><summary><code>client.splitters.<a href="/src/api/resources/splitters/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.Splitter</code></summary>
|
|
3395
3918
|
<dl>
|
|
3396
3919
|
<dd>
|
|
3397
3920
|
|
|
@@ -3446,6 +3969,14 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3446
3969
|
<dl>
|
|
3447
3970
|
<dd>
|
|
3448
3971
|
|
|
3972
|
+
**request:** `Extend.SplittersRetrieveRequest`
|
|
3973
|
+
|
|
3974
|
+
</dd>
|
|
3975
|
+
</dl>
|
|
3976
|
+
|
|
3977
|
+
<dl>
|
|
3978
|
+
<dd>
|
|
3979
|
+
|
|
3449
3980
|
**requestOptions:** `SplittersClient.RequestOptions`
|
|
3450
3981
|
|
|
3451
3982
|
</dd>
|
|
@@ -3507,15 +4038,463 @@ await client.splitters.update("splitter_id_here", {
|
|
|
3507
4038
|
|
|
3508
4039
|
The ID of the splitter to update.
|
|
3509
4040
|
|
|
3510
|
-
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
3511
|
-
|
|
4041
|
+
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
4042
|
+
|
|
4043
|
+
</dd>
|
|
4044
|
+
</dl>
|
|
4045
|
+
|
|
4046
|
+
<dl>
|
|
4047
|
+
<dd>
|
|
4048
|
+
|
|
4049
|
+
**request:** `Extend.SplittersUpdateRequest`
|
|
4050
|
+
|
|
4051
|
+
</dd>
|
|
4052
|
+
</dl>
|
|
4053
|
+
|
|
4054
|
+
<dl>
|
|
4055
|
+
<dd>
|
|
4056
|
+
|
|
4057
|
+
**requestOptions:** `SplittersClient.RequestOptions`
|
|
4058
|
+
|
|
4059
|
+
</dd>
|
|
4060
|
+
</dl>
|
|
4061
|
+
</dd>
|
|
4062
|
+
</dl>
|
|
4063
|
+
|
|
4064
|
+
|
|
4065
|
+
</dd>
|
|
4066
|
+
</dl>
|
|
4067
|
+
</details>
|
|
4068
|
+
|
|
4069
|
+
## SplitterVersions
|
|
4070
|
+
<details><summary><code>client.splitterVersions.<a href="/src/api/resources/splitterVersions/client/Client.ts">list</a>(splitterId, { ...params }) -> Extend.SplitterVersionsListResponse</code></summary>
|
|
4071
|
+
<dl>
|
|
4072
|
+
<dd>
|
|
4073
|
+
|
|
4074
|
+
#### 📝 Description
|
|
4075
|
+
|
|
4076
|
+
<dl>
|
|
4077
|
+
<dd>
|
|
4078
|
+
|
|
4079
|
+
<dl>
|
|
4080
|
+
<dd>
|
|
4081
|
+
|
|
4082
|
+
This endpoint allows you to fetch all versions of a given splitter, including the current `draft` version.
|
|
4083
|
+
|
|
4084
|
+
Versions are returned in descending order of creation (newest first) with the `draft` version first. The `draft` version is the latest unpublished version of the splitter, which can be published to create a new version. It might not have any changes from the last published version.
|
|
4085
|
+
</dd>
|
|
4086
|
+
</dl>
|
|
4087
|
+
</dd>
|
|
4088
|
+
</dl>
|
|
4089
|
+
|
|
4090
|
+
#### 🔌 Usage
|
|
4091
|
+
|
|
4092
|
+
<dl>
|
|
4093
|
+
<dd>
|
|
4094
|
+
|
|
4095
|
+
<dl>
|
|
4096
|
+
<dd>
|
|
4097
|
+
|
|
4098
|
+
```typescript
|
|
4099
|
+
await client.splitterVersions.list("splitter_id_here", {
|
|
4100
|
+
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
4101
|
+
});
|
|
4102
|
+
|
|
4103
|
+
```
|
|
4104
|
+
</dd>
|
|
4105
|
+
</dl>
|
|
4106
|
+
</dd>
|
|
4107
|
+
</dl>
|
|
4108
|
+
|
|
4109
|
+
#### ⚙️ Parameters
|
|
4110
|
+
|
|
4111
|
+
<dl>
|
|
4112
|
+
<dd>
|
|
4113
|
+
|
|
4114
|
+
<dl>
|
|
4115
|
+
<dd>
|
|
4116
|
+
|
|
4117
|
+
**splitterId:** `string`
|
|
4118
|
+
|
|
4119
|
+
The ID of the splitter.
|
|
4120
|
+
|
|
4121
|
+
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
4122
|
+
|
|
4123
|
+
</dd>
|
|
4124
|
+
</dl>
|
|
4125
|
+
|
|
4126
|
+
<dl>
|
|
4127
|
+
<dd>
|
|
4128
|
+
|
|
4129
|
+
**request:** `Extend.SplitterVersionsListRequest`
|
|
4130
|
+
|
|
4131
|
+
</dd>
|
|
4132
|
+
</dl>
|
|
4133
|
+
|
|
4134
|
+
<dl>
|
|
4135
|
+
<dd>
|
|
4136
|
+
|
|
4137
|
+
**requestOptions:** `SplitterVersionsClient.RequestOptions`
|
|
4138
|
+
|
|
4139
|
+
</dd>
|
|
4140
|
+
</dl>
|
|
4141
|
+
</dd>
|
|
4142
|
+
</dl>
|
|
4143
|
+
|
|
4144
|
+
|
|
4145
|
+
</dd>
|
|
4146
|
+
</dl>
|
|
4147
|
+
</details>
|
|
4148
|
+
|
|
4149
|
+
<details><summary><code>client.splitterVersions.<a href="/src/api/resources/splitterVersions/client/Client.ts">create</a>(splitterId, { ...params }) -> Extend.SplitterVersion</code></summary>
|
|
4150
|
+
<dl>
|
|
4151
|
+
<dd>
|
|
4152
|
+
|
|
4153
|
+
#### 📝 Description
|
|
4154
|
+
|
|
4155
|
+
<dl>
|
|
4156
|
+
<dd>
|
|
4157
|
+
|
|
4158
|
+
<dl>
|
|
4159
|
+
<dd>
|
|
4160
|
+
|
|
4161
|
+
This endpoint allows you to publish a new version of an existing splitter. Publishing a new version creates a snapshot of the splitter's current configuration and makes it available for use in workflows.
|
|
4162
|
+
|
|
4163
|
+
Publishing a new version does not automatically update existing workflows using this splitter. You may need to manually update workflows to use the new version if desired.
|
|
4164
|
+
</dd>
|
|
4165
|
+
</dl>
|
|
4166
|
+
</dd>
|
|
4167
|
+
</dl>
|
|
4168
|
+
|
|
4169
|
+
#### 🔌 Usage
|
|
4170
|
+
|
|
4171
|
+
<dl>
|
|
4172
|
+
<dd>
|
|
4173
|
+
|
|
4174
|
+
<dl>
|
|
4175
|
+
<dd>
|
|
4176
|
+
|
|
4177
|
+
```typescript
|
|
4178
|
+
await client.splitterVersions.create("splitter_id_here", {
|
|
4179
|
+
releaseType: "minor",
|
|
4180
|
+
description: "Improved split boundary detection"
|
|
4181
|
+
});
|
|
4182
|
+
|
|
4183
|
+
```
|
|
4184
|
+
</dd>
|
|
4185
|
+
</dl>
|
|
4186
|
+
</dd>
|
|
4187
|
+
</dl>
|
|
4188
|
+
|
|
4189
|
+
#### ⚙️ Parameters
|
|
4190
|
+
|
|
4191
|
+
<dl>
|
|
4192
|
+
<dd>
|
|
4193
|
+
|
|
4194
|
+
<dl>
|
|
4195
|
+
<dd>
|
|
4196
|
+
|
|
4197
|
+
**splitterId:** `string`
|
|
4198
|
+
|
|
4199
|
+
The ID of the splitter.
|
|
4200
|
+
|
|
4201
|
+
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
4202
|
+
|
|
4203
|
+
</dd>
|
|
4204
|
+
</dl>
|
|
4205
|
+
|
|
4206
|
+
<dl>
|
|
4207
|
+
<dd>
|
|
4208
|
+
|
|
4209
|
+
**request:** `Extend.SplitterVersionsCreateRequest`
|
|
4210
|
+
|
|
4211
|
+
</dd>
|
|
4212
|
+
</dl>
|
|
4213
|
+
|
|
4214
|
+
<dl>
|
|
4215
|
+
<dd>
|
|
4216
|
+
|
|
4217
|
+
**requestOptions:** `SplitterVersionsClient.RequestOptions`
|
|
4218
|
+
|
|
4219
|
+
</dd>
|
|
4220
|
+
</dl>
|
|
4221
|
+
</dd>
|
|
4222
|
+
</dl>
|
|
4223
|
+
|
|
4224
|
+
|
|
4225
|
+
</dd>
|
|
4226
|
+
</dl>
|
|
4227
|
+
</details>
|
|
4228
|
+
|
|
4229
|
+
<details><summary><code>client.splitterVersions.<a href="/src/api/resources/splitterVersions/client/Client.ts">retrieve</a>(splitterId, versionId, { ...params }) -> Extend.SplitterVersion</code></summary>
|
|
4230
|
+
<dl>
|
|
4231
|
+
<dd>
|
|
4232
|
+
|
|
4233
|
+
#### 📝 Description
|
|
4234
|
+
|
|
4235
|
+
<dl>
|
|
4236
|
+
<dd>
|
|
4237
|
+
|
|
4238
|
+
<dl>
|
|
4239
|
+
<dd>
|
|
4240
|
+
|
|
4241
|
+
Retrieve a specific version of a splitter in Extend
|
|
4242
|
+
</dd>
|
|
4243
|
+
</dl>
|
|
4244
|
+
</dd>
|
|
4245
|
+
</dl>
|
|
4246
|
+
|
|
4247
|
+
#### 🔌 Usage
|
|
4248
|
+
|
|
4249
|
+
<dl>
|
|
4250
|
+
<dd>
|
|
4251
|
+
|
|
4252
|
+
<dl>
|
|
4253
|
+
<dd>
|
|
4254
|
+
|
|
4255
|
+
```typescript
|
|
4256
|
+
await client.splitterVersions.retrieve("splitter_id_here", "draft");
|
|
4257
|
+
|
|
4258
|
+
```
|
|
4259
|
+
</dd>
|
|
4260
|
+
</dl>
|
|
4261
|
+
</dd>
|
|
4262
|
+
</dl>
|
|
4263
|
+
|
|
4264
|
+
#### ⚙️ Parameters
|
|
4265
|
+
|
|
4266
|
+
<dl>
|
|
4267
|
+
<dd>
|
|
4268
|
+
|
|
4269
|
+
<dl>
|
|
4270
|
+
<dd>
|
|
4271
|
+
|
|
4272
|
+
**splitterId:** `string`
|
|
4273
|
+
|
|
4274
|
+
The ID of the splitter.
|
|
4275
|
+
|
|
4276
|
+
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
4277
|
+
|
|
4278
|
+
</dd>
|
|
4279
|
+
</dl>
|
|
4280
|
+
|
|
4281
|
+
<dl>
|
|
4282
|
+
<dd>
|
|
4283
|
+
|
|
4284
|
+
**versionId:** `string`
|
|
4285
|
+
|
|
4286
|
+
The version to retrieve. Accepts any of the following:
|
|
4287
|
+
|
|
4288
|
+
- `"draft"` — returns the current draft version
|
|
4289
|
+
- `"latest"` — returns the latest published version (falls back to draft if none published)
|
|
4290
|
+
- A version number (e.g. `"0.1"`, `"1.0"`) — returns that specific published version
|
|
4291
|
+
- A version ID (e.g. `"splv_QYk6jgHA_8CsO8rVWhyNC"`) — returns that specific version by ID
|
|
4292
|
+
|
|
4293
|
+
</dd>
|
|
4294
|
+
</dl>
|
|
4295
|
+
|
|
4296
|
+
<dl>
|
|
4297
|
+
<dd>
|
|
4298
|
+
|
|
4299
|
+
**request:** `Extend.SplitterVersionsRetrieveRequest`
|
|
4300
|
+
|
|
4301
|
+
</dd>
|
|
4302
|
+
</dl>
|
|
4303
|
+
|
|
4304
|
+
<dl>
|
|
4305
|
+
<dd>
|
|
4306
|
+
|
|
4307
|
+
**requestOptions:** `SplitterVersionsClient.RequestOptions`
|
|
4308
|
+
|
|
4309
|
+
</dd>
|
|
4310
|
+
</dl>
|
|
4311
|
+
</dd>
|
|
4312
|
+
</dl>
|
|
4313
|
+
|
|
4314
|
+
|
|
4315
|
+
</dd>
|
|
4316
|
+
</dl>
|
|
4317
|
+
</details>
|
|
4318
|
+
|
|
4319
|
+
## Workflows
|
|
4320
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">list</a>({ ...params }) -> Extend.WorkflowsListResponse</code></summary>
|
|
4321
|
+
<dl>
|
|
4322
|
+
<dd>
|
|
4323
|
+
|
|
4324
|
+
#### 📝 Description
|
|
4325
|
+
|
|
4326
|
+
<dl>
|
|
4327
|
+
<dd>
|
|
4328
|
+
|
|
4329
|
+
<dl>
|
|
4330
|
+
<dd>
|
|
4331
|
+
|
|
4332
|
+
List all workflows. Returns a paginated list of workflow summaries.
|
|
4333
|
+
</dd>
|
|
4334
|
+
</dl>
|
|
4335
|
+
</dd>
|
|
4336
|
+
</dl>
|
|
4337
|
+
|
|
4338
|
+
#### 🔌 Usage
|
|
4339
|
+
|
|
4340
|
+
<dl>
|
|
4341
|
+
<dd>
|
|
4342
|
+
|
|
4343
|
+
<dl>
|
|
4344
|
+
<dd>
|
|
4345
|
+
|
|
4346
|
+
```typescript
|
|
4347
|
+
await client.workflows.list({
|
|
4348
|
+
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
4349
|
+
});
|
|
4350
|
+
|
|
4351
|
+
```
|
|
4352
|
+
</dd>
|
|
4353
|
+
</dl>
|
|
4354
|
+
</dd>
|
|
4355
|
+
</dl>
|
|
4356
|
+
|
|
4357
|
+
#### ⚙️ Parameters
|
|
4358
|
+
|
|
4359
|
+
<dl>
|
|
4360
|
+
<dd>
|
|
4361
|
+
|
|
4362
|
+
<dl>
|
|
4363
|
+
<dd>
|
|
4364
|
+
|
|
4365
|
+
**request:** `Extend.WorkflowsListRequest`
|
|
4366
|
+
|
|
4367
|
+
</dd>
|
|
4368
|
+
</dl>
|
|
4369
|
+
|
|
4370
|
+
<dl>
|
|
4371
|
+
<dd>
|
|
4372
|
+
|
|
4373
|
+
**requestOptions:** `WorkflowsClient.RequestOptions`
|
|
4374
|
+
|
|
4375
|
+
</dd>
|
|
4376
|
+
</dl>
|
|
4377
|
+
</dd>
|
|
4378
|
+
</dl>
|
|
4379
|
+
|
|
4380
|
+
|
|
4381
|
+
</dd>
|
|
4382
|
+
</dl>
|
|
4383
|
+
</details>
|
|
4384
|
+
|
|
4385
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">create</a>({ ...params }) -> Extend.Workflow</code></summary>
|
|
4386
|
+
<dl>
|
|
4387
|
+
<dd>
|
|
4388
|
+
|
|
4389
|
+
#### 📝 Description
|
|
4390
|
+
|
|
4391
|
+
<dl>
|
|
4392
|
+
<dd>
|
|
4393
|
+
|
|
4394
|
+
<dl>
|
|
4395
|
+
<dd>
|
|
4396
|
+
|
|
4397
|
+
Create a new workflow. Optionally provide `steps` to define the workflow's step graph.
|
|
4398
|
+
|
|
4399
|
+
When `steps` is omitted, the workflow is created with default steps (`TRIGGER` → `PARSE`). When `steps` is provided, the step graph is validated and the draft version is populated with the given steps.
|
|
4400
|
+
|
|
4401
|
+
**Note:** The default steps may change in the future. If your integration depends on a specific step graph, provide `steps` explicitly.
|
|
4402
|
+
</dd>
|
|
4403
|
+
</dl>
|
|
4404
|
+
</dd>
|
|
4405
|
+
</dl>
|
|
4406
|
+
|
|
4407
|
+
#### 🔌 Usage
|
|
4408
|
+
|
|
4409
|
+
<dl>
|
|
4410
|
+
<dd>
|
|
4411
|
+
|
|
4412
|
+
<dl>
|
|
4413
|
+
<dd>
|
|
4414
|
+
|
|
4415
|
+
```typescript
|
|
4416
|
+
await client.workflows.create({
|
|
4417
|
+
name: "Invoice Processing"
|
|
4418
|
+
});
|
|
4419
|
+
|
|
4420
|
+
```
|
|
4421
|
+
</dd>
|
|
4422
|
+
</dl>
|
|
4423
|
+
</dd>
|
|
4424
|
+
</dl>
|
|
4425
|
+
|
|
4426
|
+
#### ⚙️ Parameters
|
|
4427
|
+
|
|
4428
|
+
<dl>
|
|
4429
|
+
<dd>
|
|
4430
|
+
|
|
4431
|
+
<dl>
|
|
4432
|
+
<dd>
|
|
4433
|
+
|
|
4434
|
+
**request:** `Extend.WorkflowsCreateRequest`
|
|
4435
|
+
|
|
4436
|
+
</dd>
|
|
4437
|
+
</dl>
|
|
4438
|
+
|
|
4439
|
+
<dl>
|
|
4440
|
+
<dd>
|
|
4441
|
+
|
|
4442
|
+
**requestOptions:** `WorkflowsClient.RequestOptions`
|
|
4443
|
+
|
|
4444
|
+
</dd>
|
|
4445
|
+
</dl>
|
|
4446
|
+
</dd>
|
|
4447
|
+
</dl>
|
|
4448
|
+
|
|
4449
|
+
|
|
4450
|
+
</dd>
|
|
4451
|
+
</dl>
|
|
4452
|
+
</details>
|
|
4453
|
+
|
|
4454
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">retrieve</a>(id) -> Extend.Workflow</code></summary>
|
|
4455
|
+
<dl>
|
|
4456
|
+
<dd>
|
|
4457
|
+
|
|
4458
|
+
#### 📝 Description
|
|
4459
|
+
|
|
4460
|
+
<dl>
|
|
4461
|
+
<dd>
|
|
4462
|
+
|
|
4463
|
+
<dl>
|
|
4464
|
+
<dd>
|
|
4465
|
+
|
|
4466
|
+
Get details of a workflow, including its draft version and steps.
|
|
4467
|
+
</dd>
|
|
4468
|
+
</dl>
|
|
4469
|
+
</dd>
|
|
4470
|
+
</dl>
|
|
4471
|
+
|
|
4472
|
+
#### 🔌 Usage
|
|
4473
|
+
|
|
4474
|
+
<dl>
|
|
4475
|
+
<dd>
|
|
4476
|
+
|
|
4477
|
+
<dl>
|
|
4478
|
+
<dd>
|
|
4479
|
+
|
|
4480
|
+
```typescript
|
|
4481
|
+
await client.workflows.retrieve("workflow_abc123");
|
|
4482
|
+
|
|
4483
|
+
```
|
|
4484
|
+
</dd>
|
|
4485
|
+
</dl>
|
|
3512
4486
|
</dd>
|
|
3513
4487
|
</dl>
|
|
3514
4488
|
|
|
4489
|
+
#### ⚙️ Parameters
|
|
4490
|
+
|
|
3515
4491
|
<dl>
|
|
3516
4492
|
<dd>
|
|
3517
4493
|
|
|
3518
|
-
|
|
4494
|
+
<dl>
|
|
4495
|
+
<dd>
|
|
4496
|
+
|
|
4497
|
+
**id:** `string` — The ID of the workflow.
|
|
3519
4498
|
|
|
3520
4499
|
</dd>
|
|
3521
4500
|
</dl>
|
|
@@ -3523,7 +4502,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3523
4502
|
<dl>
|
|
3524
4503
|
<dd>
|
|
3525
4504
|
|
|
3526
|
-
**requestOptions:** `
|
|
4505
|
+
**requestOptions:** `WorkflowsClient.RequestOptions`
|
|
3527
4506
|
|
|
3528
4507
|
</dd>
|
|
3529
4508
|
</dl>
|
|
@@ -3535,8 +4514,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3535
4514
|
</dl>
|
|
3536
4515
|
</details>
|
|
3537
4516
|
|
|
3538
|
-
|
|
3539
|
-
<details><summary><code>client.splitterVersions.<a href="/src/api/resources/splitterVersions/client/Client.ts">list</a>(splitterId, { ...params }) -> Extend.SplitterVersionsListResponse</code></summary>
|
|
4517
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">update</a>(id, { ...params }) -> Extend.Workflow</code></summary>
|
|
3540
4518
|
<dl>
|
|
3541
4519
|
<dd>
|
|
3542
4520
|
|
|
@@ -3548,9 +4526,9 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3548
4526
|
<dl>
|
|
3549
4527
|
<dd>
|
|
3550
4528
|
|
|
3551
|
-
|
|
4529
|
+
Update a workflow's draft. You can update the name, the steps, or both.
|
|
3552
4530
|
|
|
3553
|
-
|
|
4531
|
+
When `steps` is provided, the draft version's steps are replaced with the new set. Steps with matching names from the previous draft preserve their internal identity.
|
|
3554
4532
|
</dd>
|
|
3555
4533
|
</dl>
|
|
3556
4534
|
</dd>
|
|
@@ -3565,8 +4543,8 @@ Versions are returned in descending order of creation (newest first) with the `d
|
|
|
3565
4543
|
<dd>
|
|
3566
4544
|
|
|
3567
4545
|
```typescript
|
|
3568
|
-
await client.
|
|
3569
|
-
|
|
4546
|
+
await client.workflows.update("workflow_abc123", {
|
|
4547
|
+
name: "Updated Invoice Processing"
|
|
3570
4548
|
});
|
|
3571
4549
|
|
|
3572
4550
|
```
|
|
@@ -3583,11 +4561,7 @@ await client.splitterVersions.list("splitter_id_here", {
|
|
|
3583
4561
|
<dl>
|
|
3584
4562
|
<dd>
|
|
3585
4563
|
|
|
3586
|
-
**
|
|
3587
|
-
|
|
3588
|
-
The ID of the splitter.
|
|
3589
|
-
|
|
3590
|
-
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
4564
|
+
**id:** `string` — The ID of the workflow to update.
|
|
3591
4565
|
|
|
3592
4566
|
</dd>
|
|
3593
4567
|
</dl>
|
|
@@ -3595,7 +4569,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3595
4569
|
<dl>
|
|
3596
4570
|
<dd>
|
|
3597
4571
|
|
|
3598
|
-
**request:** `Extend.
|
|
4572
|
+
**request:** `Extend.WorkflowsUpdateRequest`
|
|
3599
4573
|
|
|
3600
4574
|
</dd>
|
|
3601
4575
|
</dl>
|
|
@@ -3603,7 +4577,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3603
4577
|
<dl>
|
|
3604
4578
|
<dd>
|
|
3605
4579
|
|
|
3606
|
-
**requestOptions:** `
|
|
4580
|
+
**requestOptions:** `WorkflowsClient.RequestOptions`
|
|
3607
4581
|
|
|
3608
4582
|
</dd>
|
|
3609
4583
|
</dl>
|
|
@@ -3615,7 +4589,8 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3615
4589
|
</dl>
|
|
3616
4590
|
</details>
|
|
3617
4591
|
|
|
3618
|
-
|
|
4592
|
+
## WorkflowVersions
|
|
4593
|
+
<details><summary><code>client.workflowVersions.<a href="/src/api/resources/workflowVersions/client/Client.ts">list</a>(id, { ...params }) -> Extend.WorkflowVersionsListResponse</code></summary>
|
|
3619
4594
|
<dl>
|
|
3620
4595
|
<dd>
|
|
3621
4596
|
|
|
@@ -3627,9 +4602,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3627
4602
|
<dl>
|
|
3628
4603
|
<dd>
|
|
3629
4604
|
|
|
3630
|
-
|
|
3631
|
-
|
|
3632
|
-
Publishing a new version does not automatically update existing workflows using this splitter. You may need to manually update workflows to use the new version if desired.
|
|
4605
|
+
List all versions of a workflow, including the draft version. Returns a paginated list of version summaries.
|
|
3633
4606
|
</dd>
|
|
3634
4607
|
</dl>
|
|
3635
4608
|
</dd>
|
|
@@ -3644,9 +4617,8 @@ Publishing a new version does not automatically update existing workflows using
|
|
|
3644
4617
|
<dd>
|
|
3645
4618
|
|
|
3646
4619
|
```typescript
|
|
3647
|
-
await client.
|
|
3648
|
-
|
|
3649
|
-
description: "Improved split boundary detection"
|
|
4620
|
+
await client.workflowVersions.list("workflow_abc123", {
|
|
4621
|
+
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
3650
4622
|
});
|
|
3651
4623
|
|
|
3652
4624
|
```
|
|
@@ -3663,11 +4635,7 @@ await client.splitterVersions.create("splitter_id_here", {
|
|
|
3663
4635
|
<dl>
|
|
3664
4636
|
<dd>
|
|
3665
4637
|
|
|
3666
|
-
**
|
|
3667
|
-
|
|
3668
|
-
The ID of the splitter.
|
|
3669
|
-
|
|
3670
|
-
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
4638
|
+
**id:** `string` — The ID of the workflow.
|
|
3671
4639
|
|
|
3672
4640
|
</dd>
|
|
3673
4641
|
</dl>
|
|
@@ -3675,7 +4643,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3675
4643
|
<dl>
|
|
3676
4644
|
<dd>
|
|
3677
4645
|
|
|
3678
|
-
**request:** `Extend.
|
|
4646
|
+
**request:** `Extend.WorkflowVersionsListRequest`
|
|
3679
4647
|
|
|
3680
4648
|
</dd>
|
|
3681
4649
|
</dl>
|
|
@@ -3683,7 +4651,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3683
4651
|
<dl>
|
|
3684
4652
|
<dd>
|
|
3685
4653
|
|
|
3686
|
-
**requestOptions:** `
|
|
4654
|
+
**requestOptions:** `WorkflowVersionsClient.RequestOptions`
|
|
3687
4655
|
|
|
3688
4656
|
</dd>
|
|
3689
4657
|
</dl>
|
|
@@ -3695,7 +4663,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3695
4663
|
</dl>
|
|
3696
4664
|
</details>
|
|
3697
4665
|
|
|
3698
|
-
<details><summary><code>client.
|
|
4666
|
+
<details><summary><code>client.workflowVersions.<a href="/src/api/resources/workflowVersions/client/Client.ts">create</a>(id, { ...params }) -> Extend.WorkflowVersion</code></summary>
|
|
3699
4667
|
<dl>
|
|
3700
4668
|
<dd>
|
|
3701
4669
|
|
|
@@ -3707,7 +4675,9 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3707
4675
|
<dl>
|
|
3708
4676
|
<dd>
|
|
3709
4677
|
|
|
3710
|
-
|
|
4678
|
+
Deploy a new version of a workflow. The deployed version becomes available for running workflow runs.
|
|
4679
|
+
|
|
4680
|
+
When `steps` is omitted, the current draft is deployed as-is. When `steps` is provided, the given steps are deployed directly without modifying the draft.
|
|
3711
4681
|
</dd>
|
|
3712
4682
|
</dl>
|
|
3713
4683
|
</dd>
|
|
@@ -3722,7 +4692,7 @@ Retrieve a specific version of a splitter in Extend
|
|
|
3722
4692
|
<dd>
|
|
3723
4693
|
|
|
3724
4694
|
```typescript
|
|
3725
|
-
await client.
|
|
4695
|
+
await client.workflowVersions.create("workflow_abc123");
|
|
3726
4696
|
|
|
3727
4697
|
```
|
|
3728
4698
|
</dd>
|
|
@@ -3738,11 +4708,7 @@ await client.splitterVersions.retrieve("splitter_id_here", "splitter_version_id_
|
|
|
3738
4708
|
<dl>
|
|
3739
4709
|
<dd>
|
|
3740
4710
|
|
|
3741
|
-
**
|
|
3742
|
-
|
|
3743
|
-
The ID of the splitter.
|
|
3744
|
-
|
|
3745
|
-
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
4711
|
+
**id:** `string` — The ID of the workflow to deploy.
|
|
3746
4712
|
|
|
3747
4713
|
</dd>
|
|
3748
4714
|
</dl>
|
|
@@ -3750,11 +4716,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3750
4716
|
<dl>
|
|
3751
4717
|
<dd>
|
|
3752
4718
|
|
|
3753
|
-
**
|
|
3754
|
-
|
|
3755
|
-
The ID of the specific splitter version.
|
|
3756
|
-
|
|
3757
|
-
Example: `"splv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
4719
|
+
**request:** `Extend.WorkflowVersionsCreateRequest`
|
|
3758
4720
|
|
|
3759
4721
|
</dd>
|
|
3760
4722
|
</dl>
|
|
@@ -3762,7 +4724,7 @@ Example: `"splv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
3762
4724
|
<dl>
|
|
3763
4725
|
<dd>
|
|
3764
4726
|
|
|
3765
|
-
**requestOptions:** `
|
|
4727
|
+
**requestOptions:** `WorkflowVersionsClient.RequestOptions`
|
|
3766
4728
|
|
|
3767
4729
|
</dd>
|
|
3768
4730
|
</dl>
|
|
@@ -3774,8 +4736,7 @@ Example: `"splv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
3774
4736
|
</dl>
|
|
3775
4737
|
</details>
|
|
3776
4738
|
|
|
3777
|
-
|
|
3778
|
-
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">create</a>({ ...params }) -> Extend.Workflow</code></summary>
|
|
4739
|
+
<details><summary><code>client.workflowVersions.<a href="/src/api/resources/workflowVersions/client/Client.ts">retrieve</a>(id, versionId) -> Extend.WorkflowVersion</code></summary>
|
|
3779
4740
|
<dl>
|
|
3780
4741
|
<dd>
|
|
3781
4742
|
|
|
@@ -3787,9 +4748,7 @@ Example: `"splv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
3787
4748
|
<dl>
|
|
3788
4749
|
<dd>
|
|
3789
4750
|
|
|
3790
|
-
|
|
3791
|
-
|
|
3792
|
-
This endpoint will create a new workflow in Extend, which can then be configured and deployed. Typically, workflows are created from our UI, however this endpoint can be used to create workflows programmatically. Configuration of the flow still needs to be done in the dashboard.
|
|
4751
|
+
Get a specific version of a workflow, including its step definitions.
|
|
3793
4752
|
</dd>
|
|
3794
4753
|
</dl>
|
|
3795
4754
|
</dd>
|
|
@@ -3804,9 +4763,7 @@ This endpoint will create a new workflow in Extend, which can then be configured
|
|
|
3804
4763
|
<dd>
|
|
3805
4764
|
|
|
3806
4765
|
```typescript
|
|
3807
|
-
await client.
|
|
3808
|
-
name: "Invoice Processing"
|
|
3809
|
-
});
|
|
4766
|
+
await client.workflowVersions.retrieve("workflow_abc123", "draft");
|
|
3810
4767
|
|
|
3811
4768
|
```
|
|
3812
4769
|
</dd>
|
|
@@ -3822,7 +4779,7 @@ await client.workflows.create({
|
|
|
3822
4779
|
<dl>
|
|
3823
4780
|
<dd>
|
|
3824
4781
|
|
|
3825
|
-
**
|
|
4782
|
+
**id:** `string` — The ID of the workflow.
|
|
3826
4783
|
|
|
3827
4784
|
</dd>
|
|
3828
4785
|
</dl>
|
|
@@ -3830,7 +4787,22 @@ await client.workflows.create({
|
|
|
3830
4787
|
<dl>
|
|
3831
4788
|
<dd>
|
|
3832
4789
|
|
|
3833
|
-
**
|
|
4790
|
+
**versionId:** `string`
|
|
4791
|
+
|
|
4792
|
+
The version to retrieve. Accepts any of the following:
|
|
4793
|
+
|
|
4794
|
+
- `"draft"` — returns the current draft version
|
|
4795
|
+
- `"latest"` — returns the latest published version (falls back to draft if none published)
|
|
4796
|
+
- A version number (e.g. `"1"`, `"2"`) — returns that specific published version
|
|
4797
|
+
- A version ID (e.g. `"workflow_version_abc123"`) — returns that specific version by ID
|
|
4798
|
+
|
|
4799
|
+
</dd>
|
|
4800
|
+
</dl>
|
|
4801
|
+
|
|
4802
|
+
<dl>
|
|
4803
|
+
<dd>
|
|
4804
|
+
|
|
4805
|
+
**requestOptions:** `WorkflowVersionsClient.RequestOptions`
|
|
3834
4806
|
|
|
3835
4807
|
</dd>
|
|
3836
4808
|
</dl>
|
|
@@ -3980,7 +4952,7 @@ await client.workflowRuns.create({
|
|
|
3980
4952
|
</dl>
|
|
3981
4953
|
</details>
|
|
3982
4954
|
|
|
3983
|
-
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">retrieve</a>(id) -> Extend.WorkflowRun</code></summary>
|
|
4955
|
+
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.WorkflowRun</code></summary>
|
|
3984
4956
|
<dl>
|
|
3985
4957
|
<dd>
|
|
3986
4958
|
|
|
@@ -4035,6 +5007,14 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4035
5007
|
<dl>
|
|
4036
5008
|
<dd>
|
|
4037
5009
|
|
|
5010
|
+
**request:** `Extend.WorkflowRunsRetrieveRequest`
|
|
5011
|
+
|
|
5012
|
+
</dd>
|
|
5013
|
+
</dl>
|
|
5014
|
+
|
|
5015
|
+
<dl>
|
|
5016
|
+
<dd>
|
|
5017
|
+
|
|
4038
5018
|
**requestOptions:** `WorkflowRunsClient.RequestOptions`
|
|
4039
5019
|
|
|
4040
5020
|
</dd>
|
|
@@ -4128,7 +5108,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4128
5108
|
</dl>
|
|
4129
5109
|
</details>
|
|
4130
5110
|
|
|
4131
|
-
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">delete</a>(id) -> Extend.WorkflowRunsDeleteResponse</code></summary>
|
|
5111
|
+
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.WorkflowRunsDeleteResponse</code></summary>
|
|
4132
5112
|
<dl>
|
|
4133
5113
|
<dd>
|
|
4134
5114
|
|
|
@@ -4185,6 +5165,14 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4185
5165
|
<dl>
|
|
4186
5166
|
<dd>
|
|
4187
5167
|
|
|
5168
|
+
**request:** `Extend.WorkflowRunsDeleteRequest`
|
|
5169
|
+
|
|
5170
|
+
</dd>
|
|
5171
|
+
</dl>
|
|
5172
|
+
|
|
5173
|
+
<dl>
|
|
5174
|
+
<dd>
|
|
5175
|
+
|
|
4188
5176
|
**requestOptions:** `WorkflowRunsClient.RequestOptions`
|
|
4189
5177
|
|
|
4190
5178
|
</dd>
|
|
@@ -4197,7 +5185,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4197
5185
|
</dl>
|
|
4198
5186
|
</details>
|
|
4199
5187
|
|
|
4200
|
-
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">cancel</a>(id) -> Extend.WorkflowRun</code></summary>
|
|
5188
|
+
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.WorkflowRun</code></summary>
|
|
4201
5189
|
<dl>
|
|
4202
5190
|
<dd>
|
|
4203
5191
|
|
|
@@ -4254,6 +5242,14 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4254
5242
|
<dl>
|
|
4255
5243
|
<dd>
|
|
4256
5244
|
|
|
5245
|
+
**request:** `Extend.WorkflowRunsCancelRequest`
|
|
5246
|
+
|
|
5247
|
+
</dd>
|
|
5248
|
+
</dl>
|
|
5249
|
+
|
|
5250
|
+
<dl>
|
|
5251
|
+
<dd>
|
|
5252
|
+
|
|
4257
5253
|
**requestOptions:** `WorkflowRunsClient.RequestOptions`
|
|
4258
5254
|
|
|
4259
5255
|
</dd>
|
|
@@ -4499,7 +5495,7 @@ await client.processorRun.create({
|
|
|
4499
5495
|
</dl>
|
|
4500
5496
|
</details>
|
|
4501
5497
|
|
|
4502
|
-
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">get</a>(id) -> Extend.ProcessorRunGetResponse</code></summary>
|
|
5498
|
+
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">get</a>(id, { ...params }) -> Extend.ProcessorRunGetResponse</code></summary>
|
|
4503
5499
|
<dl>
|
|
4504
5500
|
<dd>
|
|
4505
5501
|
|
|
@@ -4556,6 +5552,14 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4556
5552
|
<dl>
|
|
4557
5553
|
<dd>
|
|
4558
5554
|
|
|
5555
|
+
**request:** `Extend.ProcessorRunGetRequest`
|
|
5556
|
+
|
|
5557
|
+
</dd>
|
|
5558
|
+
</dl>
|
|
5559
|
+
|
|
5560
|
+
<dl>
|
|
5561
|
+
<dd>
|
|
5562
|
+
|
|
4559
5563
|
**requestOptions:** `ProcessorRunClient.RequestOptions`
|
|
4560
5564
|
|
|
4561
5565
|
</dd>
|
|
@@ -4568,7 +5572,7 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4568
5572
|
</dl>
|
|
4569
5573
|
</details>
|
|
4570
5574
|
|
|
4571
|
-
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">delete</a>(id) -> Extend.ProcessorRunDeleteResponse</code></summary>
|
|
5575
|
+
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">delete</a>(id, { ...params }) -> Extend.ProcessorRunDeleteResponse</code></summary>
|
|
4572
5576
|
<dl>
|
|
4573
5577
|
<dd>
|
|
4574
5578
|
|
|
@@ -4625,6 +5629,14 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4625
5629
|
<dl>
|
|
4626
5630
|
<dd>
|
|
4627
5631
|
|
|
5632
|
+
**request:** `Extend.ProcessorRunDeleteRequest`
|
|
5633
|
+
|
|
5634
|
+
</dd>
|
|
5635
|
+
</dl>
|
|
5636
|
+
|
|
5637
|
+
<dl>
|
|
5638
|
+
<dd>
|
|
5639
|
+
|
|
4628
5640
|
**requestOptions:** `ProcessorRunClient.RequestOptions`
|
|
4629
5641
|
|
|
4630
5642
|
</dd>
|
|
@@ -4637,7 +5649,7 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4637
5649
|
</dl>
|
|
4638
5650
|
</details>
|
|
4639
5651
|
|
|
4640
|
-
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">cancel</a>(id) -> Extend.ProcessorRunCancelResponse</code></summary>
|
|
5652
|
+
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.ProcessorRunCancelResponse</code></summary>
|
|
4641
5653
|
<dl>
|
|
4642
5654
|
<dd>
|
|
4643
5655
|
|
|
@@ -4694,6 +5706,14 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4694
5706
|
<dl>
|
|
4695
5707
|
<dd>
|
|
4696
5708
|
|
|
5709
|
+
**request:** `Extend.ProcessorRunCancelRequest`
|
|
5710
|
+
|
|
5711
|
+
</dd>
|
|
5712
|
+
</dl>
|
|
5713
|
+
|
|
5714
|
+
<dl>
|
|
5715
|
+
<dd>
|
|
5716
|
+
|
|
4697
5717
|
**requestOptions:** `ProcessorRunClient.RequestOptions`
|
|
4698
5718
|
|
|
4699
5719
|
</dd>
|
|
@@ -4912,7 +5932,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4912
5932
|
</details>
|
|
4913
5933
|
|
|
4914
5934
|
## ProcessorVersion
|
|
4915
|
-
<details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">list</a>(id) -> Extend.ProcessorVersionListResponse</code></summary>
|
|
5935
|
+
<details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">list</a>(id, { ...params }) -> Extend.ProcessorVersionListResponse</code></summary>
|
|
4916
5936
|
<dl>
|
|
4917
5937
|
<dd>
|
|
4918
5938
|
|
|
@@ -4970,6 +5990,14 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4970
5990
|
<dl>
|
|
4971
5991
|
<dd>
|
|
4972
5992
|
|
|
5993
|
+
**request:** `Extend.ProcessorVersionListRequest`
|
|
5994
|
+
|
|
5995
|
+
</dd>
|
|
5996
|
+
</dl>
|
|
5997
|
+
|
|
5998
|
+
<dl>
|
|
5999
|
+
<dd>
|
|
6000
|
+
|
|
4973
6001
|
**requestOptions:** `ProcessorVersionClient.RequestOptions`
|
|
4974
6002
|
|
|
4975
6003
|
</dd>
|
|
@@ -5061,7 +6089,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
5061
6089
|
</dl>
|
|
5062
6090
|
</details>
|
|
5063
6091
|
|
|
5064
|
-
<details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">get</a>(processorId, processorVersionId) -> Extend.ProcessorVersionGetResponse</code></summary>
|
|
6092
|
+
<details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">get</a>(processorId, processorVersionId, { ...params }) -> Extend.ProcessorVersionGetResponse</code></summary>
|
|
5065
6093
|
<dl>
|
|
5066
6094
|
<dd>
|
|
5067
6095
|
|
|
@@ -5128,6 +6156,14 @@ Example: `"exv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
5128
6156
|
<dl>
|
|
5129
6157
|
<dd>
|
|
5130
6158
|
|
|
6159
|
+
**request:** `Extend.ProcessorVersionGetRequest`
|
|
6160
|
+
|
|
6161
|
+
</dd>
|
|
6162
|
+
</dl>
|
|
6163
|
+
|
|
6164
|
+
<dl>
|
|
6165
|
+
<dd>
|
|
6166
|
+
|
|
5131
6167
|
**requestOptions:** `ProcessorVersionClient.RequestOptions`
|
|
5132
6168
|
|
|
5133
6169
|
</dd>
|
|
@@ -5141,7 +6177,7 @@ Example: `"exv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
5141
6177
|
</details>
|
|
5142
6178
|
|
|
5143
6179
|
## BatchProcessorRun
|
|
5144
|
-
<details><summary><code>client.batchProcessorRun.<a href="/src/api/resources/batchProcessorRun/client/Client.ts">get</a>(id) -> Extend.BatchProcessorRunGetResponse</code></summary>
|
|
6180
|
+
<details><summary><code>client.batchProcessorRun.<a href="/src/api/resources/batchProcessorRun/client/Client.ts">get</a>(id, { ...params }) -> Extend.BatchProcessorRunGetResponse</code></summary>
|
|
5145
6181
|
<dl>
|
|
5146
6182
|
<dd>
|
|
5147
6183
|
|
|
@@ -5198,6 +6234,14 @@ Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
5198
6234
|
<dl>
|
|
5199
6235
|
<dd>
|
|
5200
6236
|
|
|
6237
|
+
**request:** `Extend.BatchProcessorRunGetRequest`
|
|
6238
|
+
|
|
6239
|
+
</dd>
|
|
6240
|
+
</dl>
|
|
6241
|
+
|
|
6242
|
+
<dl>
|
|
6243
|
+
<dd>
|
|
6244
|
+
|
|
5201
6245
|
**requestOptions:** `BatchProcessorRunClient.RequestOptions`
|
|
5202
6246
|
|
|
5203
6247
|
</dd>
|
|
@@ -5206,6 +6250,89 @@ Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
5206
6250
|
</dl>
|
|
5207
6251
|
|
|
5208
6252
|
|
|
6253
|
+
</dd>
|
|
6254
|
+
</dl>
|
|
6255
|
+
</details>
|
|
6256
|
+
|
|
6257
|
+
## BatchRuns
|
|
6258
|
+
<details><summary><code>client.batchRuns.<a href="/src/api/resources/batchRuns/client/Client.ts">get</a>(id) -> Extend.BatchRun</code></summary>
|
|
6259
|
+
<dl>
|
|
6260
|
+
<dd>
|
|
6261
|
+
|
|
6262
|
+
#### 📝 Description
|
|
6263
|
+
|
|
6264
|
+
<dl>
|
|
6265
|
+
<dd>
|
|
6266
|
+
|
|
6267
|
+
<dl>
|
|
6268
|
+
<dd>
|
|
6269
|
+
|
|
6270
|
+
Retrieve the status of a batch run by its ID. The `status` field reflects the aggregate state of the batch.
|
|
6271
|
+
|
|
6272
|
+
This is a unified endpoint that works for batches created via any of the batch submission endpoints (`POST /extract_runs/batch`, `POST /classify_runs/batch`, `POST /split_runs/batch`).
|
|
6273
|
+
|
|
6274
|
+
| Status | Meaning |
|
|
6275
|
+
|---|---|
|
|
6276
|
+
| `PENDING` | Queued, not yet started |
|
|
6277
|
+
| `PROCESSING` | Runs are actively being processed |
|
|
6278
|
+
| `PROCESSED` | All runs have completed |
|
|
6279
|
+
| `FAILED` | The batch encountered a fatal error |
|
|
6280
|
+
| `CANCELLED` | The batch was cancelled |
|
|
6281
|
+
|
|
6282
|
+
To retrieve individual run results, use the List endpoint for the relevant processor type filtered by `batchId`:
|
|
6283
|
+
- `GET /extract_runs?batchId={id}`
|
|
6284
|
+
- `GET /classify_runs?batchId={id}`
|
|
6285
|
+
- `GET /split_runs?batchId={id}`
|
|
6286
|
+
</dd>
|
|
6287
|
+
</dl>
|
|
6288
|
+
</dd>
|
|
6289
|
+
</dl>
|
|
6290
|
+
|
|
6291
|
+
#### 🔌 Usage
|
|
6292
|
+
|
|
6293
|
+
<dl>
|
|
6294
|
+
<dd>
|
|
6295
|
+
|
|
6296
|
+
<dl>
|
|
6297
|
+
<dd>
|
|
6298
|
+
|
|
6299
|
+
```typescript
|
|
6300
|
+
await client.batchRuns.get("bpr_Xj8mK2pL9nR4vT7qY5wZ");
|
|
6301
|
+
|
|
6302
|
+
```
|
|
6303
|
+
</dd>
|
|
6304
|
+
</dl>
|
|
6305
|
+
</dd>
|
|
6306
|
+
</dl>
|
|
6307
|
+
|
|
6308
|
+
#### ⚙️ Parameters
|
|
6309
|
+
|
|
6310
|
+
<dl>
|
|
6311
|
+
<dd>
|
|
6312
|
+
|
|
6313
|
+
<dl>
|
|
6314
|
+
<dd>
|
|
6315
|
+
|
|
6316
|
+
**id:** `string`
|
|
6317
|
+
|
|
6318
|
+
The unique identifier of the batch processor run to retrieve.
|
|
6319
|
+
|
|
6320
|
+
Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
6321
|
+
|
|
6322
|
+
</dd>
|
|
6323
|
+
</dl>
|
|
6324
|
+
|
|
6325
|
+
<dl>
|
|
6326
|
+
<dd>
|
|
6327
|
+
|
|
6328
|
+
**requestOptions:** `BatchRunsClient.RequestOptions`
|
|
6329
|
+
|
|
6330
|
+
</dd>
|
|
6331
|
+
</dl>
|
|
6332
|
+
</dd>
|
|
6333
|
+
</dl>
|
|
6334
|
+
|
|
6335
|
+
|
|
5209
6336
|
</dd>
|
|
5210
6337
|
</dl>
|
|
5211
6338
|
</details>
|
|
@@ -5346,7 +6473,7 @@ await client.evaluationSets.create({
|
|
|
5346
6473
|
</dl>
|
|
5347
6474
|
</details>
|
|
5348
6475
|
|
|
5349
|
-
<details><summary><code>client.evaluationSets.<a href="/src/api/resources/evaluationSets/client/Client.ts">retrieve</a>(id) -> Extend.EvaluationSet</code></summary>
|
|
6476
|
+
<details><summary><code>client.evaluationSets.<a href="/src/api/resources/evaluationSets/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.EvaluationSet</code></summary>
|
|
5350
6477
|
<dl>
|
|
5351
6478
|
<dd>
|
|
5352
6479
|
|
|
@@ -5401,6 +6528,14 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
|
|
|
5401
6528
|
<dl>
|
|
5402
6529
|
<dd>
|
|
5403
6530
|
|
|
6531
|
+
**request:** `Extend.EvaluationSetsRetrieveRequest`
|
|
6532
|
+
|
|
6533
|
+
</dd>
|
|
6534
|
+
</dl>
|
|
6535
|
+
|
|
6536
|
+
<dl>
|
|
6537
|
+
<dd>
|
|
6538
|
+
|
|
5404
6539
|
**requestOptions:** `EvaluationSetsClient.RequestOptions`
|
|
5405
6540
|
|
|
5406
6541
|
</dd>
|
|
@@ -5583,7 +6718,7 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
|
|
|
5583
6718
|
</dl>
|
|
5584
6719
|
</details>
|
|
5585
6720
|
|
|
5586
|
-
<details><summary><code>client.evaluationSetItems.<a href="/src/api/resources/evaluationSetItems/client/Client.ts">retrieve</a>(evaluationSetId, itemId) -> Extend.EvaluationSetItem</code></summary>
|
|
6721
|
+
<details><summary><code>client.evaluationSetItems.<a href="/src/api/resources/evaluationSetItems/client/Client.ts">retrieve</a>(evaluationSetId, itemId, { ...params }) -> Extend.EvaluationSetItem</code></summary>
|
|
5587
6722
|
<dl>
|
|
5588
6723
|
<dd>
|
|
5589
6724
|
|
|
@@ -5650,6 +6785,14 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
|
|
|
5650
6785
|
<dl>
|
|
5651
6786
|
<dd>
|
|
5652
6787
|
|
|
6788
|
+
**request:** `Extend.EvaluationSetItemsRetrieveRequest`
|
|
6789
|
+
|
|
6790
|
+
</dd>
|
|
6791
|
+
</dl>
|
|
6792
|
+
|
|
6793
|
+
<dl>
|
|
6794
|
+
<dd>
|
|
6795
|
+
|
|
5653
6796
|
**requestOptions:** `EvaluationSetItemsClient.RequestOptions`
|
|
5654
6797
|
|
|
5655
6798
|
</dd>
|
|
@@ -5757,7 +6900,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
|
|
|
5757
6900
|
</dl>
|
|
5758
6901
|
</details>
|
|
5759
6902
|
|
|
5760
|
-
<details><summary><code>client.evaluationSetItems.<a href="/src/api/resources/evaluationSetItems/client/Client.ts">delete</a>(evaluationSetId, itemId) -> Extend.EvaluationSetItemsDeleteResponse</code></summary>
|
|
6903
|
+
<details><summary><code>client.evaluationSetItems.<a href="/src/api/resources/evaluationSetItems/client/Client.ts">delete</a>(evaluationSetId, itemId, { ...params }) -> Extend.EvaluationSetItemsDeleteResponse</code></summary>
|
|
5761
6904
|
<dl>
|
|
5762
6905
|
<dd>
|
|
5763
6906
|
|
|
@@ -5824,6 +6967,14 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
|
|
|
5824
6967
|
<dl>
|
|
5825
6968
|
<dd>
|
|
5826
6969
|
|
|
6970
|
+
**request:** `Extend.EvaluationSetItemsDeleteRequest`
|
|
6971
|
+
|
|
6972
|
+
</dd>
|
|
6973
|
+
</dl>
|
|
6974
|
+
|
|
6975
|
+
<dl>
|
|
6976
|
+
<dd>
|
|
6977
|
+
|
|
5827
6978
|
**requestOptions:** `EvaluationSetItemsClient.RequestOptions`
|
|
5828
6979
|
|
|
5829
6980
|
</dd>
|
|
@@ -5837,7 +6988,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
|
|
|
5837
6988
|
</details>
|
|
5838
6989
|
|
|
5839
6990
|
## EvaluationSetRuns
|
|
5840
|
-
<details><summary><code>client.evaluationSetRuns.<a href="/src/api/resources/evaluationSetRuns/client/Client.ts">retrieve</a>(id) -> Extend.EvaluationSetRun</code></summary>
|
|
6991
|
+
<details><summary><code>client.evaluationSetRuns.<a href="/src/api/resources/evaluationSetRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.EvaluationSetRun</code></summary>
|
|
5841
6992
|
<dl>
|
|
5842
6993
|
<dd>
|
|
5843
6994
|
|
|
@@ -5892,6 +7043,14 @@ Example: `"evr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
5892
7043
|
<dl>
|
|
5893
7044
|
<dd>
|
|
5894
7045
|
|
|
7046
|
+
**request:** `Extend.EvaluationSetRunsRetrieveRequest`
|
|
7047
|
+
|
|
7048
|
+
</dd>
|
|
7049
|
+
</dl>
|
|
7050
|
+
|
|
7051
|
+
<dl>
|
|
7052
|
+
<dd>
|
|
7053
|
+
|
|
5895
7054
|
**requestOptions:** `EvaluationSetRunsClient.RequestOptions`
|
|
5896
7055
|
|
|
5897
7056
|
</dd>
|
|
@@ -6042,7 +7201,7 @@ await client.webhookEndpoints.create({
|
|
|
6042
7201
|
</dl>
|
|
6043
7202
|
</details>
|
|
6044
7203
|
|
|
6045
|
-
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">retrieve</a>(id) -> Extend.WebhookEndpoint</code></summary>
|
|
7204
|
+
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.WebhookEndpoint</code></summary>
|
|
6046
7205
|
<dl>
|
|
6047
7206
|
<dd>
|
|
6048
7207
|
|
|
@@ -6097,6 +7256,14 @@ Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6097
7256
|
<dl>
|
|
6098
7257
|
<dd>
|
|
6099
7258
|
|
|
7259
|
+
**request:** `Extend.WebhookEndpointsRetrieveRequest`
|
|
7260
|
+
|
|
7261
|
+
</dd>
|
|
7262
|
+
</dl>
|
|
7263
|
+
|
|
7264
|
+
<dl>
|
|
7265
|
+
<dd>
|
|
7266
|
+
|
|
6100
7267
|
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
|
|
6101
7268
|
|
|
6102
7269
|
</dd>
|
|
@@ -6186,7 +7353,7 @@ Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6186
7353
|
</dl>
|
|
6187
7354
|
</details>
|
|
6188
7355
|
|
|
6189
|
-
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">delete</a>(id) -> Extend.WebhookEndpointsDeleteResponse</code></summary>
|
|
7356
|
+
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">delete</a>(id, { ...params }) -> Extend.WebhookEndpointsDeleteResponse</code></summary>
|
|
6190
7357
|
<dl>
|
|
6191
7358
|
<dd>
|
|
6192
7359
|
|
|
@@ -6241,6 +7408,14 @@ Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6241
7408
|
<dl>
|
|
6242
7409
|
<dd>
|
|
6243
7410
|
|
|
7411
|
+
**request:** `Extend.WebhookEndpointsDeleteRequest`
|
|
7412
|
+
|
|
7413
|
+
</dd>
|
|
7414
|
+
</dl>
|
|
7415
|
+
|
|
7416
|
+
<dl>
|
|
7417
|
+
<dd>
|
|
7418
|
+
|
|
6244
7419
|
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
|
|
6245
7420
|
|
|
6246
7421
|
</dd>
|
|
@@ -6391,7 +7566,7 @@ await client.webhookSubscriptions.create({
|
|
|
6391
7566
|
</dl>
|
|
6392
7567
|
</details>
|
|
6393
7568
|
|
|
6394
|
-
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">retrieve</a>(id) -> Extend.WebhookSubscription</code></summary>
|
|
7569
|
+
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.WebhookSubscription</code></summary>
|
|
6395
7570
|
<dl>
|
|
6396
7571
|
<dd>
|
|
6397
7572
|
|
|
@@ -6446,6 +7621,14 @@ Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6446
7621
|
<dl>
|
|
6447
7622
|
<dd>
|
|
6448
7623
|
|
|
7624
|
+
**request:** `Extend.WebhookSubscriptionsRetrieveRequest`
|
|
7625
|
+
|
|
7626
|
+
</dd>
|
|
7627
|
+
</dl>
|
|
7628
|
+
|
|
7629
|
+
<dl>
|
|
7630
|
+
<dd>
|
|
7631
|
+
|
|
6449
7632
|
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
|
|
6450
7633
|
|
|
6451
7634
|
</dd>
|
|
@@ -6535,7 +7718,7 @@ Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6535
7718
|
</dl>
|
|
6536
7719
|
</details>
|
|
6537
7720
|
|
|
6538
|
-
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">delete</a>(id) -> Extend.WebhookSubscriptionsDeleteResponse</code></summary>
|
|
7721
|
+
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">delete</a>(id, { ...params }) -> Extend.WebhookSubscriptionsDeleteResponse</code></summary>
|
|
6539
7722
|
<dl>
|
|
6540
7723
|
<dd>
|
|
6541
7724
|
|
|
@@ -6590,6 +7773,14 @@ Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6590
7773
|
<dl>
|
|
6591
7774
|
<dd>
|
|
6592
7775
|
|
|
7776
|
+
**request:** `Extend.WebhookSubscriptionsDeleteRequest`
|
|
7777
|
+
|
|
7778
|
+
</dd>
|
|
7779
|
+
</dl>
|
|
7780
|
+
|
|
7781
|
+
<dl>
|
|
7782
|
+
<dd>
|
|
7783
|
+
|
|
6593
7784
|
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
|
|
6594
7785
|
|
|
6595
7786
|
</dd>
|