extend-ai 1.6.0 → 1.7.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 +6 -0
- package/Client.js +51 -38
- 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/BatchProcessorRunGetRequest.js +3 -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/classifierVersions/client/Client.d.ts +2 -1
- package/api/resources/classifierVersions/client/Client.js +32 -9
- 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/ClassifierVersionsRetrieveRequest.js +3 -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/ClassifiersRetrieveRequest.js +3 -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 +6 -3
- package/api/resources/classifyRuns/client/Client.js +35 -17
- package/api/resources/classifyRuns/client/requests/ClassifyRunsCancelRequest.d.ts +8 -0
- package/api/resources/classifyRuns/client/requests/ClassifyRunsCancelRequest.js +3 -0
- package/api/resources/classifyRuns/client/requests/ClassifyRunsDeleteRequest.d.ts +8 -0
- package/api/resources/classifyRuns/client/requests/ClassifyRunsDeleteRequest.js +3 -0
- package/api/resources/classifyRuns/client/requests/ClassifyRunsListRequest.d.ts +2 -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 +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 +6 -3
- package/api/resources/extractRuns/client/Client.js +35 -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/ExtractRunsDeleteRequest.d.ts +8 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsDeleteRequest.js +3 -0
- package/api/resources/extractRuns/client/requests/ExtractRunsListRequest.d.ts +2 -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 +3 -0
- package/api/resources/extractorVersions/client/Client.d.ts +2 -1
- package/api/resources/extractorVersions/client/Client.js +32 -9
- 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 +9 -0
- package/api/resources/index.js +10 -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 +6 -3
- package/api/resources/splitRuns/client/Client.js +35 -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/SplitRunsDeleteRequest.d.ts +8 -0
- package/api/resources/splitRuns/client/requests/SplitRunsDeleteRequest.js +3 -0
- package/api/resources/splitRuns/client/requests/SplitRunsListRequest.d.ts +2 -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 +3 -0
- package/api/resources/splitterVersions/client/Client.d.ts +2 -1
- package/api/resources/splitterVersions/client/Client.js +32 -9
- 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/Block.d.ts +6 -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 +11 -1
- package/api/types/BlockType.js +11 -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/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/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 +15 -0
- package/api/types/ParseConfigAdvancedOptionsEnrichmentFormat.d.ts +11 -0
- package/api/types/ParseConfigAdvancedOptionsEnrichmentFormat.js +14 -0
- package/api/types/ParseConfigAdvancedOptionsImageConversionQuality.d.ts +13 -0
- package/api/types/ParseConfigAdvancedOptionsImageConversionQuality.js +16 -0
- package/api/types/ParseConfigBlockOptions.d.ts +4 -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/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/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/WebhookResponseStepDefinition.d.ts +8 -0
- package/api/types/WebhookResponseStepDefinition.js +3 -0
- 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 +61 -0
- package/api/types/index.js +61 -0
- package/package.json +1 -1
- package/reference.md +871 -75
- 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
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* HTTP request configuration for the external validation call.
|
|
4
|
+
*
|
|
5
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#external-data-validation-step).
|
|
6
|
+
*/
|
|
7
|
+
export interface ExternalDataValidationStepDefinitionConfigRequestOptions {
|
|
8
|
+
/** The URL to send the validation request to. */
|
|
9
|
+
url: string;
|
|
10
|
+
method: Extend.ExternalDataValidationStepDefinitionConfigRequestOptionsMethod;
|
|
11
|
+
/**
|
|
12
|
+
* Optional HTTP headers to include on the external validation request.
|
|
13
|
+
*
|
|
14
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#external-data-validation-step).
|
|
15
|
+
*/
|
|
16
|
+
headers?: Record<string, string>;
|
|
17
|
+
/**
|
|
18
|
+
* Content type of the request body sent to the external endpoint.
|
|
19
|
+
*
|
|
20
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#external-data-validation-step).
|
|
21
|
+
*/
|
|
22
|
+
contentType?: Extend.ExternalDataValidationStepDefinitionConfigRequestOptionsContentType;
|
|
23
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Content type of the request body sent to the external endpoint.
|
|
3
|
+
*
|
|
4
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#external-data-validation-step).
|
|
5
|
+
*/
|
|
6
|
+
export declare const ExternalDataValidationStepDefinitionConfigRequestOptionsContentType: {
|
|
7
|
+
readonly ApplicationJson: "application/json";
|
|
8
|
+
readonly TextPlain: "text/plain";
|
|
9
|
+
};
|
|
10
|
+
export type ExternalDataValidationStepDefinitionConfigRequestOptionsContentType = (typeof ExternalDataValidationStepDefinitionConfigRequestOptionsContentType)[keyof typeof ExternalDataValidationStepDefinitionConfigRequestOptionsContentType] | string;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ExternalDataValidationStepDefinitionConfigRequestOptionsContentType = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* Content type of the request body sent to the external endpoint.
|
|
7
|
+
*
|
|
8
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#external-data-validation-step).
|
|
9
|
+
*/
|
|
10
|
+
exports.ExternalDataValidationStepDefinitionConfigRequestOptionsContentType = {
|
|
11
|
+
ApplicationJson: "application/json",
|
|
12
|
+
TextPlain: "text/plain",
|
|
13
|
+
};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export declare const ExternalDataValidationStepDefinitionConfigRequestOptionsMethod: {
|
|
2
|
+
readonly Get: "GET";
|
|
3
|
+
readonly Post: "POST";
|
|
4
|
+
readonly Put: "PUT";
|
|
5
|
+
};
|
|
6
|
+
export type ExternalDataValidationStepDefinitionConfigRequestOptionsMethod = (typeof ExternalDataValidationStepDefinitionConfigRequestOptionsMethod)[keyof typeof ExternalDataValidationStepDefinitionConfigRequestOptionsMethod] | string;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ExternalDataValidationStepDefinitionConfigRequestOptionsMethod = void 0;
|
|
5
|
+
exports.ExternalDataValidationStepDefinitionConfigRequestOptionsMethod = {
|
|
6
|
+
Get: "GET",
|
|
7
|
+
Post: "POST",
|
|
8
|
+
Put: "PUT",
|
|
9
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Extracts structured data from parsed content using an extractor.
|
|
4
|
+
*
|
|
5
|
+
* The extractor reference must include an explicit `version`. Valid values are `"latest"`, `"draft"`, or a specific semver string (e.g. `"1.0"`).
|
|
6
|
+
*
|
|
7
|
+
* See the [Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#extract-step).
|
|
8
|
+
*/
|
|
9
|
+
export interface ExtractStepDefinition {
|
|
10
|
+
name: string;
|
|
11
|
+
/** Optional on create/update. Required before the workflow can be deployed. Omitted in responses when the step is not yet configured. */
|
|
12
|
+
config?: Extend.ExtractStepDefinitionConfig;
|
|
13
|
+
/** Can only be set when `config` is present. */
|
|
14
|
+
next?: Extend.SimpleNextEntry[];
|
|
15
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Optional on create/update. Required before the workflow can be deployed. Omitted in responses when the step is not yet configured.
|
|
4
|
+
*/
|
|
5
|
+
export interface ExtractStepDefinitionConfig {
|
|
6
|
+
extractor: Extend.ExtractorRef;
|
|
7
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A reference to an extractor.
|
|
3
|
+
*/
|
|
4
|
+
export interface ExtractorRef {
|
|
5
|
+
/** The extractor ID. */
|
|
6
|
+
id: string;
|
|
7
|
+
/** The extractor version to use: `"latest"` (most recent published version), `"draft"`, or a specific semver string (e.g. `"1.0"`). */
|
|
8
|
+
version: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Converts files to a different format.
|
|
4
|
+
*
|
|
5
|
+
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#file-conversion-step).
|
|
6
|
+
*/
|
|
7
|
+
export interface FileConversionStepDefinition {
|
|
8
|
+
name: string;
|
|
9
|
+
config?: Extend.FileConversionStepDefinitionConfig;
|
|
10
|
+
next?: Extend.SimpleNextEntry[];
|
|
11
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
export interface FileConversionStepDefinitionConfig {
|
|
3
|
+
/**
|
|
4
|
+
* Whether to continue or exit the workflow if file conversion fails. Defaults to `EXIT`.
|
|
5
|
+
*
|
|
6
|
+
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#file-conversion-step).
|
|
7
|
+
*/
|
|
8
|
+
failureBehavior?: Extend.FileConversionStepDefinitionConfigFailureBehavior;
|
|
9
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Whether to continue or exit the workflow if file conversion fails. Defaults to `EXIT`.
|
|
3
|
+
*
|
|
4
|
+
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#file-conversion-step).
|
|
5
|
+
*/
|
|
6
|
+
export declare const FileConversionStepDefinitionConfigFailureBehavior: {
|
|
7
|
+
readonly Continue: "CONTINUE";
|
|
8
|
+
readonly Exit: "EXIT";
|
|
9
|
+
};
|
|
10
|
+
export type FileConversionStepDefinitionConfigFailureBehavior = (typeof FileConversionStepDefinitionConfigFailureBehavior)[keyof typeof FileConversionStepDefinitionConfigFailureBehavior] | string;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.FileConversionStepDefinitionConfigFailureBehavior = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* Whether to continue or exit the workflow if file conversion fails. Defaults to `EXIT`.
|
|
7
|
+
*
|
|
8
|
+
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#file-conversion-step).
|
|
9
|
+
*/
|
|
10
|
+
exports.FileConversionStepDefinitionConfigFailureBehavior = {
|
|
11
|
+
Continue: "CONTINUE",
|
|
12
|
+
Exit: "EXIT",
|
|
13
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Pauses the workflow for human review in the dashboard.
|
|
4
|
+
*
|
|
5
|
+
* See the [Human Review step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#human-review-step).
|
|
6
|
+
*/
|
|
7
|
+
export interface HumanReviewStepDefinition {
|
|
8
|
+
name: string;
|
|
9
|
+
next?: Extend.SimpleNextEntry[];
|
|
10
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Merges extraction outputs from multiple upstream extract steps.
|
|
4
|
+
*
|
|
5
|
+
* See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#merge-extract-step).
|
|
6
|
+
*/
|
|
7
|
+
export interface MergeExtractStepDefinition {
|
|
8
|
+
name: string;
|
|
9
|
+
config?: Extend.MergeExtractStepDefinitionConfig;
|
|
10
|
+
next?: Extend.SimpleNextEntry[];
|
|
11
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
export interface MergeExtractStepDefinitionConfig {
|
|
3
|
+
/**
|
|
4
|
+
* How to order fields when merging. Defaults to confidence.
|
|
5
|
+
*
|
|
6
|
+
* See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#merge-extract-step).
|
|
7
|
+
*/
|
|
8
|
+
mergeOrder?: Extend.MergeExtractStepDefinitionConfigMergeOrder;
|
|
9
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* How to order fields when merging. Defaults to confidence.
|
|
3
|
+
*
|
|
4
|
+
* See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#merge-extract-step).
|
|
5
|
+
*/
|
|
6
|
+
export declare const MergeExtractStepDefinitionConfigMergeOrder: {
|
|
7
|
+
readonly Confidence: "confidence";
|
|
8
|
+
readonly Alphabetic: "alphabetic";
|
|
9
|
+
readonly FirstToExecute: "first_to_execute";
|
|
10
|
+
readonly LastToExecute: "last_to_execute";
|
|
11
|
+
};
|
|
12
|
+
export type MergeExtractStepDefinitionConfigMergeOrder = (typeof MergeExtractStepDefinitionConfigMergeOrder)[keyof typeof MergeExtractStepDefinitionConfigMergeOrder] | string;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.MergeExtractStepDefinitionConfigMergeOrder = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* How to order fields when merging. Defaults to confidence.
|
|
7
|
+
*
|
|
8
|
+
* See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#merge-extract-step).
|
|
9
|
+
*/
|
|
10
|
+
exports.MergeExtractStepDefinitionConfigMergeOrder = {
|
|
11
|
+
Confidence: "confidence",
|
|
12
|
+
Alphabetic: "alphabetic",
|
|
13
|
+
FirstToExecute: "first_to_execute",
|
|
14
|
+
LastToExecute: "last_to_execute",
|
|
15
|
+
};
|
|
@@ -24,4 +24,19 @@ export interface ParseConfigAdvancedOptions {
|
|
|
24
24
|
returnOcr?: Extend.ParseConfigAdvancedOptionsReturnOcr;
|
|
25
25
|
/** Whether to convert supported file types (images, Word documents, PowerPoint, Excel, HTML) to PDF before parsing. This can improve parsing quality for some file types and ensures spatial output with bounding boxes. */
|
|
26
26
|
alwaysConvertToPdf?: boolean;
|
|
27
|
+
/**
|
|
28
|
+
* The format used for enrichment annotations in the output.
|
|
29
|
+
*
|
|
30
|
+
* * `xml`: Use XML-style tags for enrichment annotations, e.g. <page_number>1</page_number> or <barcode>1234567890</barcode>
|
|
31
|
+
* * `bracket`: Use bracket-style notation for enrichment annotations, e.g. [page_number: 1] or [barcode: 1234567890]
|
|
32
|
+
*/
|
|
33
|
+
enrichmentFormat?: Extend.ParseConfigAdvancedOptionsEnrichmentFormat;
|
|
34
|
+
/**
|
|
35
|
+
* Controls the quality level when converting images or documents to PDF for parsing.
|
|
36
|
+
*
|
|
37
|
+
* * `high`: Maximum quality, can add some latency for large/dense documents
|
|
38
|
+
* * `medium`: Balanced quality and speed
|
|
39
|
+
* * `low`: Lower quality, smaller file sizes, faster processing
|
|
40
|
+
*/
|
|
41
|
+
imageConversionQuality?: Extend.ParseConfigAdvancedOptionsImageConversionQuality;
|
|
27
42
|
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The format used for enrichment annotations in the output.
|
|
3
|
+
*
|
|
4
|
+
* * `xml`: Use XML-style tags for enrichment annotations, e.g. <page_number>1</page_number> or <barcode>1234567890</barcode>
|
|
5
|
+
* * `bracket`: Use bracket-style notation for enrichment annotations, e.g. [page_number: 1] or [barcode: 1234567890]
|
|
6
|
+
*/
|
|
7
|
+
export declare const ParseConfigAdvancedOptionsEnrichmentFormat: {
|
|
8
|
+
readonly Xml: "xml";
|
|
9
|
+
readonly Bracket: "bracket";
|
|
10
|
+
};
|
|
11
|
+
export type ParseConfigAdvancedOptionsEnrichmentFormat = (typeof ParseConfigAdvancedOptionsEnrichmentFormat)[keyof typeof ParseConfigAdvancedOptionsEnrichmentFormat] | string;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ParseConfigAdvancedOptionsEnrichmentFormat = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* The format used for enrichment annotations in the output.
|
|
7
|
+
*
|
|
8
|
+
* * `xml`: Use XML-style tags for enrichment annotations, e.g. <page_number>1</page_number> or <barcode>1234567890</barcode>
|
|
9
|
+
* * `bracket`: Use bracket-style notation for enrichment annotations, e.g. [page_number: 1] or [barcode: 1234567890]
|
|
10
|
+
*/
|
|
11
|
+
exports.ParseConfigAdvancedOptionsEnrichmentFormat = {
|
|
12
|
+
Xml: "xml",
|
|
13
|
+
Bracket: "bracket",
|
|
14
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Controls the quality level when converting images or documents to PDF for parsing.
|
|
3
|
+
*
|
|
4
|
+
* * `high`: Maximum quality, can add some latency for large/dense documents
|
|
5
|
+
* * `medium`: Balanced quality and speed
|
|
6
|
+
* * `low`: Lower quality, smaller file sizes, faster processing
|
|
7
|
+
*/
|
|
8
|
+
export declare const ParseConfigAdvancedOptionsImageConversionQuality: {
|
|
9
|
+
readonly High: "high";
|
|
10
|
+
readonly Medium: "medium";
|
|
11
|
+
readonly Low: "low";
|
|
12
|
+
};
|
|
13
|
+
export type ParseConfigAdvancedOptionsImageConversionQuality = (typeof ParseConfigAdvancedOptionsImageConversionQuality)[keyof typeof ParseConfigAdvancedOptionsImageConversionQuality] | string;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ParseConfigAdvancedOptionsImageConversionQuality = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* Controls the quality level when converting images or documents to PDF for parsing.
|
|
7
|
+
*
|
|
8
|
+
* * `high`: Maximum quality, can add some latency for large/dense documents
|
|
9
|
+
* * `medium`: Balanced quality and speed
|
|
10
|
+
* * `low`: Lower quality, smaller file sizes, faster processing
|
|
11
|
+
*/
|
|
12
|
+
exports.ParseConfigAdvancedOptionsImageConversionQuality = {
|
|
13
|
+
High: "high",
|
|
14
|
+
Medium: "medium",
|
|
15
|
+
Low: "low",
|
|
16
|
+
};
|
|
@@ -9,4 +9,8 @@ export interface ParseConfigBlockOptions {
|
|
|
9
9
|
tables?: Extend.ParseConfigBlockOptionsTables;
|
|
10
10
|
/** Options for text blocks. */
|
|
11
11
|
text?: Extend.ParseConfigBlockOptionsText;
|
|
12
|
+
/** Options for key-value pair blocks. */
|
|
13
|
+
keyValue?: Extend.ParseConfigBlockOptionsKeyValue;
|
|
14
|
+
/** Options for barcode blocks. */
|
|
15
|
+
barcodes?: Extend.ParseConfigBlockOptionsBarcodes;
|
|
12
16
|
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Options for barcode blocks.
|
|
3
|
+
*/
|
|
4
|
+
export interface ParseConfigBlockOptionsBarcodes {
|
|
5
|
+
/** Whether to clip and extract images of barcodes. When enabled, barcode images will be available in the `imageUrl` field of BarcodeDetails. */
|
|
6
|
+
imageClippingEnabled?: boolean;
|
|
7
|
+
/** Whether to decode and read barcode values. When enabled, decoded values will be available in the `decodedValue` field of BarcodeDetails. */
|
|
8
|
+
readingEnabled?: boolean;
|
|
9
|
+
}
|
|
@@ -6,4 +6,6 @@ export interface ParseConfigBlockOptionsFigures {
|
|
|
6
6
|
enabled?: boolean;
|
|
7
7
|
/** Whether to clip and extract images from figures. */
|
|
8
8
|
figureImageClippingEnabled?: boolean;
|
|
9
|
+
/** Whether to enable advanced chart extraction using vision models for improved data extraction from charts. */
|
|
10
|
+
advancedChartExtractionEnabled?: boolean;
|
|
9
11
|
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Parses file content (OCR, text extraction). Every workflow should have exactly one parse step immediately after the trigger.
|
|
4
|
+
*
|
|
5
|
+
* See the [Parse step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#parse-step).
|
|
6
|
+
*/
|
|
7
|
+
export interface ParseStepDefinition {
|
|
8
|
+
name: string;
|
|
9
|
+
config?: Extend.ParseStepDefinitionConfig;
|
|
10
|
+
next?: Extend.SimpleNextEntry[];
|
|
11
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* A next entry for `RULE_VALIDATION` steps. Routes based on whether all validation rules passed.
|
|
4
|
+
*
|
|
5
|
+
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api) for end-to-end examples.
|
|
6
|
+
*/
|
|
7
|
+
export interface RuleValidationNextEntry {
|
|
8
|
+
/** The name of the target step. */
|
|
9
|
+
step: string;
|
|
10
|
+
/** Routes based on whether all validation rules passed. */
|
|
11
|
+
result: Extend.RuleValidationNextEntryResult;
|
|
12
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/** Routes based on whether all validation rules passed. */
|
|
2
|
+
export declare const RuleValidationNextEntryResult: {
|
|
3
|
+
readonly Pass: "pass";
|
|
4
|
+
readonly Fail: "fail";
|
|
5
|
+
};
|
|
6
|
+
export type RuleValidationNextEntryResult = (typeof RuleValidationNextEntryResult)[keyof typeof RuleValidationNextEntryResult] | string;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.RuleValidationNextEntryResult = void 0;
|
|
5
|
+
/** Routes based on whether all validation rules passed. */
|
|
6
|
+
exports.RuleValidationNextEntryResult = {
|
|
7
|
+
Pass: "pass",
|
|
8
|
+
Fail: "fail",
|
|
9
|
+
};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Validates extraction outputs against formula-based rules. Routes to pass/fail next steps.
|
|
4
|
+
*
|
|
5
|
+
* See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#rule-validation-step).
|
|
6
|
+
*/
|
|
7
|
+
export interface RuleValidationStepDefinition {
|
|
8
|
+
name: string;
|
|
9
|
+
/** Optional on create/update. Required before the workflow can be deployed. Omitted in responses when the step is not yet configured. */
|
|
10
|
+
config?: Extend.RuleValidationStepDefinitionConfig;
|
|
11
|
+
/**
|
|
12
|
+
* Can only be set when `config` is present. Each entry must include a `result` of `"pass"` or `"fail"` to route based on whether all validation rules passed.
|
|
13
|
+
*
|
|
14
|
+
* See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#rule-validation-step).
|
|
15
|
+
*/
|
|
16
|
+
next?: Extend.RuleValidationNextEntry[];
|
|
17
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Optional on create/update. Required before the workflow can be deployed. Omitted in responses when the step is not yet configured.
|
|
4
|
+
*/
|
|
5
|
+
export interface RuleValidationStepDefinitionConfig {
|
|
6
|
+
/**
|
|
7
|
+
* Validation rules for this step. Each rule defines a name and a boolean formula.
|
|
8
|
+
*
|
|
9
|
+
* See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#rule-validation-step).
|
|
10
|
+
*/
|
|
11
|
+
rules: Extend.RuleValidationStepDefinitionConfigRulesItem[];
|
|
12
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export interface RuleValidationStepDefinitionConfigRulesItem {
|
|
2
|
+
name: string;
|
|
3
|
+
/**
|
|
4
|
+
* Boolean formula used to validate the workflow data for this rule.
|
|
5
|
+
*
|
|
6
|
+
* See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#rule-validation-step) and [Formulas](https://docs.extend.ai/2026-02-09/product/workflows/formulas).
|
|
7
|
+
*/
|
|
8
|
+
formula: string;
|
|
9
|
+
description?: string;
|
|
10
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Splits a multi-document file into individual documents using a splitter. Routes to different next steps based on split type.
|
|
4
|
+
*
|
|
5
|
+
* The splitter reference must include a pinned `version` — `"latest"` is not supported for `SPLIT` steps. Use a specific semver string (e.g. `"0.1"`) or `"draft"`. This is because classification IDs used for routing are tied to a specific processor version's config.
|
|
6
|
+
*
|
|
7
|
+
* See the [Split step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#split-step).
|
|
8
|
+
*/
|
|
9
|
+
export interface SplitStepDefinition {
|
|
10
|
+
name: string;
|
|
11
|
+
/**
|
|
12
|
+
* Optional on create/update. Required before the workflow can be deployed. Omitted in responses when the step is not yet configured.
|
|
13
|
+
*
|
|
14
|
+
* Reference to the splitter used by this step. The `next[].classificationId` values must match split classification `id` values (not `type` strings) from the referenced splitter's configuration. For example, if the splitter defines `{ "id": "cls_receipt", "type": "receipt" }`, use `"cls_receipt"` as the `classificationId`.
|
|
15
|
+
*
|
|
16
|
+
* The splitter `version` is required and must be a pinned version (semver like `"0.1"` or `"draft"`). `"latest"` is not allowed.
|
|
17
|
+
*
|
|
18
|
+
* See the [Split step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#split-step).
|
|
19
|
+
*/
|
|
20
|
+
config?: Extend.SplitStepDefinitionConfig;
|
|
21
|
+
/**
|
|
22
|
+
* Can only be set when `config` is present. Each entry must include a `classificationId` matching a split classification `id` from the referenced splitter's configuration. Use the classification's stable `id` (e.g. `"cls_receipt"`), not the `type` string.
|
|
23
|
+
*
|
|
24
|
+
* See the [Split step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#split-step).
|
|
25
|
+
*/
|
|
26
|
+
next?: Extend.ClassificationNextEntry[];
|
|
27
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type * as Extend from "../index";
|
|
2
|
+
/**
|
|
3
|
+
* Optional on create/update. Required before the workflow can be deployed. Omitted in responses when the step is not yet configured.
|
|
4
|
+
*
|
|
5
|
+
* Reference to the splitter used by this step. The `next[].classificationId` values must match split classification `id` values (not `type` strings) from the referenced splitter's configuration. For example, if the splitter defines `{ "id": "cls_receipt", "type": "receipt" }`, use `"cls_receipt"` as the `classificationId`.
|
|
6
|
+
*
|
|
7
|
+
* The splitter `version` is required and must be a pinned version (semver like `"0.1"` or `"draft"`). `"latest"` is not allowed.
|
|
8
|
+
*
|
|
9
|
+
* See the [Split step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#split-step).
|
|
10
|
+
*/
|
|
11
|
+
export interface SplitStepDefinitionConfig {
|
|
12
|
+
splitter: Extend.SplitterRef;
|
|
13
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A reference to a splitter.
|
|
3
|
+
*/
|
|
4
|
+
export interface SplitterRef {
|
|
5
|
+
/** The splitter ID. */
|
|
6
|
+
id: string;
|
|
7
|
+
/** The splitter version to use: `"draft"` or a specific semver string (e.g. `"0.1"`). `"latest"` is not allowed because classification IDs used for routing are tied to a specific version's config. */
|
|
8
|
+
version: string;
|
|
9
|
+
}
|