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
package/reference.md
CHANGED
|
@@ -563,7 +563,7 @@ Example: `"file_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
563
563
|
</dl>
|
|
564
564
|
</details>
|
|
565
565
|
|
|
566
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id) -> Extend.FilesDeleteResponse</code></summary>
|
|
566
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id, { ...params }) -> Extend.FilesDeleteResponse</code></summary>
|
|
567
567
|
<dl>
|
|
568
568
|
<dd>
|
|
569
569
|
|
|
@@ -620,6 +620,14 @@ Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
620
620
|
<dl>
|
|
621
621
|
<dd>
|
|
622
622
|
|
|
623
|
+
**request:** `Extend.FilesDeleteRequest`
|
|
624
|
+
|
|
625
|
+
</dd>
|
|
626
|
+
</dl>
|
|
627
|
+
|
|
628
|
+
<dl>
|
|
629
|
+
<dd>
|
|
630
|
+
|
|
623
631
|
**requestOptions:** `FilesClient.RequestOptions`
|
|
624
632
|
|
|
625
633
|
</dd>
|
|
@@ -861,7 +869,7 @@ Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
861
869
|
</dl>
|
|
862
870
|
</details>
|
|
863
871
|
|
|
864
|
-
<details><summary><code>client.parseRuns.<a href="/src/api/resources/parseRuns/client/Client.ts">delete</a>(id) -> Extend.ParseRunsDeleteResponse</code></summary>
|
|
872
|
+
<details><summary><code>client.parseRuns.<a href="/src/api/resources/parseRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.ParseRunsDeleteResponse</code></summary>
|
|
865
873
|
<dl>
|
|
866
874
|
<dd>
|
|
867
875
|
|
|
@@ -918,6 +926,14 @@ Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
918
926
|
<dl>
|
|
919
927
|
<dd>
|
|
920
928
|
|
|
929
|
+
**request:** `Extend.ParseRunsDeleteRequest`
|
|
930
|
+
|
|
931
|
+
</dd>
|
|
932
|
+
</dl>
|
|
933
|
+
|
|
934
|
+
<dl>
|
|
935
|
+
<dd>
|
|
936
|
+
|
|
921
937
|
**requestOptions:** `ParseRunsClient.RequestOptions`
|
|
922
938
|
|
|
923
939
|
</dd>
|
|
@@ -1008,7 +1024,7 @@ await client.editRuns.create({
|
|
|
1008
1024
|
</dl>
|
|
1009
1025
|
</details>
|
|
1010
1026
|
|
|
1011
|
-
<details><summary><code>client.editRuns.<a href="/src/api/resources/editRuns/client/Client.ts">retrieve</a>(id) -> Extend.EditRun</code></summary>
|
|
1027
|
+
<details><summary><code>client.editRuns.<a href="/src/api/resources/editRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.EditRun</code></summary>
|
|
1012
1028
|
<dl>
|
|
1013
1029
|
<dd>
|
|
1014
1030
|
|
|
@@ -1065,6 +1081,14 @@ Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1065
1081
|
<dl>
|
|
1066
1082
|
<dd>
|
|
1067
1083
|
|
|
1084
|
+
**request:** `Extend.EditRunsRetrieveRequest`
|
|
1085
|
+
|
|
1086
|
+
</dd>
|
|
1087
|
+
</dl>
|
|
1088
|
+
|
|
1089
|
+
<dl>
|
|
1090
|
+
<dd>
|
|
1091
|
+
|
|
1068
1092
|
**requestOptions:** `EditRunsClient.RequestOptions`
|
|
1069
1093
|
|
|
1070
1094
|
</dd>
|
|
@@ -1077,7 +1101,7 @@ Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1077
1101
|
</dl>
|
|
1078
1102
|
</details>
|
|
1079
1103
|
|
|
1080
|
-
<details><summary><code>client.editRuns.<a href="/src/api/resources/editRuns/client/Client.ts">delete</a>(id) -> Extend.EditRunsDeleteResponse</code></summary>
|
|
1104
|
+
<details><summary><code>client.editRuns.<a href="/src/api/resources/editRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.EditRunsDeleteResponse</code></summary>
|
|
1081
1105
|
<dl>
|
|
1082
1106
|
<dd>
|
|
1083
1107
|
|
|
@@ -1134,6 +1158,14 @@ Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1134
1158
|
<dl>
|
|
1135
1159
|
<dd>
|
|
1136
1160
|
|
|
1161
|
+
**request:** `Extend.EditRunsDeleteRequest`
|
|
1162
|
+
|
|
1163
|
+
</dd>
|
|
1164
|
+
</dl>
|
|
1165
|
+
|
|
1166
|
+
<dl>
|
|
1167
|
+
<dd>
|
|
1168
|
+
|
|
1137
1169
|
**requestOptions:** `EditRunsClient.RequestOptions`
|
|
1138
1170
|
|
|
1139
1171
|
</dd>
|
|
@@ -1142,6 +1174,86 @@ Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1142
1174
|
</dl>
|
|
1143
1175
|
|
|
1144
1176
|
|
|
1177
|
+
</dd>
|
|
1178
|
+
</dl>
|
|
1179
|
+
</details>
|
|
1180
|
+
|
|
1181
|
+
## EditSchemas
|
|
1182
|
+
<details><summary><code>client.editSchemas.<a href="/src/api/resources/editSchemas/client/Client.ts">generate</a>({ ...params }) -> Extend.EditSchemaGenerationResponse</code></summary>
|
|
1183
|
+
<dl>
|
|
1184
|
+
<dd>
|
|
1185
|
+
|
|
1186
|
+
#### 📝 Description
|
|
1187
|
+
|
|
1188
|
+
<dl>
|
|
1189
|
+
<dd>
|
|
1190
|
+
|
|
1191
|
+
<dl>
|
|
1192
|
+
<dd>
|
|
1193
|
+
|
|
1194
|
+
Detect fields in a PDF form and synchronously return an edit schema payload.
|
|
1195
|
+
|
|
1196
|
+
Use this endpoint when you want Extend to bootstrap an `EditRootJSON` schema from an existing form, optionally mapping an existing schema onto the detected fields.
|
|
1197
|
+
|
|
1198
|
+
This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.
|
|
1199
|
+
|
|
1200
|
+
For more details, see the [Generate Edit Schema guide](https://docs.extend.ai/2026-02-09/product/editing/generate-edit-schema) and the [Edit File guide](https://docs.extend.ai/2026-02-09/product/editing/edit).
|
|
1201
|
+
</dd>
|
|
1202
|
+
</dl>
|
|
1203
|
+
</dd>
|
|
1204
|
+
</dl>
|
|
1205
|
+
|
|
1206
|
+
#### 🔌 Usage
|
|
1207
|
+
|
|
1208
|
+
<dl>
|
|
1209
|
+
<dd>
|
|
1210
|
+
|
|
1211
|
+
<dl>
|
|
1212
|
+
<dd>
|
|
1213
|
+
|
|
1214
|
+
```typescript
|
|
1215
|
+
await client.editSchemas.generate({
|
|
1216
|
+
file: {
|
|
1217
|
+
url: "https://example.com/form.pdf"
|
|
1218
|
+
},
|
|
1219
|
+
config: {
|
|
1220
|
+
instructions: "Detect the form fields and use human-readable field names.",
|
|
1221
|
+
advancedOptions: {
|
|
1222
|
+
radioEnumsEnabled: true
|
|
1223
|
+
}
|
|
1224
|
+
}
|
|
1225
|
+
});
|
|
1226
|
+
|
|
1227
|
+
```
|
|
1228
|
+
</dd>
|
|
1229
|
+
</dl>
|
|
1230
|
+
</dd>
|
|
1231
|
+
</dl>
|
|
1232
|
+
|
|
1233
|
+
#### ⚙️ Parameters
|
|
1234
|
+
|
|
1235
|
+
<dl>
|
|
1236
|
+
<dd>
|
|
1237
|
+
|
|
1238
|
+
<dl>
|
|
1239
|
+
<dd>
|
|
1240
|
+
|
|
1241
|
+
**request:** `Extend.EditSchemasGenerateRequest`
|
|
1242
|
+
|
|
1243
|
+
</dd>
|
|
1244
|
+
</dl>
|
|
1245
|
+
|
|
1246
|
+
<dl>
|
|
1247
|
+
<dd>
|
|
1248
|
+
|
|
1249
|
+
**requestOptions:** `EditSchemasClient.RequestOptions`
|
|
1250
|
+
|
|
1251
|
+
</dd>
|
|
1252
|
+
</dl>
|
|
1253
|
+
</dd>
|
|
1254
|
+
</dl>
|
|
1255
|
+
|
|
1256
|
+
|
|
1145
1257
|
</dd>
|
|
1146
1258
|
</dl>
|
|
1147
1259
|
</details>
|
|
@@ -1286,7 +1398,7 @@ await client.extractRuns.create({
|
|
|
1286
1398
|
</dl>
|
|
1287
1399
|
</details>
|
|
1288
1400
|
|
|
1289
|
-
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">retrieve</a>(id) -> Extend.ExtractRun</code></summary>
|
|
1401
|
+
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.ExtractRun</code></summary>
|
|
1290
1402
|
<dl>
|
|
1291
1403
|
<dd>
|
|
1292
1404
|
|
|
@@ -1343,6 +1455,14 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1343
1455
|
<dl>
|
|
1344
1456
|
<dd>
|
|
1345
1457
|
|
|
1458
|
+
**request:** `Extend.ExtractRunsRetrieveRequest`
|
|
1459
|
+
|
|
1460
|
+
</dd>
|
|
1461
|
+
</dl>
|
|
1462
|
+
|
|
1463
|
+
<dl>
|
|
1464
|
+
<dd>
|
|
1465
|
+
|
|
1346
1466
|
**requestOptions:** `ExtractRunsClient.RequestOptions`
|
|
1347
1467
|
|
|
1348
1468
|
</dd>
|
|
@@ -1355,7 +1475,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1355
1475
|
</dl>
|
|
1356
1476
|
</details>
|
|
1357
1477
|
|
|
1358
|
-
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">delete</a>(id) -> Extend.ExtractRunsDeleteResponse</code></summary>
|
|
1478
|
+
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.ExtractRunsDeleteResponse</code></summary>
|
|
1359
1479
|
<dl>
|
|
1360
1480
|
<dd>
|
|
1361
1481
|
|
|
@@ -1408,6 +1528,14 @@ await client.extractRuns.delete("id");
|
|
|
1408
1528
|
<dl>
|
|
1409
1529
|
<dd>
|
|
1410
1530
|
|
|
1531
|
+
**request:** `Extend.ExtractRunsDeleteRequest`
|
|
1532
|
+
|
|
1533
|
+
</dd>
|
|
1534
|
+
</dl>
|
|
1535
|
+
|
|
1536
|
+
<dl>
|
|
1537
|
+
<dd>
|
|
1538
|
+
|
|
1411
1539
|
**requestOptions:** `ExtractRunsClient.RequestOptions`
|
|
1412
1540
|
|
|
1413
1541
|
</dd>
|
|
@@ -1420,7 +1548,7 @@ await client.extractRuns.delete("id");
|
|
|
1420
1548
|
</dl>
|
|
1421
1549
|
</details>
|
|
1422
1550
|
|
|
1423
|
-
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">cancel</a>(id) -> Extend.ExtractRun</code></summary>
|
|
1551
|
+
<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.ExtractRun</code></summary>
|
|
1424
1552
|
<dl>
|
|
1425
1553
|
<dd>
|
|
1426
1554
|
|
|
@@ -1477,6 +1605,14 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1477
1605
|
<dl>
|
|
1478
1606
|
<dd>
|
|
1479
1607
|
|
|
1608
|
+
**request:** `Extend.ExtractRunsCancelRequest`
|
|
1609
|
+
|
|
1610
|
+
</dd>
|
|
1611
|
+
</dl>
|
|
1612
|
+
|
|
1613
|
+
<dl>
|
|
1614
|
+
<dd>
|
|
1615
|
+
|
|
1480
1616
|
**requestOptions:** `ExtractRunsClient.RequestOptions`
|
|
1481
1617
|
|
|
1482
1618
|
</dd>
|
|
@@ -1641,7 +1777,7 @@ await client.extractors.create({
|
|
|
1641
1777
|
</dl>
|
|
1642
1778
|
</details>
|
|
1643
1779
|
|
|
1644
|
-
<details><summary><code>client.extractors.<a href="/src/api/resources/extractors/client/Client.ts">retrieve</a>(id) -> Extend.Extractor</code></summary>
|
|
1780
|
+
<details><summary><code>client.extractors.<a href="/src/api/resources/extractors/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.Extractor</code></summary>
|
|
1645
1781
|
<dl>
|
|
1646
1782
|
<dd>
|
|
1647
1783
|
|
|
@@ -1696,6 +1832,14 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1696
1832
|
<dl>
|
|
1697
1833
|
<dd>
|
|
1698
1834
|
|
|
1835
|
+
**request:** `Extend.ExtractorsRetrieveRequest`
|
|
1836
|
+
|
|
1837
|
+
</dd>
|
|
1838
|
+
</dl>
|
|
1839
|
+
|
|
1840
|
+
<dl>
|
|
1841
|
+
<dd>
|
|
1842
|
+
|
|
1699
1843
|
**requestOptions:** `ExtractorsClient.RequestOptions`
|
|
1700
1844
|
|
|
1701
1845
|
</dd>
|
|
@@ -1945,7 +2089,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1945
2089
|
</dl>
|
|
1946
2090
|
</details>
|
|
1947
2091
|
|
|
1948
|
-
<details><summary><code>client.extractorVersions.<a href="/src/api/resources/extractorVersions/client/Client.ts">retrieve</a>(extractorId, versionId) -> Extend.ExtractorVersion</code></summary>
|
|
2092
|
+
<details><summary><code>client.extractorVersions.<a href="/src/api/resources/extractorVersions/client/Client.ts">retrieve</a>(extractorId, versionId, { ...params }) -> Extend.ExtractorVersion</code></summary>
|
|
1949
2093
|
<dl>
|
|
1950
2094
|
<dd>
|
|
1951
2095
|
|
|
@@ -2012,6 +2156,14 @@ Example: `"extv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
2012
2156
|
<dl>
|
|
2013
2157
|
<dd>
|
|
2014
2158
|
|
|
2159
|
+
**request:** `Extend.ExtractorVersionsRetrieveRequest`
|
|
2160
|
+
|
|
2161
|
+
</dd>
|
|
2162
|
+
</dl>
|
|
2163
|
+
|
|
2164
|
+
<dl>
|
|
2165
|
+
<dd>
|
|
2166
|
+
|
|
2015
2167
|
**requestOptions:** `ExtractorVersionsClient.RequestOptions`
|
|
2016
2168
|
|
|
2017
2169
|
</dd>
|
|
@@ -2164,7 +2316,7 @@ await client.classifyRuns.create({
|
|
|
2164
2316
|
</dl>
|
|
2165
2317
|
</details>
|
|
2166
2318
|
|
|
2167
|
-
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">retrieve</a>(id) -> Extend.ClassifyRun</code></summary>
|
|
2319
|
+
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.ClassifyRun</code></summary>
|
|
2168
2320
|
<dl>
|
|
2169
2321
|
<dd>
|
|
2170
2322
|
|
|
@@ -2221,6 +2373,14 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2221
2373
|
<dl>
|
|
2222
2374
|
<dd>
|
|
2223
2375
|
|
|
2376
|
+
**request:** `Extend.ClassifyRunsRetrieveRequest`
|
|
2377
|
+
|
|
2378
|
+
</dd>
|
|
2379
|
+
</dl>
|
|
2380
|
+
|
|
2381
|
+
<dl>
|
|
2382
|
+
<dd>
|
|
2383
|
+
|
|
2224
2384
|
**requestOptions:** `ClassifyRunsClient.RequestOptions`
|
|
2225
2385
|
|
|
2226
2386
|
</dd>
|
|
@@ -2233,7 +2393,7 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2233
2393
|
</dl>
|
|
2234
2394
|
</details>
|
|
2235
2395
|
|
|
2236
|
-
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">delete</a>(id) -> Extend.ClassifyRunsDeleteResponse</code></summary>
|
|
2396
|
+
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.ClassifyRunsDeleteResponse</code></summary>
|
|
2237
2397
|
<dl>
|
|
2238
2398
|
<dd>
|
|
2239
2399
|
|
|
@@ -2286,6 +2446,14 @@ await client.classifyRuns.delete("id");
|
|
|
2286
2446
|
<dl>
|
|
2287
2447
|
<dd>
|
|
2288
2448
|
|
|
2449
|
+
**request:** `Extend.ClassifyRunsDeleteRequest`
|
|
2450
|
+
|
|
2451
|
+
</dd>
|
|
2452
|
+
</dl>
|
|
2453
|
+
|
|
2454
|
+
<dl>
|
|
2455
|
+
<dd>
|
|
2456
|
+
|
|
2289
2457
|
**requestOptions:** `ClassifyRunsClient.RequestOptions`
|
|
2290
2458
|
|
|
2291
2459
|
</dd>
|
|
@@ -2298,7 +2466,7 @@ await client.classifyRuns.delete("id");
|
|
|
2298
2466
|
</dl>
|
|
2299
2467
|
</details>
|
|
2300
2468
|
|
|
2301
|
-
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">cancel</a>(id) -> Extend.ClassifyRun</code></summary>
|
|
2469
|
+
<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.ClassifyRun</code></summary>
|
|
2302
2470
|
<dl>
|
|
2303
2471
|
<dd>
|
|
2304
2472
|
|
|
@@ -2355,6 +2523,14 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2355
2523
|
<dl>
|
|
2356
2524
|
<dd>
|
|
2357
2525
|
|
|
2526
|
+
**request:** `Extend.ClassifyRunsCancelRequest`
|
|
2527
|
+
|
|
2528
|
+
</dd>
|
|
2529
|
+
</dl>
|
|
2530
|
+
|
|
2531
|
+
<dl>
|
|
2532
|
+
<dd>
|
|
2533
|
+
|
|
2358
2534
|
**requestOptions:** `ClassifyRunsClient.RequestOptions`
|
|
2359
2535
|
|
|
2360
2536
|
</dd>
|
|
@@ -2515,7 +2691,7 @@ await client.classifiers.create({
|
|
|
2515
2691
|
</dl>
|
|
2516
2692
|
</details>
|
|
2517
2693
|
|
|
2518
|
-
<details><summary><code>client.classifiers.<a href="/src/api/resources/classifiers/client/Client.ts">retrieve</a>(id) -> Extend.Classifier</code></summary>
|
|
2694
|
+
<details><summary><code>client.classifiers.<a href="/src/api/resources/classifiers/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.Classifier</code></summary>
|
|
2519
2695
|
<dl>
|
|
2520
2696
|
<dd>
|
|
2521
2697
|
|
|
@@ -2570,6 +2746,14 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2570
2746
|
<dl>
|
|
2571
2747
|
<dd>
|
|
2572
2748
|
|
|
2749
|
+
**request:** `Extend.ClassifiersRetrieveRequest`
|
|
2750
|
+
|
|
2751
|
+
</dd>
|
|
2752
|
+
</dl>
|
|
2753
|
+
|
|
2754
|
+
<dl>
|
|
2755
|
+
<dd>
|
|
2756
|
+
|
|
2573
2757
|
**requestOptions:** `ClassifiersClient.RequestOptions`
|
|
2574
2758
|
|
|
2575
2759
|
</dd>
|
|
@@ -2819,7 +3003,7 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2819
3003
|
</dl>
|
|
2820
3004
|
</details>
|
|
2821
3005
|
|
|
2822
|
-
<details><summary><code>client.classifierVersions.<a href="/src/api/resources/classifierVersions/client/Client.ts">retrieve</a>(classifierId, versionId) -> Extend.ClassifierVersion</code></summary>
|
|
3006
|
+
<details><summary><code>client.classifierVersions.<a href="/src/api/resources/classifierVersions/client/Client.ts">retrieve</a>(classifierId, versionId, { ...params }) -> Extend.ClassifierVersion</code></summary>
|
|
2823
3007
|
<dl>
|
|
2824
3008
|
<dd>
|
|
2825
3009
|
|
|
@@ -2886,6 +3070,14 @@ Example: `"clsv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
2886
3070
|
<dl>
|
|
2887
3071
|
<dd>
|
|
2888
3072
|
|
|
3073
|
+
**request:** `Extend.ClassifierVersionsRetrieveRequest`
|
|
3074
|
+
|
|
3075
|
+
</dd>
|
|
3076
|
+
</dl>
|
|
3077
|
+
|
|
3078
|
+
<dl>
|
|
3079
|
+
<dd>
|
|
3080
|
+
|
|
2889
3081
|
**requestOptions:** `ClassifierVersionsClient.RequestOptions`
|
|
2890
3082
|
|
|
2891
3083
|
</dd>
|
|
@@ -3038,7 +3230,7 @@ await client.splitRuns.create({
|
|
|
3038
3230
|
</dl>
|
|
3039
3231
|
</details>
|
|
3040
3232
|
|
|
3041
|
-
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">retrieve</a>(id) -> Extend.SplitRun</code></summary>
|
|
3233
|
+
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.SplitRun</code></summary>
|
|
3042
3234
|
<dl>
|
|
3043
3235
|
<dd>
|
|
3044
3236
|
|
|
@@ -3095,6 +3287,14 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3095
3287
|
<dl>
|
|
3096
3288
|
<dd>
|
|
3097
3289
|
|
|
3290
|
+
**request:** `Extend.SplitRunsRetrieveRequest`
|
|
3291
|
+
|
|
3292
|
+
</dd>
|
|
3293
|
+
</dl>
|
|
3294
|
+
|
|
3295
|
+
<dl>
|
|
3296
|
+
<dd>
|
|
3297
|
+
|
|
3098
3298
|
**requestOptions:** `SplitRunsClient.RequestOptions`
|
|
3099
3299
|
|
|
3100
3300
|
</dd>
|
|
@@ -3107,7 +3307,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3107
3307
|
</dl>
|
|
3108
3308
|
</details>
|
|
3109
3309
|
|
|
3110
|
-
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">delete</a>(id) -> Extend.SplitRunsDeleteResponse</code></summary>
|
|
3310
|
+
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.SplitRunsDeleteResponse</code></summary>
|
|
3111
3311
|
<dl>
|
|
3112
3312
|
<dd>
|
|
3113
3313
|
|
|
@@ -3160,6 +3360,14 @@ await client.splitRuns.delete("id");
|
|
|
3160
3360
|
<dl>
|
|
3161
3361
|
<dd>
|
|
3162
3362
|
|
|
3363
|
+
**request:** `Extend.SplitRunsDeleteRequest`
|
|
3364
|
+
|
|
3365
|
+
</dd>
|
|
3366
|
+
</dl>
|
|
3367
|
+
|
|
3368
|
+
<dl>
|
|
3369
|
+
<dd>
|
|
3370
|
+
|
|
3163
3371
|
**requestOptions:** `SplitRunsClient.RequestOptions`
|
|
3164
3372
|
|
|
3165
3373
|
</dd>
|
|
@@ -3172,7 +3380,7 @@ await client.splitRuns.delete("id");
|
|
|
3172
3380
|
</dl>
|
|
3173
3381
|
</details>
|
|
3174
3382
|
|
|
3175
|
-
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">cancel</a>(id) -> Extend.SplitRun</code></summary>
|
|
3383
|
+
<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.SplitRun</code></summary>
|
|
3176
3384
|
<dl>
|
|
3177
3385
|
<dd>
|
|
3178
3386
|
|
|
@@ -3229,6 +3437,14 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3229
3437
|
<dl>
|
|
3230
3438
|
<dd>
|
|
3231
3439
|
|
|
3440
|
+
**request:** `Extend.SplitRunsCancelRequest`
|
|
3441
|
+
|
|
3442
|
+
</dd>
|
|
3443
|
+
</dl>
|
|
3444
|
+
|
|
3445
|
+
<dl>
|
|
3446
|
+
<dd>
|
|
3447
|
+
|
|
3232
3448
|
**requestOptions:** `SplitRunsClient.RequestOptions`
|
|
3233
3449
|
|
|
3234
3450
|
</dd>
|
|
@@ -3391,7 +3607,7 @@ await client.splitters.create({
|
|
|
3391
3607
|
</dl>
|
|
3392
3608
|
</details>
|
|
3393
3609
|
|
|
3394
|
-
<details><summary><code>client.splitters.<a href="/src/api/resources/splitters/client/Client.ts">retrieve</a>(id) -> Extend.Splitter</code></summary>
|
|
3610
|
+
<details><summary><code>client.splitters.<a href="/src/api/resources/splitters/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.Splitter</code></summary>
|
|
3395
3611
|
<dl>
|
|
3396
3612
|
<dd>
|
|
3397
3613
|
|
|
@@ -3446,6 +3662,14 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3446
3662
|
<dl>
|
|
3447
3663
|
<dd>
|
|
3448
3664
|
|
|
3665
|
+
**request:** `Extend.SplittersRetrieveRequest`
|
|
3666
|
+
|
|
3667
|
+
</dd>
|
|
3668
|
+
</dl>
|
|
3669
|
+
|
|
3670
|
+
<dl>
|
|
3671
|
+
<dd>
|
|
3672
|
+
|
|
3449
3673
|
**requestOptions:** `SplittersClient.RequestOptions`
|
|
3450
3674
|
|
|
3451
3675
|
</dd>
|
|
@@ -3695,7 +3919,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3695
3919
|
</dl>
|
|
3696
3920
|
</details>
|
|
3697
3921
|
|
|
3698
|
-
<details><summary><code>client.splitterVersions.<a href="/src/api/resources/splitterVersions/client/Client.ts">retrieve</a>(splitterId, versionId) -> Extend.SplitterVersion</code></summary>
|
|
3922
|
+
<details><summary><code>client.splitterVersions.<a href="/src/api/resources/splitterVersions/client/Client.ts">retrieve</a>(splitterId, versionId, { ...params }) -> Extend.SplitterVersion</code></summary>
|
|
3699
3923
|
<dl>
|
|
3700
3924
|
<dd>
|
|
3701
3925
|
|
|
@@ -3762,6 +3986,14 @@ Example: `"splv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
3762
3986
|
<dl>
|
|
3763
3987
|
<dd>
|
|
3764
3988
|
|
|
3989
|
+
**request:** `Extend.SplitterVersionsRetrieveRequest`
|
|
3990
|
+
|
|
3991
|
+
</dd>
|
|
3992
|
+
</dl>
|
|
3993
|
+
|
|
3994
|
+
<dl>
|
|
3995
|
+
<dd>
|
|
3996
|
+
|
|
3765
3997
|
**requestOptions:** `SplitterVersionsClient.RequestOptions`
|
|
3766
3998
|
|
|
3767
3999
|
</dd>
|
|
@@ -3775,7 +4007,7 @@ Example: `"splv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
3775
4007
|
</details>
|
|
3776
4008
|
|
|
3777
4009
|
## Workflows
|
|
3778
|
-
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">
|
|
4010
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">list</a>({ ...params }) -> Extend.WorkflowsListResponse</code></summary>
|
|
3779
4011
|
<dl>
|
|
3780
4012
|
<dd>
|
|
3781
4013
|
|
|
@@ -3787,9 +4019,7 @@ Example: `"splv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
3787
4019
|
<dl>
|
|
3788
4020
|
<dd>
|
|
3789
4021
|
|
|
3790
|
-
|
|
3791
|
-
|
|
3792
|
-
This endpoint will create a new workflow in Extend, which can then be configured and deployed. Typically, workflows are created from our UI, however this endpoint can be used to create workflows programmatically. Configuration of the flow still needs to be done in the dashboard.
|
|
4022
|
+
List all workflows. Returns a paginated list of workflow summaries.
|
|
3793
4023
|
</dd>
|
|
3794
4024
|
</dl>
|
|
3795
4025
|
</dd>
|
|
@@ -3804,8 +4034,8 @@ This endpoint will create a new workflow in Extend, which can then be configured
|
|
|
3804
4034
|
<dd>
|
|
3805
4035
|
|
|
3806
4036
|
```typescript
|
|
3807
|
-
await client.workflows.
|
|
3808
|
-
|
|
4037
|
+
await client.workflows.list({
|
|
4038
|
+
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
3809
4039
|
});
|
|
3810
4040
|
|
|
3811
4041
|
```
|
|
@@ -3822,7 +4052,7 @@ await client.workflows.create({
|
|
|
3822
4052
|
<dl>
|
|
3823
4053
|
<dd>
|
|
3824
4054
|
|
|
3825
|
-
**request:** `Extend.
|
|
4055
|
+
**request:** `Extend.WorkflowsListRequest`
|
|
3826
4056
|
|
|
3827
4057
|
</dd>
|
|
3828
4058
|
</dl>
|
|
@@ -3842,8 +4072,7 @@ await client.workflows.create({
|
|
|
3842
4072
|
</dl>
|
|
3843
4073
|
</details>
|
|
3844
4074
|
|
|
3845
|
-
|
|
3846
|
-
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">list</a>({ ...params }) -> Extend.WorkflowRunsListResponse</code></summary>
|
|
4075
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">create</a>({ ...params }) -> Extend.Workflow</code></summary>
|
|
3847
4076
|
<dl>
|
|
3848
4077
|
<dd>
|
|
3849
4078
|
|
|
@@ -3855,7 +4084,11 @@ await client.workflows.create({
|
|
|
3855
4084
|
<dl>
|
|
3856
4085
|
<dd>
|
|
3857
4086
|
|
|
3858
|
-
|
|
4087
|
+
Create a new workflow. Optionally provide `steps` to define the workflow's step graph.
|
|
4088
|
+
|
|
4089
|
+
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.
|
|
4090
|
+
|
|
4091
|
+
**Note:** The default steps may change in the future. If your integration depends on a specific step graph, provide `steps` explicitly.
|
|
3859
4092
|
</dd>
|
|
3860
4093
|
</dl>
|
|
3861
4094
|
</dd>
|
|
@@ -3870,8 +4103,8 @@ List runs of a Workflow. Workflows are sequences of steps that process files and
|
|
|
3870
4103
|
<dd>
|
|
3871
4104
|
|
|
3872
4105
|
```typescript
|
|
3873
|
-
await client.
|
|
3874
|
-
|
|
4106
|
+
await client.workflows.create({
|
|
4107
|
+
name: "Invoice Processing"
|
|
3875
4108
|
});
|
|
3876
4109
|
|
|
3877
4110
|
```
|
|
@@ -3888,7 +4121,7 @@ await client.workflowRuns.list({
|
|
|
3888
4121
|
<dl>
|
|
3889
4122
|
<dd>
|
|
3890
4123
|
|
|
3891
|
-
**request:** `Extend.
|
|
4124
|
+
**request:** `Extend.WorkflowsCreateRequest`
|
|
3892
4125
|
|
|
3893
4126
|
</dd>
|
|
3894
4127
|
</dl>
|
|
@@ -3896,7 +4129,7 @@ await client.workflowRuns.list({
|
|
|
3896
4129
|
<dl>
|
|
3897
4130
|
<dd>
|
|
3898
4131
|
|
|
3899
|
-
**requestOptions:** `
|
|
4132
|
+
**requestOptions:** `WorkflowsClient.RequestOptions`
|
|
3900
4133
|
|
|
3901
4134
|
</dd>
|
|
3902
4135
|
</dl>
|
|
@@ -3908,7 +4141,7 @@ await client.workflowRuns.list({
|
|
|
3908
4141
|
</dl>
|
|
3909
4142
|
</details>
|
|
3910
4143
|
|
|
3911
|
-
<details><summary><code>client.
|
|
4144
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">retrieve</a>(id) -> Extend.Workflow</code></summary>
|
|
3912
4145
|
<dl>
|
|
3913
4146
|
<dd>
|
|
3914
4147
|
|
|
@@ -3920,9 +4153,7 @@ await client.workflowRuns.list({
|
|
|
3920
4153
|
<dl>
|
|
3921
4154
|
<dd>
|
|
3922
4155
|
|
|
3923
|
-
|
|
3924
|
-
|
|
3925
|
-
The request returns immediately with a `PROCESSING` status. Use webhooks or poll the Get Workflow Run endpoint for results.
|
|
4156
|
+
Get details of a workflow, including its draft version and steps.
|
|
3926
4157
|
</dd>
|
|
3927
4158
|
</dl>
|
|
3928
4159
|
</dd>
|
|
@@ -3937,14 +4168,7 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
|
|
|
3937
4168
|
<dd>
|
|
3938
4169
|
|
|
3939
4170
|
```typescript
|
|
3940
|
-
await client.
|
|
3941
|
-
workflow: {
|
|
3942
|
-
id: "wf_1234567890"
|
|
3943
|
-
},
|
|
3944
|
-
file: {
|
|
3945
|
-
url: "https://example.com/invoice.pdf"
|
|
3946
|
-
}
|
|
3947
|
-
});
|
|
4171
|
+
await client.workflows.retrieve("workflow_abc123");
|
|
3948
4172
|
|
|
3949
4173
|
```
|
|
3950
4174
|
</dd>
|
|
@@ -3960,7 +4184,7 @@ await client.workflowRuns.create({
|
|
|
3960
4184
|
<dl>
|
|
3961
4185
|
<dd>
|
|
3962
4186
|
|
|
3963
|
-
**
|
|
4187
|
+
**id:** `string` — The ID of the workflow.
|
|
3964
4188
|
|
|
3965
4189
|
</dd>
|
|
3966
4190
|
</dl>
|
|
@@ -3968,7 +4192,7 @@ await client.workflowRuns.create({
|
|
|
3968
4192
|
<dl>
|
|
3969
4193
|
<dd>
|
|
3970
4194
|
|
|
3971
|
-
**requestOptions:** `
|
|
4195
|
+
**requestOptions:** `WorkflowsClient.RequestOptions`
|
|
3972
4196
|
|
|
3973
4197
|
</dd>
|
|
3974
4198
|
</dl>
|
|
@@ -3980,7 +4204,7 @@ await client.workflowRuns.create({
|
|
|
3980
4204
|
</dl>
|
|
3981
4205
|
</details>
|
|
3982
4206
|
|
|
3983
|
-
<details><summary><code>client.
|
|
4207
|
+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">update</a>(id, { ...params }) -> Extend.Workflow</code></summary>
|
|
3984
4208
|
<dl>
|
|
3985
4209
|
<dd>
|
|
3986
4210
|
|
|
@@ -3992,7 +4216,9 @@ await client.workflowRuns.create({
|
|
|
3992
4216
|
<dl>
|
|
3993
4217
|
<dd>
|
|
3994
4218
|
|
|
3995
|
-
|
|
4219
|
+
Update a workflow's draft. You can update the name, the steps, or both.
|
|
4220
|
+
|
|
4221
|
+
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.
|
|
3996
4222
|
</dd>
|
|
3997
4223
|
</dl>
|
|
3998
4224
|
</dd>
|
|
@@ -4007,7 +4233,9 @@ Once a workflow has been run, you can check the status and output of a specific
|
|
|
4007
4233
|
<dd>
|
|
4008
4234
|
|
|
4009
4235
|
```typescript
|
|
4010
|
-
await client.
|
|
4236
|
+
await client.workflows.update("workflow_abc123", {
|
|
4237
|
+
name: "Updated Invoice Processing"
|
|
4238
|
+
});
|
|
4011
4239
|
|
|
4012
4240
|
```
|
|
4013
4241
|
</dd>
|
|
@@ -4023,11 +4251,15 @@ await client.workflowRuns.retrieve("workflow_run_id_here");
|
|
|
4023
4251
|
<dl>
|
|
4024
4252
|
<dd>
|
|
4025
4253
|
|
|
4026
|
-
**id:** `string`
|
|
4254
|
+
**id:** `string` — The ID of the workflow to update.
|
|
4255
|
+
|
|
4256
|
+
</dd>
|
|
4257
|
+
</dl>
|
|
4027
4258
|
|
|
4028
|
-
|
|
4259
|
+
<dl>
|
|
4260
|
+
<dd>
|
|
4029
4261
|
|
|
4030
|
-
|
|
4262
|
+
**request:** `Extend.WorkflowsUpdateRequest`
|
|
4031
4263
|
|
|
4032
4264
|
</dd>
|
|
4033
4265
|
</dl>
|
|
@@ -4035,7 +4267,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4035
4267
|
<dl>
|
|
4036
4268
|
<dd>
|
|
4037
4269
|
|
|
4038
|
-
**requestOptions:** `
|
|
4270
|
+
**requestOptions:** `WorkflowsClient.RequestOptions`
|
|
4039
4271
|
|
|
4040
4272
|
</dd>
|
|
4041
4273
|
</dl>
|
|
@@ -4047,7 +4279,8 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4047
4279
|
</dl>
|
|
4048
4280
|
</details>
|
|
4049
4281
|
|
|
4050
|
-
|
|
4282
|
+
## WorkflowVersions
|
|
4283
|
+
<details><summary><code>client.workflowVersions.<a href="/src/api/resources/workflowVersions/client/Client.ts">list</a>(id, { ...params }) -> Extend.WorkflowVersionsListResponse</code></summary>
|
|
4051
4284
|
<dl>
|
|
4052
4285
|
<dd>
|
|
4053
4286
|
|
|
@@ -4059,7 +4292,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4059
4292
|
<dl>
|
|
4060
4293
|
<dd>
|
|
4061
4294
|
|
|
4062
|
-
|
|
4295
|
+
List all versions of a workflow, including the draft version. Returns a paginated list of version summaries.
|
|
4063
4296
|
</dd>
|
|
4064
4297
|
</dl>
|
|
4065
4298
|
</dd>
|
|
@@ -4074,9 +4307,444 @@ You can update the name and metadata of an in progress WorkflowRun at any time u
|
|
|
4074
4307
|
<dd>
|
|
4075
4308
|
|
|
4076
4309
|
```typescript
|
|
4077
|
-
await client.
|
|
4078
|
-
|
|
4079
|
-
|
|
4310
|
+
await client.workflowVersions.list("workflow_abc123", {
|
|
4311
|
+
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
4312
|
+
});
|
|
4313
|
+
|
|
4314
|
+
```
|
|
4315
|
+
</dd>
|
|
4316
|
+
</dl>
|
|
4317
|
+
</dd>
|
|
4318
|
+
</dl>
|
|
4319
|
+
|
|
4320
|
+
#### ⚙️ Parameters
|
|
4321
|
+
|
|
4322
|
+
<dl>
|
|
4323
|
+
<dd>
|
|
4324
|
+
|
|
4325
|
+
<dl>
|
|
4326
|
+
<dd>
|
|
4327
|
+
|
|
4328
|
+
**id:** `string` — The ID of the workflow.
|
|
4329
|
+
|
|
4330
|
+
</dd>
|
|
4331
|
+
</dl>
|
|
4332
|
+
|
|
4333
|
+
<dl>
|
|
4334
|
+
<dd>
|
|
4335
|
+
|
|
4336
|
+
**request:** `Extend.WorkflowVersionsListRequest`
|
|
4337
|
+
|
|
4338
|
+
</dd>
|
|
4339
|
+
</dl>
|
|
4340
|
+
|
|
4341
|
+
<dl>
|
|
4342
|
+
<dd>
|
|
4343
|
+
|
|
4344
|
+
**requestOptions:** `WorkflowVersionsClient.RequestOptions`
|
|
4345
|
+
|
|
4346
|
+
</dd>
|
|
4347
|
+
</dl>
|
|
4348
|
+
</dd>
|
|
4349
|
+
</dl>
|
|
4350
|
+
|
|
4351
|
+
|
|
4352
|
+
</dd>
|
|
4353
|
+
</dl>
|
|
4354
|
+
</details>
|
|
4355
|
+
|
|
4356
|
+
<details><summary><code>client.workflowVersions.<a href="/src/api/resources/workflowVersions/client/Client.ts">create</a>(id, { ...params }) -> Extend.WorkflowVersion</code></summary>
|
|
4357
|
+
<dl>
|
|
4358
|
+
<dd>
|
|
4359
|
+
|
|
4360
|
+
#### 📝 Description
|
|
4361
|
+
|
|
4362
|
+
<dl>
|
|
4363
|
+
<dd>
|
|
4364
|
+
|
|
4365
|
+
<dl>
|
|
4366
|
+
<dd>
|
|
4367
|
+
|
|
4368
|
+
Deploy a new version of a workflow. The deployed version becomes available for running workflow runs.
|
|
4369
|
+
|
|
4370
|
+
When `steps` is omitted, the current draft is deployed as-is. When `steps` is provided, the given steps are deployed directly without modifying the draft.
|
|
4371
|
+
</dd>
|
|
4372
|
+
</dl>
|
|
4373
|
+
</dd>
|
|
4374
|
+
</dl>
|
|
4375
|
+
|
|
4376
|
+
#### 🔌 Usage
|
|
4377
|
+
|
|
4378
|
+
<dl>
|
|
4379
|
+
<dd>
|
|
4380
|
+
|
|
4381
|
+
<dl>
|
|
4382
|
+
<dd>
|
|
4383
|
+
|
|
4384
|
+
```typescript
|
|
4385
|
+
await client.workflowVersions.create("workflow_abc123");
|
|
4386
|
+
|
|
4387
|
+
```
|
|
4388
|
+
</dd>
|
|
4389
|
+
</dl>
|
|
4390
|
+
</dd>
|
|
4391
|
+
</dl>
|
|
4392
|
+
|
|
4393
|
+
#### ⚙️ Parameters
|
|
4394
|
+
|
|
4395
|
+
<dl>
|
|
4396
|
+
<dd>
|
|
4397
|
+
|
|
4398
|
+
<dl>
|
|
4399
|
+
<dd>
|
|
4400
|
+
|
|
4401
|
+
**id:** `string` — The ID of the workflow to deploy.
|
|
4402
|
+
|
|
4403
|
+
</dd>
|
|
4404
|
+
</dl>
|
|
4405
|
+
|
|
4406
|
+
<dl>
|
|
4407
|
+
<dd>
|
|
4408
|
+
|
|
4409
|
+
**request:** `Extend.WorkflowVersionsCreateRequest`
|
|
4410
|
+
|
|
4411
|
+
</dd>
|
|
4412
|
+
</dl>
|
|
4413
|
+
|
|
4414
|
+
<dl>
|
|
4415
|
+
<dd>
|
|
4416
|
+
|
|
4417
|
+
**requestOptions:** `WorkflowVersionsClient.RequestOptions`
|
|
4418
|
+
|
|
4419
|
+
</dd>
|
|
4420
|
+
</dl>
|
|
4421
|
+
</dd>
|
|
4422
|
+
</dl>
|
|
4423
|
+
|
|
4424
|
+
|
|
4425
|
+
</dd>
|
|
4426
|
+
</dl>
|
|
4427
|
+
</details>
|
|
4428
|
+
|
|
4429
|
+
<details><summary><code>client.workflowVersions.<a href="/src/api/resources/workflowVersions/client/Client.ts">retrieve</a>(id, versionId) -> Extend.WorkflowVersion</code></summary>
|
|
4430
|
+
<dl>
|
|
4431
|
+
<dd>
|
|
4432
|
+
|
|
4433
|
+
#### 📝 Description
|
|
4434
|
+
|
|
4435
|
+
<dl>
|
|
4436
|
+
<dd>
|
|
4437
|
+
|
|
4438
|
+
<dl>
|
|
4439
|
+
<dd>
|
|
4440
|
+
|
|
4441
|
+
Get a specific version of a workflow, including its step definitions.
|
|
4442
|
+
|
|
4443
|
+
The `versionId` parameter accepts:
|
|
4444
|
+
- `"draft"` — returns the current draft version
|
|
4445
|
+
- A version number (e.g. `"1"`, `"2"`) — returns that deployed version
|
|
4446
|
+
- An internal version ID (e.g. `"workflow_version_abc123"`) — returns that specific version
|
|
4447
|
+
</dd>
|
|
4448
|
+
</dl>
|
|
4449
|
+
</dd>
|
|
4450
|
+
</dl>
|
|
4451
|
+
|
|
4452
|
+
#### 🔌 Usage
|
|
4453
|
+
|
|
4454
|
+
<dl>
|
|
4455
|
+
<dd>
|
|
4456
|
+
|
|
4457
|
+
<dl>
|
|
4458
|
+
<dd>
|
|
4459
|
+
|
|
4460
|
+
```typescript
|
|
4461
|
+
await client.workflowVersions.retrieve("workflow_abc123", "draft");
|
|
4462
|
+
|
|
4463
|
+
```
|
|
4464
|
+
</dd>
|
|
4465
|
+
</dl>
|
|
4466
|
+
</dd>
|
|
4467
|
+
</dl>
|
|
4468
|
+
|
|
4469
|
+
#### ⚙️ Parameters
|
|
4470
|
+
|
|
4471
|
+
<dl>
|
|
4472
|
+
<dd>
|
|
4473
|
+
|
|
4474
|
+
<dl>
|
|
4475
|
+
<dd>
|
|
4476
|
+
|
|
4477
|
+
**id:** `string` — The ID of the workflow.
|
|
4478
|
+
|
|
4479
|
+
</dd>
|
|
4480
|
+
</dl>
|
|
4481
|
+
|
|
4482
|
+
<dl>
|
|
4483
|
+
<dd>
|
|
4484
|
+
|
|
4485
|
+
**versionId:** `string` — The version to retrieve. Use `"draft"` for the draft, a number like `"1"` for a deployed version, or the internal version ID.
|
|
4486
|
+
|
|
4487
|
+
</dd>
|
|
4488
|
+
</dl>
|
|
4489
|
+
|
|
4490
|
+
<dl>
|
|
4491
|
+
<dd>
|
|
4492
|
+
|
|
4493
|
+
**requestOptions:** `WorkflowVersionsClient.RequestOptions`
|
|
4494
|
+
|
|
4495
|
+
</dd>
|
|
4496
|
+
</dl>
|
|
4497
|
+
</dd>
|
|
4498
|
+
</dl>
|
|
4499
|
+
|
|
4500
|
+
|
|
4501
|
+
</dd>
|
|
4502
|
+
</dl>
|
|
4503
|
+
</details>
|
|
4504
|
+
|
|
4505
|
+
## WorkflowRuns
|
|
4506
|
+
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">list</a>({ ...params }) -> Extend.WorkflowRunsListResponse</code></summary>
|
|
4507
|
+
<dl>
|
|
4508
|
+
<dd>
|
|
4509
|
+
|
|
4510
|
+
#### 📝 Description
|
|
4511
|
+
|
|
4512
|
+
<dl>
|
|
4513
|
+
<dd>
|
|
4514
|
+
|
|
4515
|
+
<dl>
|
|
4516
|
+
<dd>
|
|
4517
|
+
|
|
4518
|
+
List runs of a Workflow. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun represents a single execution of a workflow against a file.
|
|
4519
|
+
</dd>
|
|
4520
|
+
</dl>
|
|
4521
|
+
</dd>
|
|
4522
|
+
</dl>
|
|
4523
|
+
|
|
4524
|
+
#### 🔌 Usage
|
|
4525
|
+
|
|
4526
|
+
<dl>
|
|
4527
|
+
<dd>
|
|
4528
|
+
|
|
4529
|
+
<dl>
|
|
4530
|
+
<dd>
|
|
4531
|
+
|
|
4532
|
+
```typescript
|
|
4533
|
+
await client.workflowRuns.list({
|
|
4534
|
+
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
4535
|
+
});
|
|
4536
|
+
|
|
4537
|
+
```
|
|
4538
|
+
</dd>
|
|
4539
|
+
</dl>
|
|
4540
|
+
</dd>
|
|
4541
|
+
</dl>
|
|
4542
|
+
|
|
4543
|
+
#### ⚙️ Parameters
|
|
4544
|
+
|
|
4545
|
+
<dl>
|
|
4546
|
+
<dd>
|
|
4547
|
+
|
|
4548
|
+
<dl>
|
|
4549
|
+
<dd>
|
|
4550
|
+
|
|
4551
|
+
**request:** `Extend.WorkflowRunsListRequest`
|
|
4552
|
+
|
|
4553
|
+
</dd>
|
|
4554
|
+
</dl>
|
|
4555
|
+
|
|
4556
|
+
<dl>
|
|
4557
|
+
<dd>
|
|
4558
|
+
|
|
4559
|
+
**requestOptions:** `WorkflowRunsClient.RequestOptions`
|
|
4560
|
+
|
|
4561
|
+
</dd>
|
|
4562
|
+
</dl>
|
|
4563
|
+
</dd>
|
|
4564
|
+
</dl>
|
|
4565
|
+
|
|
4566
|
+
|
|
4567
|
+
</dd>
|
|
4568
|
+
</dl>
|
|
4569
|
+
</details>
|
|
4570
|
+
|
|
4571
|
+
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">create</a>({ ...params }) -> Extend.WorkflowRun</code></summary>
|
|
4572
|
+
<dl>
|
|
4573
|
+
<dd>
|
|
4574
|
+
|
|
4575
|
+
#### 📝 Description
|
|
4576
|
+
|
|
4577
|
+
<dl>
|
|
4578
|
+
<dd>
|
|
4579
|
+
|
|
4580
|
+
<dl>
|
|
4581
|
+
<dd>
|
|
4582
|
+
|
|
4583
|
+
Run a workflow with a file. A workflow is a sequence of steps that process files and data in a specific order to achieve a desired outcome.
|
|
4584
|
+
|
|
4585
|
+
The request returns immediately with a `PROCESSING` status. Use webhooks or poll the Get Workflow Run endpoint for results.
|
|
4586
|
+
</dd>
|
|
4587
|
+
</dl>
|
|
4588
|
+
</dd>
|
|
4589
|
+
</dl>
|
|
4590
|
+
|
|
4591
|
+
#### 🔌 Usage
|
|
4592
|
+
|
|
4593
|
+
<dl>
|
|
4594
|
+
<dd>
|
|
4595
|
+
|
|
4596
|
+
<dl>
|
|
4597
|
+
<dd>
|
|
4598
|
+
|
|
4599
|
+
```typescript
|
|
4600
|
+
await client.workflowRuns.create({
|
|
4601
|
+
workflow: {
|
|
4602
|
+
id: "wf_1234567890"
|
|
4603
|
+
},
|
|
4604
|
+
file: {
|
|
4605
|
+
url: "https://example.com/invoice.pdf"
|
|
4606
|
+
}
|
|
4607
|
+
});
|
|
4608
|
+
|
|
4609
|
+
```
|
|
4610
|
+
</dd>
|
|
4611
|
+
</dl>
|
|
4612
|
+
</dd>
|
|
4613
|
+
</dl>
|
|
4614
|
+
|
|
4615
|
+
#### ⚙️ Parameters
|
|
4616
|
+
|
|
4617
|
+
<dl>
|
|
4618
|
+
<dd>
|
|
4619
|
+
|
|
4620
|
+
<dl>
|
|
4621
|
+
<dd>
|
|
4622
|
+
|
|
4623
|
+
**request:** `Extend.WorkflowRunsCreateRequest`
|
|
4624
|
+
|
|
4625
|
+
</dd>
|
|
4626
|
+
</dl>
|
|
4627
|
+
|
|
4628
|
+
<dl>
|
|
4629
|
+
<dd>
|
|
4630
|
+
|
|
4631
|
+
**requestOptions:** `WorkflowRunsClient.RequestOptions`
|
|
4632
|
+
|
|
4633
|
+
</dd>
|
|
4634
|
+
</dl>
|
|
4635
|
+
</dd>
|
|
4636
|
+
</dl>
|
|
4637
|
+
|
|
4638
|
+
|
|
4639
|
+
</dd>
|
|
4640
|
+
</dl>
|
|
4641
|
+
</details>
|
|
4642
|
+
|
|
4643
|
+
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.WorkflowRun</code></summary>
|
|
4644
|
+
<dl>
|
|
4645
|
+
<dd>
|
|
4646
|
+
|
|
4647
|
+
#### 📝 Description
|
|
4648
|
+
|
|
4649
|
+
<dl>
|
|
4650
|
+
<dd>
|
|
4651
|
+
|
|
4652
|
+
<dl>
|
|
4653
|
+
<dd>
|
|
4654
|
+
|
|
4655
|
+
Once a workflow has been run, you can check the status and output of a specific WorkflowRun.
|
|
4656
|
+
</dd>
|
|
4657
|
+
</dl>
|
|
4658
|
+
</dd>
|
|
4659
|
+
</dl>
|
|
4660
|
+
|
|
4661
|
+
#### 🔌 Usage
|
|
4662
|
+
|
|
4663
|
+
<dl>
|
|
4664
|
+
<dd>
|
|
4665
|
+
|
|
4666
|
+
<dl>
|
|
4667
|
+
<dd>
|
|
4668
|
+
|
|
4669
|
+
```typescript
|
|
4670
|
+
await client.workflowRuns.retrieve("workflow_run_id_here");
|
|
4671
|
+
|
|
4672
|
+
```
|
|
4673
|
+
</dd>
|
|
4674
|
+
</dl>
|
|
4675
|
+
</dd>
|
|
4676
|
+
</dl>
|
|
4677
|
+
|
|
4678
|
+
#### ⚙️ Parameters
|
|
4679
|
+
|
|
4680
|
+
<dl>
|
|
4681
|
+
<dd>
|
|
4682
|
+
|
|
4683
|
+
<dl>
|
|
4684
|
+
<dd>
|
|
4685
|
+
|
|
4686
|
+
**id:** `string`
|
|
4687
|
+
|
|
4688
|
+
The ID of the workflow run.
|
|
4689
|
+
|
|
4690
|
+
Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
4691
|
+
|
|
4692
|
+
</dd>
|
|
4693
|
+
</dl>
|
|
4694
|
+
|
|
4695
|
+
<dl>
|
|
4696
|
+
<dd>
|
|
4697
|
+
|
|
4698
|
+
**request:** `Extend.WorkflowRunsRetrieveRequest`
|
|
4699
|
+
|
|
4700
|
+
</dd>
|
|
4701
|
+
</dl>
|
|
4702
|
+
|
|
4703
|
+
<dl>
|
|
4704
|
+
<dd>
|
|
4705
|
+
|
|
4706
|
+
**requestOptions:** `WorkflowRunsClient.RequestOptions`
|
|
4707
|
+
|
|
4708
|
+
</dd>
|
|
4709
|
+
</dl>
|
|
4710
|
+
</dd>
|
|
4711
|
+
</dl>
|
|
4712
|
+
|
|
4713
|
+
|
|
4714
|
+
</dd>
|
|
4715
|
+
</dl>
|
|
4716
|
+
</details>
|
|
4717
|
+
|
|
4718
|
+
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">update</a>(id, { ...params }) -> Extend.WorkflowRun</code></summary>
|
|
4719
|
+
<dl>
|
|
4720
|
+
<dd>
|
|
4721
|
+
|
|
4722
|
+
#### 📝 Description
|
|
4723
|
+
|
|
4724
|
+
<dl>
|
|
4725
|
+
<dd>
|
|
4726
|
+
|
|
4727
|
+
<dl>
|
|
4728
|
+
<dd>
|
|
4729
|
+
|
|
4730
|
+
You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
|
|
4731
|
+
</dd>
|
|
4732
|
+
</dl>
|
|
4733
|
+
</dd>
|
|
4734
|
+
</dl>
|
|
4735
|
+
|
|
4736
|
+
#### 🔌 Usage
|
|
4737
|
+
|
|
4738
|
+
<dl>
|
|
4739
|
+
<dd>
|
|
4740
|
+
|
|
4741
|
+
<dl>
|
|
4742
|
+
<dd>
|
|
4743
|
+
|
|
4744
|
+
```typescript
|
|
4745
|
+
await client.workflowRuns.update("workflow_run_id_here", {
|
|
4746
|
+
name: "Invoice #12345",
|
|
4747
|
+
metadata: {
|
|
4080
4748
|
"customerId": "cust_abc123",
|
|
4081
4749
|
"source": "email-inbox"
|
|
4082
4750
|
}
|
|
@@ -4128,7 +4796,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4128
4796
|
</dl>
|
|
4129
4797
|
</details>
|
|
4130
4798
|
|
|
4131
|
-
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">delete</a>(id) -> Extend.WorkflowRunsDeleteResponse</code></summary>
|
|
4799
|
+
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">delete</a>(id, { ...params }) -> Extend.WorkflowRunsDeleteResponse</code></summary>
|
|
4132
4800
|
<dl>
|
|
4133
4801
|
<dd>
|
|
4134
4802
|
|
|
@@ -4185,6 +4853,14 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4185
4853
|
<dl>
|
|
4186
4854
|
<dd>
|
|
4187
4855
|
|
|
4856
|
+
**request:** `Extend.WorkflowRunsDeleteRequest`
|
|
4857
|
+
|
|
4858
|
+
</dd>
|
|
4859
|
+
</dl>
|
|
4860
|
+
|
|
4861
|
+
<dl>
|
|
4862
|
+
<dd>
|
|
4863
|
+
|
|
4188
4864
|
**requestOptions:** `WorkflowRunsClient.RequestOptions`
|
|
4189
4865
|
|
|
4190
4866
|
</dd>
|
|
@@ -4197,7 +4873,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4197
4873
|
</dl>
|
|
4198
4874
|
</details>
|
|
4199
4875
|
|
|
4200
|
-
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">cancel</a>(id) -> Extend.WorkflowRun</code></summary>
|
|
4876
|
+
<details><summary><code>client.workflowRuns.<a href="/src/api/resources/workflowRuns/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.WorkflowRun</code></summary>
|
|
4201
4877
|
<dl>
|
|
4202
4878
|
<dd>
|
|
4203
4879
|
|
|
@@ -4254,6 +4930,14 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4254
4930
|
<dl>
|
|
4255
4931
|
<dd>
|
|
4256
4932
|
|
|
4933
|
+
**request:** `Extend.WorkflowRunsCancelRequest`
|
|
4934
|
+
|
|
4935
|
+
</dd>
|
|
4936
|
+
</dl>
|
|
4937
|
+
|
|
4938
|
+
<dl>
|
|
4939
|
+
<dd>
|
|
4940
|
+
|
|
4257
4941
|
**requestOptions:** `WorkflowRunsClient.RequestOptions`
|
|
4258
4942
|
|
|
4259
4943
|
</dd>
|
|
@@ -4499,7 +5183,7 @@ await client.processorRun.create({
|
|
|
4499
5183
|
</dl>
|
|
4500
5184
|
</details>
|
|
4501
5185
|
|
|
4502
|
-
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">get</a>(id) -> Extend.ProcessorRunGetResponse</code></summary>
|
|
5186
|
+
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">get</a>(id, { ...params }) -> Extend.ProcessorRunGetResponse</code></summary>
|
|
4503
5187
|
<dl>
|
|
4504
5188
|
<dd>
|
|
4505
5189
|
|
|
@@ -4556,6 +5240,14 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4556
5240
|
<dl>
|
|
4557
5241
|
<dd>
|
|
4558
5242
|
|
|
5243
|
+
**request:** `Extend.ProcessorRunGetRequest`
|
|
5244
|
+
|
|
5245
|
+
</dd>
|
|
5246
|
+
</dl>
|
|
5247
|
+
|
|
5248
|
+
<dl>
|
|
5249
|
+
<dd>
|
|
5250
|
+
|
|
4559
5251
|
**requestOptions:** `ProcessorRunClient.RequestOptions`
|
|
4560
5252
|
|
|
4561
5253
|
</dd>
|
|
@@ -4568,7 +5260,7 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4568
5260
|
</dl>
|
|
4569
5261
|
</details>
|
|
4570
5262
|
|
|
4571
|
-
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">delete</a>(id) -> Extend.ProcessorRunDeleteResponse</code></summary>
|
|
5263
|
+
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">delete</a>(id, { ...params }) -> Extend.ProcessorRunDeleteResponse</code></summary>
|
|
4572
5264
|
<dl>
|
|
4573
5265
|
<dd>
|
|
4574
5266
|
|
|
@@ -4625,6 +5317,14 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4625
5317
|
<dl>
|
|
4626
5318
|
<dd>
|
|
4627
5319
|
|
|
5320
|
+
**request:** `Extend.ProcessorRunDeleteRequest`
|
|
5321
|
+
|
|
5322
|
+
</dd>
|
|
5323
|
+
</dl>
|
|
5324
|
+
|
|
5325
|
+
<dl>
|
|
5326
|
+
<dd>
|
|
5327
|
+
|
|
4628
5328
|
**requestOptions:** `ProcessorRunClient.RequestOptions`
|
|
4629
5329
|
|
|
4630
5330
|
</dd>
|
|
@@ -4637,7 +5337,7 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4637
5337
|
</dl>
|
|
4638
5338
|
</details>
|
|
4639
5339
|
|
|
4640
|
-
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">cancel</a>(id) -> Extend.ProcessorRunCancelResponse</code></summary>
|
|
5340
|
+
<details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.ProcessorRunCancelResponse</code></summary>
|
|
4641
5341
|
<dl>
|
|
4642
5342
|
<dd>
|
|
4643
5343
|
|
|
@@ -4694,6 +5394,14 @@ Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4694
5394
|
<dl>
|
|
4695
5395
|
<dd>
|
|
4696
5396
|
|
|
5397
|
+
**request:** `Extend.ProcessorRunCancelRequest`
|
|
5398
|
+
|
|
5399
|
+
</dd>
|
|
5400
|
+
</dl>
|
|
5401
|
+
|
|
5402
|
+
<dl>
|
|
5403
|
+
<dd>
|
|
5404
|
+
|
|
4697
5405
|
**requestOptions:** `ProcessorRunClient.RequestOptions`
|
|
4698
5406
|
|
|
4699
5407
|
</dd>
|
|
@@ -4912,7 +5620,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4912
5620
|
</details>
|
|
4913
5621
|
|
|
4914
5622
|
## ProcessorVersion
|
|
4915
|
-
<details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">list</a>(id) -> Extend.ProcessorVersionListResponse</code></summary>
|
|
5623
|
+
<details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">list</a>(id, { ...params }) -> Extend.ProcessorVersionListResponse</code></summary>
|
|
4916
5624
|
<dl>
|
|
4917
5625
|
<dd>
|
|
4918
5626
|
|
|
@@ -4970,6 +5678,14 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
4970
5678
|
<dl>
|
|
4971
5679
|
<dd>
|
|
4972
5680
|
|
|
5681
|
+
**request:** `Extend.ProcessorVersionListRequest`
|
|
5682
|
+
|
|
5683
|
+
</dd>
|
|
5684
|
+
</dl>
|
|
5685
|
+
|
|
5686
|
+
<dl>
|
|
5687
|
+
<dd>
|
|
5688
|
+
|
|
4973
5689
|
**requestOptions:** `ProcessorVersionClient.RequestOptions`
|
|
4974
5690
|
|
|
4975
5691
|
</dd>
|
|
@@ -5061,7 +5777,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
5061
5777
|
</dl>
|
|
5062
5778
|
</details>
|
|
5063
5779
|
|
|
5064
|
-
<details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">get</a>(processorId, processorVersionId) -> Extend.ProcessorVersionGetResponse</code></summary>
|
|
5780
|
+
<details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">get</a>(processorId, processorVersionId, { ...params }) -> Extend.ProcessorVersionGetResponse</code></summary>
|
|
5065
5781
|
<dl>
|
|
5066
5782
|
<dd>
|
|
5067
5783
|
|
|
@@ -5128,6 +5844,14 @@ Example: `"exv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
5128
5844
|
<dl>
|
|
5129
5845
|
<dd>
|
|
5130
5846
|
|
|
5847
|
+
**request:** `Extend.ProcessorVersionGetRequest`
|
|
5848
|
+
|
|
5849
|
+
</dd>
|
|
5850
|
+
</dl>
|
|
5851
|
+
|
|
5852
|
+
<dl>
|
|
5853
|
+
<dd>
|
|
5854
|
+
|
|
5131
5855
|
**requestOptions:** `ProcessorVersionClient.RequestOptions`
|
|
5132
5856
|
|
|
5133
5857
|
</dd>
|
|
@@ -5141,7 +5865,7 @@ Example: `"exv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
5141
5865
|
</details>
|
|
5142
5866
|
|
|
5143
5867
|
## BatchProcessorRun
|
|
5144
|
-
<details><summary><code>client.batchProcessorRun.<a href="/src/api/resources/batchProcessorRun/client/Client.ts">get</a>(id) -> Extend.BatchProcessorRunGetResponse</code></summary>
|
|
5868
|
+
<details><summary><code>client.batchProcessorRun.<a href="/src/api/resources/batchProcessorRun/client/Client.ts">get</a>(id, { ...params }) -> Extend.BatchProcessorRunGetResponse</code></summary>
|
|
5145
5869
|
<dl>
|
|
5146
5870
|
<dd>
|
|
5147
5871
|
|
|
@@ -5198,6 +5922,14 @@ Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
5198
5922
|
<dl>
|
|
5199
5923
|
<dd>
|
|
5200
5924
|
|
|
5925
|
+
**request:** `Extend.BatchProcessorRunGetRequest`
|
|
5926
|
+
|
|
5927
|
+
</dd>
|
|
5928
|
+
</dl>
|
|
5929
|
+
|
|
5930
|
+
<dl>
|
|
5931
|
+
<dd>
|
|
5932
|
+
|
|
5201
5933
|
**requestOptions:** `BatchProcessorRunClient.RequestOptions`
|
|
5202
5934
|
|
|
5203
5935
|
</dd>
|
|
@@ -5346,7 +6078,7 @@ await client.evaluationSets.create({
|
|
|
5346
6078
|
</dl>
|
|
5347
6079
|
</details>
|
|
5348
6080
|
|
|
5349
|
-
<details><summary><code>client.evaluationSets.<a href="/src/api/resources/evaluationSets/client/Client.ts">retrieve</a>(id) -> Extend.EvaluationSet</code></summary>
|
|
6081
|
+
<details><summary><code>client.evaluationSets.<a href="/src/api/resources/evaluationSets/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.EvaluationSet</code></summary>
|
|
5350
6082
|
<dl>
|
|
5351
6083
|
<dd>
|
|
5352
6084
|
|
|
@@ -5401,6 +6133,14 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
|
|
|
5401
6133
|
<dl>
|
|
5402
6134
|
<dd>
|
|
5403
6135
|
|
|
6136
|
+
**request:** `Extend.EvaluationSetsRetrieveRequest`
|
|
6137
|
+
|
|
6138
|
+
</dd>
|
|
6139
|
+
</dl>
|
|
6140
|
+
|
|
6141
|
+
<dl>
|
|
6142
|
+
<dd>
|
|
6143
|
+
|
|
5404
6144
|
**requestOptions:** `EvaluationSetsClient.RequestOptions`
|
|
5405
6145
|
|
|
5406
6146
|
</dd>
|
|
@@ -5583,7 +6323,7 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
|
|
|
5583
6323
|
</dl>
|
|
5584
6324
|
</details>
|
|
5585
6325
|
|
|
5586
|
-
<details><summary><code>client.evaluationSetItems.<a href="/src/api/resources/evaluationSetItems/client/Client.ts">retrieve</a>(evaluationSetId, itemId) -> Extend.EvaluationSetItem</code></summary>
|
|
6326
|
+
<details><summary><code>client.evaluationSetItems.<a href="/src/api/resources/evaluationSetItems/client/Client.ts">retrieve</a>(evaluationSetId, itemId, { ...params }) -> Extend.EvaluationSetItem</code></summary>
|
|
5587
6327
|
<dl>
|
|
5588
6328
|
<dd>
|
|
5589
6329
|
|
|
@@ -5650,6 +6390,14 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
|
|
|
5650
6390
|
<dl>
|
|
5651
6391
|
<dd>
|
|
5652
6392
|
|
|
6393
|
+
**request:** `Extend.EvaluationSetItemsRetrieveRequest`
|
|
6394
|
+
|
|
6395
|
+
</dd>
|
|
6396
|
+
</dl>
|
|
6397
|
+
|
|
6398
|
+
<dl>
|
|
6399
|
+
<dd>
|
|
6400
|
+
|
|
5653
6401
|
**requestOptions:** `EvaluationSetItemsClient.RequestOptions`
|
|
5654
6402
|
|
|
5655
6403
|
</dd>
|
|
@@ -5757,7 +6505,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
|
|
|
5757
6505
|
</dl>
|
|
5758
6506
|
</details>
|
|
5759
6507
|
|
|
5760
|
-
<details><summary><code>client.evaluationSetItems.<a href="/src/api/resources/evaluationSetItems/client/Client.ts">delete</a>(evaluationSetId, itemId) -> Extend.EvaluationSetItemsDeleteResponse</code></summary>
|
|
6508
|
+
<details><summary><code>client.evaluationSetItems.<a href="/src/api/resources/evaluationSetItems/client/Client.ts">delete</a>(evaluationSetId, itemId, { ...params }) -> Extend.EvaluationSetItemsDeleteResponse</code></summary>
|
|
5761
6509
|
<dl>
|
|
5762
6510
|
<dd>
|
|
5763
6511
|
|
|
@@ -5824,6 +6572,14 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
|
|
|
5824
6572
|
<dl>
|
|
5825
6573
|
<dd>
|
|
5826
6574
|
|
|
6575
|
+
**request:** `Extend.EvaluationSetItemsDeleteRequest`
|
|
6576
|
+
|
|
6577
|
+
</dd>
|
|
6578
|
+
</dl>
|
|
6579
|
+
|
|
6580
|
+
<dl>
|
|
6581
|
+
<dd>
|
|
6582
|
+
|
|
5827
6583
|
**requestOptions:** `EvaluationSetItemsClient.RequestOptions`
|
|
5828
6584
|
|
|
5829
6585
|
</dd>
|
|
@@ -5837,7 +6593,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
|
|
|
5837
6593
|
</details>
|
|
5838
6594
|
|
|
5839
6595
|
## EvaluationSetRuns
|
|
5840
|
-
<details><summary><code>client.evaluationSetRuns.<a href="/src/api/resources/evaluationSetRuns/client/Client.ts">retrieve</a>(id) -> Extend.EvaluationSetRun</code></summary>
|
|
6596
|
+
<details><summary><code>client.evaluationSetRuns.<a href="/src/api/resources/evaluationSetRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.EvaluationSetRun</code></summary>
|
|
5841
6597
|
<dl>
|
|
5842
6598
|
<dd>
|
|
5843
6599
|
|
|
@@ -5892,6 +6648,14 @@ Example: `"evr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
5892
6648
|
<dl>
|
|
5893
6649
|
<dd>
|
|
5894
6650
|
|
|
6651
|
+
**request:** `Extend.EvaluationSetRunsRetrieveRequest`
|
|
6652
|
+
|
|
6653
|
+
</dd>
|
|
6654
|
+
</dl>
|
|
6655
|
+
|
|
6656
|
+
<dl>
|
|
6657
|
+
<dd>
|
|
6658
|
+
|
|
5895
6659
|
**requestOptions:** `EvaluationSetRunsClient.RequestOptions`
|
|
5896
6660
|
|
|
5897
6661
|
</dd>
|
|
@@ -6042,7 +6806,7 @@ await client.webhookEndpoints.create({
|
|
|
6042
6806
|
</dl>
|
|
6043
6807
|
</details>
|
|
6044
6808
|
|
|
6045
|
-
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">retrieve</a>(id) -> Extend.WebhookEndpoint</code></summary>
|
|
6809
|
+
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.WebhookEndpoint</code></summary>
|
|
6046
6810
|
<dl>
|
|
6047
6811
|
<dd>
|
|
6048
6812
|
|
|
@@ -6097,6 +6861,14 @@ Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6097
6861
|
<dl>
|
|
6098
6862
|
<dd>
|
|
6099
6863
|
|
|
6864
|
+
**request:** `Extend.WebhookEndpointsRetrieveRequest`
|
|
6865
|
+
|
|
6866
|
+
</dd>
|
|
6867
|
+
</dl>
|
|
6868
|
+
|
|
6869
|
+
<dl>
|
|
6870
|
+
<dd>
|
|
6871
|
+
|
|
6100
6872
|
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
|
|
6101
6873
|
|
|
6102
6874
|
</dd>
|
|
@@ -6186,7 +6958,7 @@ Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6186
6958
|
</dl>
|
|
6187
6959
|
</details>
|
|
6188
6960
|
|
|
6189
|
-
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">delete</a>(id) -> Extend.WebhookEndpointsDeleteResponse</code></summary>
|
|
6961
|
+
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">delete</a>(id, { ...params }) -> Extend.WebhookEndpointsDeleteResponse</code></summary>
|
|
6190
6962
|
<dl>
|
|
6191
6963
|
<dd>
|
|
6192
6964
|
|
|
@@ -6241,6 +7013,14 @@ Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6241
7013
|
<dl>
|
|
6242
7014
|
<dd>
|
|
6243
7015
|
|
|
7016
|
+
**request:** `Extend.WebhookEndpointsDeleteRequest`
|
|
7017
|
+
|
|
7018
|
+
</dd>
|
|
7019
|
+
</dl>
|
|
7020
|
+
|
|
7021
|
+
<dl>
|
|
7022
|
+
<dd>
|
|
7023
|
+
|
|
6244
7024
|
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
|
|
6245
7025
|
|
|
6246
7026
|
</dd>
|
|
@@ -6391,7 +7171,7 @@ await client.webhookSubscriptions.create({
|
|
|
6391
7171
|
</dl>
|
|
6392
7172
|
</details>
|
|
6393
7173
|
|
|
6394
|
-
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">retrieve</a>(id) -> Extend.WebhookSubscription</code></summary>
|
|
7174
|
+
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.WebhookSubscription</code></summary>
|
|
6395
7175
|
<dl>
|
|
6396
7176
|
<dd>
|
|
6397
7177
|
|
|
@@ -6446,6 +7226,14 @@ Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6446
7226
|
<dl>
|
|
6447
7227
|
<dd>
|
|
6448
7228
|
|
|
7229
|
+
**request:** `Extend.WebhookSubscriptionsRetrieveRequest`
|
|
7230
|
+
|
|
7231
|
+
</dd>
|
|
7232
|
+
</dl>
|
|
7233
|
+
|
|
7234
|
+
<dl>
|
|
7235
|
+
<dd>
|
|
7236
|
+
|
|
6449
7237
|
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
|
|
6450
7238
|
|
|
6451
7239
|
</dd>
|
|
@@ -6535,7 +7323,7 @@ Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6535
7323
|
</dl>
|
|
6536
7324
|
</details>
|
|
6537
7325
|
|
|
6538
|
-
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">delete</a>(id) -> Extend.WebhookSubscriptionsDeleteResponse</code></summary>
|
|
7326
|
+
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">delete</a>(id, { ...params }) -> Extend.WebhookSubscriptionsDeleteResponse</code></summary>
|
|
6539
7327
|
<dl>
|
|
6540
7328
|
<dd>
|
|
6541
7329
|
|
|
@@ -6590,6 +7378,14 @@ Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
6590
7378
|
<dl>
|
|
6591
7379
|
<dd>
|
|
6592
7380
|
|
|
7381
|
+
**request:** `Extend.WebhookSubscriptionsDeleteRequest`
|
|
7382
|
+
|
|
7383
|
+
</dd>
|
|
7384
|
+
</dl>
|
|
7385
|
+
|
|
7386
|
+
<dl>
|
|
7387
|
+
<dd>
|
|
7388
|
+
|
|
6593
7389
|
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
|
|
6594
7390
|
|
|
6595
7391
|
</dd>
|