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
|
@@ -56,9 +56,89 @@ class WorkflowsClient {
|
|
|
56
56
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* List all workflows. Returns a paginated list of workflow summaries.
|
|
60
60
|
*
|
|
61
|
-
*
|
|
61
|
+
* @param {Extend.WorkflowsListRequest} request
|
|
62
|
+
* @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link Extend.BadRequestError}
|
|
65
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
66
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
67
|
+
* @throws {@link Extend.ForbiddenError}
|
|
68
|
+
* @throws {@link Extend.NotFoundError}
|
|
69
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
70
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
71
|
+
* @throws {@link Extend.InternalServerError}
|
|
72
|
+
*
|
|
73
|
+
* @example
|
|
74
|
+
* await client.workflows.list({
|
|
75
|
+
* nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
76
|
+
* })
|
|
77
|
+
*/
|
|
78
|
+
list(request = {}, requestOptions) {
|
|
79
|
+
return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
|
|
80
|
+
}
|
|
81
|
+
__list() {
|
|
82
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
83
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
84
|
+
const { nextPageToken, maxPageSize, sortBy, sortDir } = request;
|
|
85
|
+
const _queryParams = {
|
|
86
|
+
nextPageToken,
|
|
87
|
+
maxPageSize,
|
|
88
|
+
sortBy: sortBy != null ? sortBy : undefined,
|
|
89
|
+
sortDir: sortDir != null ? sortDir : undefined,
|
|
90
|
+
};
|
|
91
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
92
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
93
|
+
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
94
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, "workflows"),
|
|
95
|
+
method: "GET",
|
|
96
|
+
headers: _headers,
|
|
97
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
98
|
+
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 300) * 1000,
|
|
99
|
+
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
100
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
101
|
+
fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
|
|
102
|
+
logging: this._options.logging,
|
|
103
|
+
});
|
|
104
|
+
if (_response.ok) {
|
|
105
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
106
|
+
}
|
|
107
|
+
if (_response.error.reason === "status-code") {
|
|
108
|
+
switch (_response.error.statusCode) {
|
|
109
|
+
case 400:
|
|
110
|
+
throw new Extend.BadRequestError(_response.error.body, _response.rawResponse);
|
|
111
|
+
case 401:
|
|
112
|
+
throw new Extend.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
113
|
+
case 402:
|
|
114
|
+
throw new Extend.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
115
|
+
case 403:
|
|
116
|
+
throw new Extend.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
117
|
+
case 404:
|
|
118
|
+
throw new Extend.NotFoundError(_response.error.body, _response.rawResponse);
|
|
119
|
+
case 422:
|
|
120
|
+
throw new Extend.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
121
|
+
case 429:
|
|
122
|
+
throw new Extend.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
123
|
+
case 500:
|
|
124
|
+
throw new Extend.InternalServerError(_response.error.body, _response.rawResponse);
|
|
125
|
+
default:
|
|
126
|
+
throw new errors.ExtendError({
|
|
127
|
+
statusCode: _response.error.statusCode,
|
|
128
|
+
body: _response.error.body,
|
|
129
|
+
rawResponse: _response.rawResponse,
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/workflows");
|
|
134
|
+
});
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Create a new workflow. Optionally provide `steps` to define the workflow's step graph.
|
|
138
|
+
*
|
|
139
|
+
* 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.
|
|
140
|
+
*
|
|
141
|
+
* **Note:** The default steps may change in the future. If your integration depends on a specific step graph, provide `steps` explicitly.
|
|
62
142
|
*
|
|
63
143
|
* @param {Extend.WorkflowsCreateRequest} request
|
|
64
144
|
* @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -76,6 +156,48 @@ class WorkflowsClient {
|
|
|
76
156
|
* await client.workflows.create({
|
|
77
157
|
* name: "Invoice Processing"
|
|
78
158
|
* })
|
|
159
|
+
*
|
|
160
|
+
* @example
|
|
161
|
+
* await client.workflows.create({
|
|
162
|
+
* name: "Invoice Processing",
|
|
163
|
+
* steps: [{
|
|
164
|
+
* type: "TRIGGER",
|
|
165
|
+
* name: "name"
|
|
166
|
+
* }, {
|
|
167
|
+
* type: "PARSE",
|
|
168
|
+
* name: "name"
|
|
169
|
+
* }, {
|
|
170
|
+
* type: "EXTRACT",
|
|
171
|
+
* name: "name"
|
|
172
|
+
* }, {
|
|
173
|
+
* type: "HUMAN_REVIEW",
|
|
174
|
+
* name: "name"
|
|
175
|
+
* }]
|
|
176
|
+
* })
|
|
177
|
+
*
|
|
178
|
+
* @example
|
|
179
|
+
* await client.workflows.create({
|
|
180
|
+
* name: "Document Routing",
|
|
181
|
+
* steps: [{
|
|
182
|
+
* type: "TRIGGER",
|
|
183
|
+
* name: "name"
|
|
184
|
+
* }, {
|
|
185
|
+
* type: "PARSE",
|
|
186
|
+
* name: "name"
|
|
187
|
+
* }, {
|
|
188
|
+
* type: "CLASSIFY",
|
|
189
|
+
* name: "name"
|
|
190
|
+
* }, {
|
|
191
|
+
* type: "EXTRACT",
|
|
192
|
+
* name: "name"
|
|
193
|
+
* }, {
|
|
194
|
+
* type: "EXTRACT",
|
|
195
|
+
* name: "name"
|
|
196
|
+
* }, {
|
|
197
|
+
* type: "HUMAN_REVIEW",
|
|
198
|
+
* name: "name"
|
|
199
|
+
* }]
|
|
200
|
+
* })
|
|
79
201
|
*/
|
|
80
202
|
create(request, requestOptions) {
|
|
81
203
|
return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
|
|
@@ -131,5 +253,162 @@ class WorkflowsClient {
|
|
|
131
253
|
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/workflows");
|
|
132
254
|
});
|
|
133
255
|
}
|
|
256
|
+
/**
|
|
257
|
+
* Get details of a workflow, including its draft version and steps.
|
|
258
|
+
*
|
|
259
|
+
* @param {string} id - The ID of the workflow.
|
|
260
|
+
* @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
261
|
+
*
|
|
262
|
+
* @throws {@link Extend.BadRequestError}
|
|
263
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
264
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
265
|
+
* @throws {@link Extend.ForbiddenError}
|
|
266
|
+
* @throws {@link Extend.NotFoundError}
|
|
267
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
268
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
269
|
+
* @throws {@link Extend.InternalServerError}
|
|
270
|
+
*
|
|
271
|
+
* @example
|
|
272
|
+
* await client.workflows.retrieve("workflow_abc123")
|
|
273
|
+
*/
|
|
274
|
+
retrieve(id, requestOptions) {
|
|
275
|
+
return core.HttpResponsePromise.fromPromise(this.__retrieve(id, requestOptions));
|
|
276
|
+
}
|
|
277
|
+
__retrieve(id, requestOptions) {
|
|
278
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
279
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
280
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
281
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
282
|
+
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
283
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, `workflows/${core.url.encodePathParam(id)}`),
|
|
284
|
+
method: "GET",
|
|
285
|
+
headers: _headers,
|
|
286
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
287
|
+
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 300) * 1000,
|
|
288
|
+
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
289
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
290
|
+
fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
|
|
291
|
+
logging: this._options.logging,
|
|
292
|
+
});
|
|
293
|
+
if (_response.ok) {
|
|
294
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
295
|
+
}
|
|
296
|
+
if (_response.error.reason === "status-code") {
|
|
297
|
+
switch (_response.error.statusCode) {
|
|
298
|
+
case 400:
|
|
299
|
+
throw new Extend.BadRequestError(_response.error.body, _response.rawResponse);
|
|
300
|
+
case 401:
|
|
301
|
+
throw new Extend.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
302
|
+
case 402:
|
|
303
|
+
throw new Extend.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
304
|
+
case 403:
|
|
305
|
+
throw new Extend.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
306
|
+
case 404:
|
|
307
|
+
throw new Extend.NotFoundError(_response.error.body, _response.rawResponse);
|
|
308
|
+
case 422:
|
|
309
|
+
throw new Extend.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
310
|
+
case 429:
|
|
311
|
+
throw new Extend.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
312
|
+
case 500:
|
|
313
|
+
throw new Extend.InternalServerError(_response.error.body, _response.rawResponse);
|
|
314
|
+
default:
|
|
315
|
+
throw new errors.ExtendError({
|
|
316
|
+
statusCode: _response.error.statusCode,
|
|
317
|
+
body: _response.error.body,
|
|
318
|
+
rawResponse: _response.rawResponse,
|
|
319
|
+
});
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/workflows/{id}");
|
|
323
|
+
});
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* Update a workflow's draft. You can update the name, the steps, or both.
|
|
327
|
+
*
|
|
328
|
+
* 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.
|
|
329
|
+
*
|
|
330
|
+
* @param {string} id - The ID of the workflow to update.
|
|
331
|
+
* @param {Extend.WorkflowsUpdateRequest} request
|
|
332
|
+
* @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
333
|
+
*
|
|
334
|
+
* @throws {@link Extend.BadRequestError}
|
|
335
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
336
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
337
|
+
* @throws {@link Extend.ForbiddenError}
|
|
338
|
+
* @throws {@link Extend.NotFoundError}
|
|
339
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
340
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
341
|
+
* @throws {@link Extend.InternalServerError}
|
|
342
|
+
*
|
|
343
|
+
* @example
|
|
344
|
+
* await client.workflows.update("workflow_abc123", {
|
|
345
|
+
* name: "Updated Invoice Processing"
|
|
346
|
+
* })
|
|
347
|
+
*
|
|
348
|
+
* @example
|
|
349
|
+
* await client.workflows.update("workflow_abc123", {
|
|
350
|
+
* steps: [{
|
|
351
|
+
* type: "TRIGGER",
|
|
352
|
+
* name: "name"
|
|
353
|
+
* }, {
|
|
354
|
+
* type: "PARSE",
|
|
355
|
+
* name: "name"
|
|
356
|
+
* }]
|
|
357
|
+
* })
|
|
358
|
+
*/
|
|
359
|
+
update(id, request = {}, requestOptions) {
|
|
360
|
+
return core.HttpResponsePromise.fromPromise(this.__update(id, request, requestOptions));
|
|
361
|
+
}
|
|
362
|
+
__update(id_1) {
|
|
363
|
+
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
|
|
364
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
365
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
366
|
+
const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
367
|
+
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
368
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, `workflows/${core.url.encodePathParam(id)}`),
|
|
369
|
+
method: "POST",
|
|
370
|
+
headers: _headers,
|
|
371
|
+
contentType: "application/json",
|
|
372
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
373
|
+
requestType: "json",
|
|
374
|
+
body: request,
|
|
375
|
+
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 300) * 1000,
|
|
376
|
+
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
377
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
378
|
+
fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
|
|
379
|
+
logging: this._options.logging,
|
|
380
|
+
});
|
|
381
|
+
if (_response.ok) {
|
|
382
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
383
|
+
}
|
|
384
|
+
if (_response.error.reason === "status-code") {
|
|
385
|
+
switch (_response.error.statusCode) {
|
|
386
|
+
case 400:
|
|
387
|
+
throw new Extend.BadRequestError(_response.error.body, _response.rawResponse);
|
|
388
|
+
case 401:
|
|
389
|
+
throw new Extend.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
390
|
+
case 402:
|
|
391
|
+
throw new Extend.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
392
|
+
case 403:
|
|
393
|
+
throw new Extend.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
394
|
+
case 404:
|
|
395
|
+
throw new Extend.NotFoundError(_response.error.body, _response.rawResponse);
|
|
396
|
+
case 422:
|
|
397
|
+
throw new Extend.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
398
|
+
case 429:
|
|
399
|
+
throw new Extend.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
400
|
+
case 500:
|
|
401
|
+
throw new Extend.InternalServerError(_response.error.body, _response.rawResponse);
|
|
402
|
+
default:
|
|
403
|
+
throw new errors.ExtendError({
|
|
404
|
+
statusCode: _response.error.statusCode,
|
|
405
|
+
body: _response.error.body,
|
|
406
|
+
rawResponse: _response.rawResponse,
|
|
407
|
+
});
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/workflows/{id}");
|
|
411
|
+
});
|
|
412
|
+
}
|
|
134
413
|
}
|
|
135
414
|
exports.WorkflowsClient = WorkflowsClient;
|
|
@@ -1,10 +1,61 @@
|
|
|
1
|
+
import type * as Extend from "../../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
4
5
|
* name: "Invoice Processing"
|
|
5
6
|
* }
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* {
|
|
10
|
+
* name: "Invoice Processing",
|
|
11
|
+
* steps: [{
|
|
12
|
+
* type: "TRIGGER",
|
|
13
|
+
* name: "name"
|
|
14
|
+
* }, {
|
|
15
|
+
* type: "PARSE",
|
|
16
|
+
* name: "name"
|
|
17
|
+
* }, {
|
|
18
|
+
* type: "EXTRACT",
|
|
19
|
+
* name: "name"
|
|
20
|
+
* }, {
|
|
21
|
+
* type: "HUMAN_REVIEW",
|
|
22
|
+
* name: "name"
|
|
23
|
+
* }]
|
|
24
|
+
* }
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* {
|
|
28
|
+
* name: "Document Routing",
|
|
29
|
+
* steps: [{
|
|
30
|
+
* type: "TRIGGER",
|
|
31
|
+
* name: "name"
|
|
32
|
+
* }, {
|
|
33
|
+
* type: "PARSE",
|
|
34
|
+
* name: "name"
|
|
35
|
+
* }, {
|
|
36
|
+
* type: "CLASSIFY",
|
|
37
|
+
* name: "name"
|
|
38
|
+
* }, {
|
|
39
|
+
* type: "EXTRACT",
|
|
40
|
+
* name: "name"
|
|
41
|
+
* }, {
|
|
42
|
+
* type: "EXTRACT",
|
|
43
|
+
* name: "name"
|
|
44
|
+
* }, {
|
|
45
|
+
* type: "HUMAN_REVIEW",
|
|
46
|
+
* name: "name"
|
|
47
|
+
* }]
|
|
48
|
+
* }
|
|
6
49
|
*/
|
|
7
50
|
export interface WorkflowsCreateRequest {
|
|
8
|
-
/** The name of the workflow */
|
|
51
|
+
/** The name of the workflow. */
|
|
9
52
|
name: string;
|
|
53
|
+
/**
|
|
54
|
+
* The steps that define the workflow's processing graph. Each step has a `type`, a unique `name`, and optional `next` entries that define routing to downstream steps.
|
|
55
|
+
*
|
|
56
|
+
* When omitted, the workflow is created with default steps (`TRIGGER` → `PARSE`). The default steps may change in the future.
|
|
57
|
+
*
|
|
58
|
+
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api) for step definitions, branching patterns, and examples.
|
|
59
|
+
*/
|
|
60
|
+
steps?: Extend.WorkflowStepDefinition[];
|
|
10
61
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type * as Extend from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface WorkflowsListRequest {
|
|
9
|
+
nextPageToken?: Extend.NextPageToken;
|
|
10
|
+
maxPageSize?: Extend.MaxPageSize;
|
|
11
|
+
sortBy?: Extend.SortBy;
|
|
12
|
+
sortDir?: Extend.SortDir;
|
|
13
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type * as Extend from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* name: "Updated Invoice Processing"
|
|
6
|
+
* }
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* {
|
|
10
|
+
* steps: [{
|
|
11
|
+
* type: "TRIGGER",
|
|
12
|
+
* name: "name"
|
|
13
|
+
* }, {
|
|
14
|
+
* type: "PARSE",
|
|
15
|
+
* name: "name"
|
|
16
|
+
* }]
|
|
17
|
+
* }
|
|
18
|
+
*/
|
|
19
|
+
export interface WorkflowsUpdateRequest {
|
|
20
|
+
/** The new name for the workflow. */
|
|
21
|
+
name?: string;
|
|
22
|
+
/**
|
|
23
|
+
* The new step definitions for the draft version. Replaces all existing draft steps.
|
|
24
|
+
*
|
|
25
|
+
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api) for step definitions, branching patterns, and examples.
|
|
26
|
+
*/
|
|
27
|
+
steps?: Extend.WorkflowStepDefinition[];
|
|
28
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./WorkflowsListResponse";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./WorkflowsListResponse"), exports);
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Details for barcode blocks
|
|
3
|
+
*/
|
|
4
|
+
export interface BarcodeDetails {
|
|
5
|
+
/** Indicates this is a barcode details object */
|
|
6
|
+
type: "barcode_details";
|
|
7
|
+
/** URL to the clipped/segmented barcode image. Only set if the option `imageClippingEnabled` in blockOptions.barcodes is `true`. */
|
|
8
|
+
imageUrl?: string;
|
|
9
|
+
/** The decoded value of the barcode or QR code. Only set if the option `readingEnabled` in blockOptions.barcodes is `true`. */
|
|
10
|
+
decodedValue?: string;
|
|
11
|
+
/** The format of the barcode (e.g., "QRCode", "Code128", "DataMatrix", "EAN13"). */
|
|
12
|
+
format?: string;
|
|
13
|
+
}
|
package/api/types/Block.d.ts
CHANGED
|
@@ -12,9 +12,14 @@ export interface Block {
|
|
|
12
12
|
* * `"heading"` - Section or document headings
|
|
13
13
|
* * `"section_heading"` - Subsection headings
|
|
14
14
|
* * `"table"` - Tabular data with rows and columns
|
|
15
|
+
* * `"figure"` - Images, charts, diagrams, or logos
|
|
15
16
|
* * `"table_head"` - Table header cells
|
|
16
17
|
* * `"table_cell"` - Table body cells
|
|
17
|
-
* * `"
|
|
18
|
+
* * `"key_value"` - Key-value pairs (e.g., form regions, key-val groups, etc)
|
|
19
|
+
* * `"page_number"` - Page number indicators
|
|
20
|
+
* * `"barcode"` - Barcodes and QR codes
|
|
21
|
+
* * `"header"` - Page headers
|
|
22
|
+
* * `"footer"` - Page footers
|
|
18
23
|
*/
|
|
19
24
|
type: Extend.BlockType;
|
|
20
25
|
/** The textual content of the block formatted based on the target format. */
|
|
@@ -2,4 +2,4 @@ import type * as Extend from "../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* Additional details specific to the block type. The schema depends on the block type.
|
|
4
4
|
*/
|
|
5
|
-
export type BlockDetails = Extend.TableDetails | Extend.TableCellDetails | Extend.FigureDetails | Extend.EmptyBlockDetails;
|
|
5
|
+
export type BlockDetails = Extend.TableDetails | Extend.TableCellDetails | Extend.FigureDetails | Extend.BarcodeDetails | Extend.KeyValueDetails | Extend.EmptyBlockDetails;
|
|
@@ -5,4 +5,6 @@ import type * as Extend from "../index";
|
|
|
5
5
|
export interface BlockMetadata {
|
|
6
6
|
/** Information about the page this block appears on. */
|
|
7
7
|
page?: Extend.BlockMetadataPage;
|
|
8
|
+
/** Text direction for this block's content ("ltr" for left-to-right, "rtl" for right-to-left). */
|
|
9
|
+
textDirection?: Extend.BlockMetadataTextDirection;
|
|
8
10
|
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/** Text direction for this block's content ("ltr" for left-to-right, "rtl" for right-to-left). */
|
|
2
|
+
export declare const BlockMetadataTextDirection: {
|
|
3
|
+
readonly Ltr: "ltr";
|
|
4
|
+
readonly Rtl: "rtl";
|
|
5
|
+
};
|
|
6
|
+
export type BlockMetadataTextDirection = (typeof BlockMetadataTextDirection)[keyof typeof BlockMetadataTextDirection] | 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.BlockMetadataTextDirection = void 0;
|
|
5
|
+
/** Text direction for this block's content ("ltr" for left-to-right, "rtl" for right-to-left). */
|
|
6
|
+
exports.BlockMetadataTextDirection = {
|
|
7
|
+
Ltr: "ltr",
|
|
8
|
+
Rtl: "rtl",
|
|
9
|
+
};
|
package/api/types/BlockType.d.ts
CHANGED
|
@@ -4,9 +4,14 @@
|
|
|
4
4
|
* * `"heading"` - Section or document headings
|
|
5
5
|
* * `"section_heading"` - Subsection headings
|
|
6
6
|
* * `"table"` - Tabular data with rows and columns
|
|
7
|
+
* * `"figure"` - Images, charts, diagrams, or logos
|
|
7
8
|
* * `"table_head"` - Table header cells
|
|
8
9
|
* * `"table_cell"` - Table body cells
|
|
9
|
-
* * `"
|
|
10
|
+
* * `"key_value"` - Key-value pairs (e.g., form regions, key-val groups, etc)
|
|
11
|
+
* * `"page_number"` - Page number indicators
|
|
12
|
+
* * `"barcode"` - Barcodes and QR codes
|
|
13
|
+
* * `"header"` - Page headers
|
|
14
|
+
* * `"footer"` - Page footers
|
|
10
15
|
*/
|
|
11
16
|
export declare const BlockType: {
|
|
12
17
|
readonly Text: "text";
|
|
@@ -16,5 +21,10 @@ export declare const BlockType: {
|
|
|
16
21
|
readonly Figure: "figure";
|
|
17
22
|
readonly TableHead: "table_head";
|
|
18
23
|
readonly TableCell: "table_cell";
|
|
24
|
+
readonly KeyValue: "key_value";
|
|
25
|
+
readonly PageNumber: "page_number";
|
|
26
|
+
readonly Barcode: "barcode";
|
|
27
|
+
readonly Header: "header";
|
|
28
|
+
readonly Footer: "footer";
|
|
19
29
|
};
|
|
20
30
|
export type BlockType = (typeof BlockType)[keyof typeof BlockType] | string;
|
package/api/types/BlockType.js
CHANGED
|
@@ -8,9 +8,14 @@ exports.BlockType = void 0;
|
|
|
8
8
|
* * `"heading"` - Section or document headings
|
|
9
9
|
* * `"section_heading"` - Subsection headings
|
|
10
10
|
* * `"table"` - Tabular data with rows and columns
|
|
11
|
+
* * `"figure"` - Images, charts, diagrams, or logos
|
|
11
12
|
* * `"table_head"` - Table header cells
|
|
12
13
|
* * `"table_cell"` - Table body cells
|
|
13
|
-
* * `"
|
|
14
|
+
* * `"key_value"` - Key-value pairs (e.g., form regions, key-val groups, etc)
|
|
15
|
+
* * `"page_number"` - Page number indicators
|
|
16
|
+
* * `"barcode"` - Barcodes and QR codes
|
|
17
|
+
* * `"header"` - Page headers
|
|
18
|
+
* * `"footer"` - Page footers
|
|
14
19
|
*/
|
|
15
20
|
exports.BlockType = {
|
|
16
21
|
Text: "text",
|
|
@@ -20,4 +25,9 @@ exports.BlockType = {
|
|
|
20
25
|
Figure: "figure",
|
|
21
26
|
TableHead: "table_head",
|
|
22
27
|
TableCell: "table_cell",
|
|
28
|
+
KeyValue: "key_value",
|
|
29
|
+
PageNumber: "page_number",
|
|
30
|
+
Barcode: "barcode",
|
|
31
|
+
Header: "header",
|
|
32
|
+
Footer: "footer",
|
|
23
33
|
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A next entry for `CLASSIFY` and `SPLIT` steps. Routes based on the classification result.
|
|
3
|
+
*
|
|
4
|
+
* 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.
|
|
5
|
+
*/
|
|
6
|
+
export interface ClassificationNextEntry {
|
|
7
|
+
/** The name of the target step. */
|
|
8
|
+
step: string;
|
|
9
|
+
/** Must match a classification `id` from the referenced classifier's or splitter's configuration (e.g. `"cls_invoice"`). Classification IDs are stable across renames — if a classification type is renamed, the ID stays the same and routing continues to work. */
|
|
10
|
+
classificationId: string;
|
|
11
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A reference to a classifier.
|
|
3
|
+
*/
|
|
4
|
+
export interface ClassifierRef {
|
|
5
|
+
/** The classifier ID. */
|
|
6
|
+
id: string;
|
|
7
|
+
/** The classifier 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
|
+
}
|