@deepraxis/sdk 0.1.1-dev.f8aa5de → 0.1.1-dev.fee48ec
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/METHODS.md +614 -1
- package/README.md +4 -4
- package/dist/automation.d.ts +54 -0
- package/dist/core/client.d.ts +7 -1
- package/dist/core/client.js +3 -0
- package/dist/core/errors.d.ts +6 -0
- package/dist/core/errors.js +8 -0
- package/dist/core/transport.d.ts +9 -0
- package/dist/core/transport.js +13 -2
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +1591 -256
- package/dist/generated/sdk.gen.js +4736 -936
- package/dist/generated/types.gen.d.ts +53222 -32067
- package/dist/helpers/browser-actions.d.ts +84 -0
- package/dist/helpers/browser-actions.js +141 -0
- package/dist/helpers/browser-connect.d.ts +26 -2
- package/dist/helpers/browser-connect.js +263 -25
- package/dist/helpers/browser-decisions.d.ts +44 -0
- package/dist/helpers/browser-decisions.js +53 -0
- package/dist/helpers/browser-documentation.d.ts +1 -1
- package/dist/helpers/browser-documentation.js +20 -11
- package/dist/helpers/sandbox-templates.d.ts +121 -0
- package/dist/helpers/sandbox-templates.js +60 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/dist/operations.generated.d.ts +9999 -3892
- package/dist/operations.generated.js +12499 -4908
- package/dist/resources.generated.d.ts +645 -37
- package/dist/resources.generated.js +382 -1
- package/package.json +2 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type ServerSentEventsResult, type TDataShape } from './client/index.js';
|
|
2
|
-
import type { AgentsArchiveData, AgentsArchiveErrors, AgentsArchiveResponses, AgentsCreateData, AgentsCreateErrors, AgentsCreateResponses, AgentsListData, AgentsListErrors, AgentsListResponses, AgentsRetrieveData, AgentsRetrieveErrors, AgentsRetrieveResponses, AgentsUpdateData, AgentsUpdateErrors, AgentsUpdateResponses, AgentsVersionsListData, AgentsVersionsListErrors, AgentsVersionsListResponses, ApplicationCreateAssetUploadSessionData, ApplicationCreateAssetUploadSessionErrors, ApplicationCreateAssetUploadSessionResponses, ApplicationCreateDeploymentData, ApplicationCreateDeploymentErrors, ApplicationCreateDeploymentResponses, ApplicationCreateGrantData, ApplicationCreateGrantErrors, ApplicationCreateGrantResponses, ApplicationCreateVersionData, ApplicationCreateVersionErrors, ApplicationCreateVersionResponses, ApplicationCreateWorkerData, ApplicationCreateWorkerErrors, ApplicationCreateWorkerResponses, ApplicationDeleteGrantData, ApplicationDeleteGrantErrors, ApplicationDeleteGrantResponses, ApplicationDeleteSecretData, ApplicationDeleteSecretErrors, ApplicationDeleteSecretResponses, ApplicationDeleteWorkerData, ApplicationDeleteWorkerErrors, ApplicationDeleteWorkerResponses, ApplicationGetDeploymentData, ApplicationGetDeploymentErrors, ApplicationGetDeploymentResponses, ApplicationGetSubdomainData, ApplicationGetSubdomainErrors, ApplicationGetSubdomainResponses, ApplicationGetVersionAssetManifestData, ApplicationGetVersionAssetManifestErrors, ApplicationGetVersionAssetManifestResponses, ApplicationGetVersionData, ApplicationGetVersionErrors, ApplicationGetVersionResponses, ApplicationGetWorkerData, ApplicationGetWorkerErrors, ApplicationGetWorkerResponses, ApplicationListComponentsData, ApplicationListComponentsErrors, ApplicationListComponentsResponses, ApplicationListDeploymentsData, ApplicationListDeploymentsErrors, ApplicationListDeploymentsResponses, ApplicationListEventsData, ApplicationListEventsErrors, ApplicationListEventsResponses, ApplicationListGrantsData, ApplicationListGrantsErrors, ApplicationListGrantsResponses, ApplicationListSecretsData, ApplicationListSecretsErrors, ApplicationListSecretsResponses, ApplicationListVersionsData, ApplicationListVersionsErrors, ApplicationListVersionsResponses, ApplicationListWorkersData, ApplicationListWorkersErrors, ApplicationListWorkersResponses, ApplicationPutSecretData, ApplicationPutSecretErrors, ApplicationPutSecretResponses, ApplicationPutSubdomainData, ApplicationPutSubdomainErrors, ApplicationPutSubdomainResponses, ApplicationRestoreWorkerData, ApplicationRestoreWorkerErrors, ApplicationRestoreWorkerResponses, ApplicationUpdateWorkerData, ApplicationUpdateWorkerErrors, ApplicationUpdateWorkerResponses, ApplicationUploadAssetsData, ApplicationUploadAssetsErrors, ApplicationUploadAssetsResponses, ApplyAgentVersionData, ApplyAgentVersionErrors, ApplyAgentVersionResponses, AutomationActionsArchiveData, AutomationActionsArchiveErrors, AutomationActionsArchiveResponses, AutomationActionsCreateData, AutomationActionsCreateErrors, AutomationActionsCreateResponses, AutomationActionsDependentsData, AutomationActionsDependentsErrors, AutomationActionsDependentsResponses, AutomationActionsGetData, AutomationActionsGetErrors, AutomationActionsGetResponses, AutomationActionsInvocationsData, AutomationActionsInvocationsErrors, AutomationActionsInvocationsResponses, AutomationActionsListData, AutomationActionsListErrors, AutomationActionsListResponses, AutomationActionsRestoreData, AutomationActionsRestoreErrors, AutomationActionsRestoreResponses, AutomationActionsRevisionData, AutomationActionsRevisionErrors, AutomationActionsRevisionResponses, AutomationActionsRevisionsData, AutomationActionsRevisionsErrors, AutomationActionsRevisionsResponses, AutomationActionsRollbackData, AutomationActionsRollbackErrors, AutomationActionsRollbackResponses, AutomationActionsUpdateData, AutomationActionsUpdateErrors, AutomationActionsUpdateResponses, AutomationHooksReceiveData, AutomationHooksReceiveErrors, AutomationHooksReceiveResponses, AutomationHumanTasksCancelData, AutomationHumanTasksCancelErrors, AutomationHumanTasksCancelResponses, AutomationHumanTasksDelegateData, AutomationHumanTasksDelegateErrors, AutomationHumanTasksDelegateResponses, AutomationHumanTasksGetData, AutomationHumanTasksGetErrors, AutomationHumanTasksGetResponses, AutomationHumanTasksListData, AutomationHumanTasksListErrors, AutomationHumanTasksListResponses, AutomationHumanTasksRespondData, AutomationHumanTasksRespondErrors, AutomationHumanTasksRespondResponses, AutomationResolveResolveData, AutomationResolveResolveErrors, AutomationResolveResolveResponses, AutomationRunsArtifactsData, AutomationRunsArtifactsErrors, AutomationRunsArtifactsResponses, AutomationRunsCallsData, AutomationRunsCallsErrors, AutomationRunsCallsResponses, AutomationRunsCancelData, AutomationRunsCancelErrors, AutomationRunsCancelResponses, AutomationRunsCompleteWaitData, AutomationRunsCompleteWaitErrors, AutomationRunsCompleteWaitResponses, AutomationRunsCreateData, AutomationRunsCreateErrors, AutomationRunsCreateResponses, AutomationRunsEventsData, AutomationRunsEventsErrors, AutomationRunsEventsResponses, AutomationRunsGetData, AutomationRunsGetErrors, AutomationRunsGetResponses, AutomationRunsListData, AutomationRunsListErrors, AutomationRunsListResponses, AutomationRunsLogsData, AutomationRunsLogsErrors, AutomationRunsLogsResponses, AutomationRunsRerunData, AutomationRunsRerunErrors, AutomationRunsRerunResponses, AutomationRunsResumeData, AutomationRunsResumeErrors, AutomationRunsResumeResponses, AutomationRunsSourceData, AutomationRunsSourceErrors, AutomationRunsSourceResponses, AutomationRunsSuspendData, AutomationRunsSuspendErrors, AutomationRunsSuspendResponses, AutomationRunsTasksData, AutomationRunsTasksErrors, AutomationRunsTasksResponses, AutomationRunsWaitsData, AutomationRunsWaitsErrors, AutomationRunsWaitsResponses, AutomationScriptsArchiveData, AutomationScriptsArchiveErrors, AutomationScriptsArchiveResponses, AutomationScriptsCreateData, AutomationScriptsCreateErrors, AutomationScriptsCreateResponses, AutomationScriptsDeleteDistTagData, AutomationScriptsDeleteDistTagErrors, AutomationScriptsDeleteDistTagResponses, AutomationScriptsDeprecateData, AutomationScriptsDeprecateErrors, AutomationScriptsDeprecateResponses, AutomationScriptsDistTagsData, AutomationScriptsDistTagsErrors, AutomationScriptsDistTagsResponses, AutomationScriptsGetData, AutomationScriptsGetErrors, AutomationScriptsGetResponses, AutomationScriptsListData, AutomationScriptsListErrors, AutomationScriptsListResponses, AutomationScriptsPatchData, AutomationScriptsPatchErrors, AutomationScriptsPatchResponses, AutomationScriptsPublishData, AutomationScriptsPublishErrors, AutomationScriptsPublishResponses, AutomationScriptsRestoreData, AutomationScriptsRestoreErrors, AutomationScriptsRestoreResponses, AutomationScriptsSetDistTagData, AutomationScriptsSetDistTagErrors, AutomationScriptsSetDistTagResponses, AutomationScriptsVersionData, AutomationScriptsVersionErrors, AutomationScriptsVersionResponses, AutomationScriptsVersionsData, AutomationScriptsVersionsErrors, AutomationScriptsVersionsResponses, AutomationTargetsTargetsData, AutomationTargetsTargetsErrors, AutomationTargetsTargetsResponses, AutomationTriggersCreateData, AutomationTriggersCreateErrors, AutomationTriggersCreateResponses, AutomationTriggersDeleteData, AutomationTriggersDeleteErrors, AutomationTriggersDeleteResponses, AutomationTriggersFireData, AutomationTriggersFireErrors, AutomationTriggersFireResponses, AutomationTriggersFiringsData, AutomationTriggersFiringsErrors, AutomationTriggersFiringsResponses, AutomationTriggersGetData, AutomationTriggersGetErrors, AutomationTriggersGetResponses, AutomationTriggersListData, AutomationTriggersListErrors, AutomationTriggersListResponses, AutomationTriggersPatchData, AutomationTriggersPatchErrors, AutomationTriggersPatchResponses, AutomationTriggersPauseData, AutomationTriggersPauseErrors, AutomationTriggersPauseResponses, AutomationTriggersPreviewData, AutomationTriggersPreviewErrors, AutomationTriggersPreviewResponses, AutomationTriggersResumeData, AutomationTriggersResumeErrors, AutomationTriggersResumeResponses, AutomationTriggersRotateWebhookData, AutomationTriggersRotateWebhookErrors, AutomationTriggersRotateWebhookResponses, AutomationValidateValidateData, AutomationValidateValidateErrors, AutomationValidateValidateResponses, AutomationWorkflowsArchiveData, AutomationWorkflowsArchiveErrors, AutomationWorkflowsArchiveResponses, AutomationWorkflowsCreateData, AutomationWorkflowsCreateErrors, AutomationWorkflowsCreateResponses, AutomationWorkflowsDeleteDistTagData, AutomationWorkflowsDeleteDistTagErrors, AutomationWorkflowsDeleteDistTagResponses, AutomationWorkflowsDeprecateData, AutomationWorkflowsDeprecateErrors, AutomationWorkflowsDeprecateResponses, AutomationWorkflowsDistTagsData, AutomationWorkflowsDistTagsErrors, AutomationWorkflowsDistTagsResponses, AutomationWorkflowsGetData, AutomationWorkflowsGetErrors, AutomationWorkflowsGetResponses, AutomationWorkflowsListData, AutomationWorkflowsListErrors, AutomationWorkflowsListResponses, AutomationWorkflowsPatchData, AutomationWorkflowsPatchErrors, AutomationWorkflowsPatchResponses, AutomationWorkflowsPublishData, AutomationWorkflowsPublishErrors, AutomationWorkflowsPublishResponses, AutomationWorkflowsRestoreData, AutomationWorkflowsRestoreErrors, AutomationWorkflowsRestoreResponses, AutomationWorkflowsSetDistTagData, AutomationWorkflowsSetDistTagErrors, AutomationWorkflowsSetDistTagResponses, AutomationWorkflowsVersionData, AutomationWorkflowsVersionErrors, AutomationWorkflowsVersionResponses, AutomationWorkflowsVersionsData, AutomationWorkflowsVersionsErrors, AutomationWorkflowsVersionsResponses, BlockCustomerData, BlockCustomerErrors, BlockCustomerResponses, BrowserCloseSessionData, BrowserCloseSessionErrors, BrowserCloseSessionResponses, BrowserCompleteHandoffData, BrowserCompleteHandoffErrors, BrowserCompleteHandoffResponses, BrowserConnectData, BrowserConnectErrors, BrowserCreateContextData, BrowserCreateContextErrors, BrowserCreateContextResponses, BrowserCreateSessionData, BrowserCreateSessionErrors, BrowserCreateSessionResponses, BrowserDeleteContextData, BrowserDeleteContextErrors, BrowserDeleteContextResponses, BrowserGetContextData, BrowserGetContextErrors, BrowserGetContextResponses, BrowserGetDebugData, BrowserGetDebugErrors, BrowserGetDebugResponses, BrowserGetSessionData, BrowserGetSessionErrors, BrowserGetSessionResponses, BrowserListContextsData, BrowserListContextsErrors, BrowserListContextsResponses, BrowserListEventsData, BrowserListEventsErrors, BrowserListEventsResponses, BrowserListSessionsData, BrowserListSessionsErrors, BrowserListSessionsResponses, BrowserLiveViewData, BrowserLiveViewErrors, BrowserRequestHandoffData, BrowserRequestHandoffErrors, BrowserRequestHandoffResponses, BrowserSeleniumUnsupportedData, BrowserSeleniumUnsupportedErrors, BrowserStreamSessionData, BrowserStreamSessionResponse, BrowserStreamSessionResponses, BrowserUpdateContextData, BrowserUpdateContextErrors, BrowserUpdateContextResponses, BrowserViewerHeartbeatData, BrowserViewerHeartbeatErrors, BrowserViewerHeartbeatResponses, CancelResponseData, CancelResponseErrors, CancelResponseResponses, CompactResponseData, CompactResponseErrors, CompactResponseResponses, CompactSessionData, CompactSessionErrors, CompactSessionResponses, ComputersArchiveData, ComputersArchiveErrors, ComputersArchiveResponses, ComputersAttachmentsCreateData, ComputersAttachmentsCreateErrors, ComputersAttachmentsCreateResponses, ComputersCreateData, ComputersCreateErrors, ComputersCreateResponses, ComputersDeleteData, ComputersDeleteErrors, ComputersDeleteResponses, ComputersFilesContentData, ComputersFilesContentErrors, ComputersFilesContentResponses, ComputersFilesListData, ComputersFilesListErrors, ComputersFilesListResponses, ComputersListData, ComputersListErrors, ComputersListResponses, ComputersRetrieveData, ComputersRetrieveErrors, ComputersRetrieveResponses, ComputersUpdateData, ComputersUpdateErrors, ComputersUpdateResponses, ConnectComputerData, ConnectComputerErrors, ConnectComputerResponses, CountResponseInputTokensData, CountResponseInputTokensErrors, CountResponseInputTokensResponses, CountTokensData, CountTokensErrors, CountTokensResponses, CreateAudioSpeechData, CreateAudioSpeechErrors, CreateAudioSpeechResponses, CreateAudioTranscriptionData, CreateAudioTranscriptionErrors, CreateAudioTranscriptionResponses, CreateChatCompletionData, CreateChatCompletionErrors, CreateChatCompletionResponses, CreateConversationData, CreateConversationItemsData, CreateConversationItemsErrors, CreateConversationItemsResponses, CreateConversationResponses, CreateCustomerAccessTokenData, CreateCustomerAccessTokenErrors, CreateCustomerAccessTokenResponses, CreateCustomerGrantCodeData, CreateCustomerGrantCodeErrors, CreateCustomerGrantCodeResponses, CreateEmbeddingData, CreateEmbeddingErrors, CreateEmbeddingResponses, CreateImageData, CreateImageErrors, CreateImageResponses, CreateMessageData, CreateMessageErrors, CreateMessageResponses, CreateOcrData, CreateOcrErrors, CreateOcrResponses, CreateOrganizationFeedbackData, CreateOrganizationFeedbackErrors, CreateOrganizationFeedbackMessageData, CreateOrganizationFeedbackMessageErrors, CreateOrganizationFeedbackMessageResponses, CreateOrganizationFeedbackResponses, CreateResponseData, CreateResponseErrors, CreateResponseResponses, CreateVideoData, CreateVideoErrors, CreateVideoResponses, DatabaseAddFieldData, DatabaseAddFieldErrors, DatabaseAddFieldResponses, DatabaseCreateDatabaseData, DatabaseCreateDatabaseErrors, DatabaseCreateDatabaseResponses, DatabaseCreateTableData, DatabaseCreateTableErrors, DatabaseCreateTableResponses, DatabaseDeleteData, DatabaseDeleteDatabaseData, DatabaseDeleteDatabaseErrors, DatabaseDeleteDatabaseResponses, DatabaseDeleteErrors, DatabaseDeleteFieldData, DatabaseDeleteFieldErrors, DatabaseDeleteFieldResponses, DatabaseDeleteResponses, DatabaseDeleteTableData, DatabaseDeleteTableErrors, DatabaseDeleteTableResponses, DatabaseGetDatabaseData, DatabaseGetDatabaseErrors, DatabaseGetDatabaseResponses, DatabaseGetTableData, DatabaseGetTableErrors, DatabaseGetTableResponses, DatabaseHeadData, DatabaseHeadErrors, DatabaseHeadResponses, DatabaseInsertData, DatabaseInsertErrors, DatabaseInsertResponses, DatabaseListDatabasesData, DatabaseListDatabasesErrors, DatabaseListDatabasesResponses, DatabaseListEventsData, DatabaseListEventsErrors, DatabaseListEventsResponses, DatabaseListTablesData, DatabaseListTablesErrors, DatabaseListTablesResponses, DatabasePurgeDatabaseData, DatabasePurgeDatabaseErrors, DatabasePurgeDatabaseResponses, DatabaseRestoreDatabaseData, DatabaseRestoreDatabaseErrors, DatabaseRestoreDatabaseResponses, DatabaseSelectData, DatabaseSelectErrors, DatabaseSelectResponses, DatabaseUpdateData, DatabaseUpdateDatabaseData, DatabaseUpdateDatabaseErrors, DatabaseUpdateDatabaseResponses, DatabaseUpdateErrors, DatabaseUpdateFieldData, DatabaseUpdateFieldErrors, DatabaseUpdateFieldResponses, DatabaseUpdateResponses, DatabaseUpdateTableData, DatabaseUpdateTableErrors, DatabaseUpdateTableResponses, DeleteConversationData, DeleteConversationErrors, DeleteConversationItemData, DeleteConversationItemErrors, DeleteConversationItemResponses, DeleteConversationResponses, DeleteCurrentCustomerAccessTokenData, DeleteCurrentCustomerAccessTokenErrors, DeleteCurrentCustomerAccessTokenResponses, DeleteCustomerData, DeleteCustomerErrors, DeleteCustomerResponses, DeleteResponseData, DeleteResponseResponses, DeleteRunFeedbackData, DeleteRunFeedbackErrors, DeleteRunFeedbackResponses, DeleteSandboxV1SandboxesBySandboxIdData, DeleteSandboxV1SandboxesBySandboxIdErrors, DeleteSandboxV1SandboxesBySandboxIdResponses, DeleteSandboxV1SnapshotsBySnapshotIdData, DeleteSandboxV1SnapshotsBySnapshotIdErrors, DeleteSandboxV1SnapshotsBySnapshotIdResponses, DeleteSandboxV1VolumesByVolumeIdData, DeleteSandboxV1VolumesByVolumeIdErrors, DeleteSandboxV1VolumesByVolumeIdResponses, DeleteVideoData, DeleteVideoErrors, DeleteVideoResponses, DeploymentRunsListData, DeploymentRunsListErrors, DeploymentRunsListResponses, DeploymentRunsRetrieveData, DeploymentRunsRetrieveErrors, DeploymentRunsRetrieveResponses, DeploymentsArchiveData, DeploymentsArchiveErrors, DeploymentsArchiveResponses, DeploymentsCreateData, DeploymentsCreateErrors, DeploymentsCreateResponses, DeploymentsListData, DeploymentsListErrors, DeploymentsListResponses, DeploymentsPauseData, DeploymentsPauseErrors, DeploymentsPauseResponses, DeploymentsRetrieveData, DeploymentsRetrieveErrors, DeploymentsRetrieveResponses, DeploymentsRunData, DeploymentsRunErrors, DeploymentsRunResponses, DeploymentsUnpauseData, DeploymentsUnpauseErrors, DeploymentsUnpauseResponses, DeploymentsUpdateData, DeploymentsUpdateErrors, DeploymentsUpdateResponses, DownloadVideoContentData, DownloadVideoContentErrors, DownloadVideoContentResponses, EditImageData, EditImageErrors, EditImageResponses, EnvironmentsArchiveData, EnvironmentsArchiveErrors, EnvironmentsArchiveResponses, EnvironmentsCreateData, EnvironmentsCreateErrors, EnvironmentsCreateResponses, EnvironmentsListData, EnvironmentsListErrors, EnvironmentsListResponses, EnvironmentsRetrieveData, EnvironmentsRetrieveErrors, EnvironmentsRetrieveResponses, EnvironmentsUpdateData, EnvironmentsUpdateErrors, EnvironmentsUpdateResponses, ExportOrganizationChargesData, ExportOrganizationChargesErrors, ExportOrganizationChargesResponses, ExtendSandboxData, ExtendSandboxErrors, ExtendSandboxResponses, FileAddUploadPartData, FileAddUploadPartErrors, FileAddUploadPartResponses, FileCancelUploadData, FileCancelUploadErrors, FileCancelUploadResponses, FileCompleteUploadData, FileCompleteUploadErrors, FileCompleteUploadResponses, FileCreateFileData, FileCreateFileErrors, FileCreateFileResponses, FileCreateUploadData, FileCreateUploadErrors, FileCreateUploadResponses, FileDeleteFileData, FileDeleteFileErrors, FileDeleteFileResponses, FileListFilesData, FileListFilesErrors, FileListFilesResponses, FileRetrieveFileContentData, FileRetrieveFileContentErrors, FileRetrieveFileContentResponses, FileRetrieveFileData, FileRetrieveFileErrors, FileRetrieveFileResponses, ForkSessionData, ForkSessionErrors, ForkSessionResponses, GetAgentAppearanceData, GetAgentAppearanceErrors, GetAgentAppearanceResponses, GetCustomerData, GetCustomerDeletionData, GetCustomerDeletionErrors, GetCustomerDeletionResponses, GetCustomerErrors, GetCustomerResponses, GetGenerationData, GetGenerationErrors, GetGenerationResponses, GetObservedProcessOutputData, GetObservedProcessOutputErrors, GetObservedProcessOutputResponses, GetOrganizationEventData, GetOrganizationEventErrors, GetOrganizationEventResponses, GetOrganizationFeedbackCountsData, GetOrganizationFeedbackCountsErrors, GetOrganizationFeedbackCountsResponses, GetOrganizationFeedbackData, GetOrganizationFeedbackErrors, GetOrganizationFeedbackResponses, GetSandboxV1SandboxesBySandboxIdData, GetSandboxV1SandboxesBySandboxIdErrors, GetSandboxV1SandboxesBySandboxIdLogsData, GetSandboxV1SandboxesBySandboxIdLogsErrors, GetSandboxV1SandboxesBySandboxIdLogsResponses, GetSandboxV1SandboxesBySandboxIdMetricsData, GetSandboxV1SandboxesBySandboxIdMetricsErrors, GetSandboxV1SandboxesBySandboxIdMetricsResponses, GetSandboxV1SandboxesBySandboxIdResponses, GetSandboxV1SandboxesData, GetSandboxV1SandboxesErrors, GetSandboxV1SandboxesResponses, GetSandboxV1SnapshotsData, GetSandboxV1SnapshotsErrors, GetSandboxV1SnapshotsResponses, GetSandboxV1TemplatesData, GetSandboxV1TemplatesErrors, GetSandboxV1TemplatesResponses, GetSandboxV1VolumesByVolumeIdData, GetSandboxV1VolumesByVolumeIdErrors, GetSandboxV1VolumesByVolumeIdResponses, GetSandboxV1VolumesData, GetSandboxV1VolumesErrors, GetSandboxV1VolumesResponses, GetSessionBackgroundTaskOutputData, GetSessionBackgroundTaskOutputErrors, GetSessionBackgroundTaskOutputResponses, GetSessionCompactionData, GetSessionCompactionErrors, GetSessionCompactionResponses, GetSessionContextData, GetSessionContextErrors, GetSessionContextResponses, HealthCheckData, HealthCheckResponses, KnowledgeAttachFileData, KnowledgeAttachFileErrors, KnowledgeAttachFileResponses, KnowledgeCancelFileBatchData, KnowledgeCancelFileBatchErrors, KnowledgeCancelFileBatchResponses, KnowledgeCreateFileBatchData, KnowledgeCreateFileBatchErrors, KnowledgeCreateFileBatchResponses, KnowledgeCreateVectorStoreData, KnowledgeCreateVectorStoreErrors, KnowledgeCreateVectorStoreResponses, KnowledgeDeleteVectorStoreData, KnowledgeDeleteVectorStoreErrors, KnowledgeDeleteVectorStoreResponses, KnowledgeListBatchFilesData, KnowledgeListBatchFilesErrors, KnowledgeListBatchFilesResponses, KnowledgeListEventsData, KnowledgeListEventsErrors, KnowledgeListEventsResponses, KnowledgeListFilesData, KnowledgeListFilesErrors, KnowledgeListFilesResponses, KnowledgeListSegmentsData, KnowledgeListSegmentsErrors, KnowledgeListSegmentsResponses, KnowledgeListVectorStoresData, KnowledgeListVectorStoresErrors, KnowledgeListVectorStoresResponses, KnowledgePurgeVectorStoreData, KnowledgePurgeVectorStoreErrors, KnowledgePurgeVectorStoreResponses, KnowledgeRemoveFileData, KnowledgeRemoveFileErrors, KnowledgeRemoveFileResponses, KnowledgeRestoreVectorStoreData, KnowledgeRestoreVectorStoreErrors, KnowledgeRestoreVectorStoreResponses, KnowledgeRetrieveFileBatchData, KnowledgeRetrieveFileBatchErrors, KnowledgeRetrieveFileBatchResponses, KnowledgeRetrieveFileContentData, KnowledgeRetrieveFileContentErrors, KnowledgeRetrieveFileContentResponses, KnowledgeRetrieveFileData, KnowledgeRetrieveFileErrors, KnowledgeRetrieveFileResponses, KnowledgeRetrieveSegmentData, KnowledgeRetrieveSegmentErrors, KnowledgeRetrieveSegmentResponses, KnowledgeRetrieveVectorStoreData, KnowledgeRetrieveVectorStoreErrors, KnowledgeRetrieveVectorStoreResponses, KnowledgeRetryFileData, KnowledgeRetryFileErrors, KnowledgeRetryFileResponses, KnowledgeSearchVectorStoreData, KnowledgeSearchVectorStoreErrors, KnowledgeSearchVectorStoreResponses, KnowledgeUpdateFileData, KnowledgeUpdateFileErrors, KnowledgeUpdateFileResponses, KnowledgeUpdateVectorStoreData, KnowledgeUpdateVectorStoreErrors, KnowledgeUpdateVectorStoreResponses, ListConversationItemsData, ListConversationItemsErrors, ListConversationItemsResponses, ListCustomersData, ListCustomersErrors, ListCustomersResponses, ListModelsData, ListModelsErrors, ListModelsResponses, ListObservedProcessesData, ListObservedProcessesErrors, ListObservedProcessesResponses, ListOrganizationCostsData, ListOrganizationCostsErrors, ListOrganizationCostsResponses, ListOrganizationEventsData, ListOrganizationEventsErrors, ListOrganizationEventsResponses, ListOrganizationFeedbackData, ListOrganizationFeedbackErrors, ListOrganizationFeedbackMessagesData, ListOrganizationFeedbackMessagesErrors, ListOrganizationFeedbackMessagesResponses, ListOrganizationFeedbackResponses, ListOrganizationUsageData, ListOrganizationUsageErrors, ListOrganizationUsageResponses, ListResponseInputItemsData, ListResponseInputItemsResponses, ListSandboxFilesData, ListSandboxFilesErrors, ListSandboxFilesResponses, ListSessionBackgroundTasksData, ListSessionBackgroundTasksErrors, ListSessionBackgroundTasksResponses, ListSessionCompactionsData, ListSessionCompactionsErrors, ListSessionCompactionsResponses, ListToolsetsData, ListToolsetsErrors, ListToolsetsResponses, ListVideosData, ListVideosErrors, ListVideosResponses, MakeSandboxDirectoryData, MakeSandboxDirectoryErrors, MakeSandboxDirectoryResponses, MediaBatchAssetsData, MediaBatchAssetsErrors, MediaBatchAssetsResponses, MediaCreateBatchData, MediaCreateBatchErrors, MediaCreateBatchResponses, MediaCreateLibraryData, MediaCreateLibraryErrors, MediaCreateLibraryResponses, MediaDeleteAssetData, MediaDeleteAssetErrors, MediaDeleteAssetResponses, MediaDeleteLibraryData, MediaDeleteLibraryErrors, MediaDeleteLibraryResponses, MediaExpressionSearchData, MediaExpressionSearchErrors, MediaExpressionSearchResponses, MediaGetAssetData, MediaGetAssetErrors, MediaGetAssetResponses, MediaGetBatchData, MediaGetBatchErrors, MediaGetBatchResponses, MediaGetJobData, MediaGetJobErrors, MediaGetJobResponses, MediaGetLibraryData, MediaGetLibraryErrors, MediaGetLibraryResponses, MediaImportAssetData, MediaImportAssetErrors, MediaImportAssetResponses, MediaListAssetsData, MediaListAssetsErrors, MediaListAssetsResponses, MediaListEventsData, MediaListEventsErrors, MediaListEventsResponses, MediaListFoldersData, MediaListFoldersErrors, MediaListFoldersResponses, MediaListLibrariesData, MediaListLibrariesErrors, MediaListLibrariesResponses, MediaListUnderstandingsData, MediaListUnderstandingsErrors, MediaListUnderstandingsResponses, MediaPurgeLibraryData, MediaPurgeLibraryErrors, MediaPurgeLibraryResponses, MediaReprocessAssetData, MediaReprocessAssetErrors, MediaReprocessAssetResponses, MediaRestoreLibraryData, MediaRestoreLibraryErrors, MediaRestoreLibraryResponses, MediaSearchData, MediaSearchErrors, MediaSearchResponses, MediaSemanticSearchData, MediaSemanticSearchErrors, MediaSemanticSearchResponses, MediaUpdateAssetData, MediaUpdateAssetErrors, MediaUpdateAssetResponses, MediaUpdateLibraryData, MediaUpdateLibraryErrors, MediaUpdateLibraryResponses, MediaUploadAssetData, MediaUploadAssetErrors, MediaUploadAssetResponses, MediaVisualSearchData, MediaVisualSearchErrors, MediaVisualSearchResponses, MetaMethodsRetrieveData, MetaMethodsRetrieveErrors, MetaMethodsRetrieveResponses, MetaMethodsSearchData, MetaMethodsSearchErrors, MetaMethodsSearchResponses, PostSandboxV1SandboxesBySandboxIdConnectData, PostSandboxV1SandboxesBySandboxIdConnectErrors, PostSandboxV1SandboxesBySandboxIdConnectResponses, PostSandboxV1SandboxesBySandboxIdForkData, PostSandboxV1SandboxesBySandboxIdForkErrors, PostSandboxV1SandboxesBySandboxIdForkResponses, PostSandboxV1SandboxesBySandboxIdPauseData, PostSandboxV1SandboxesBySandboxIdPauseErrors, PostSandboxV1SandboxesBySandboxIdPauseResponses, PostSandboxV1SandboxesBySandboxIdSnapshotsData, PostSandboxV1SandboxesBySandboxIdSnapshotsErrors, PostSandboxV1SandboxesBySandboxIdSnapshotsResponses, PostSandboxV1SandboxesBySandboxIdTimeoutData, PostSandboxV1SandboxesBySandboxIdTimeoutErrors, PostSandboxV1SandboxesBySandboxIdTimeoutResponses, PostSandboxV1SandboxesData, PostSandboxV1SandboxesErrors, PostSandboxV1SandboxesResponses, PostSandboxV1VolumesData, PostSandboxV1VolumesErrors, PostSandboxV1VolumesResponses, PutSandboxV1SandboxesBySandboxIdNetworkData, PutSandboxV1SandboxesBySandboxIdNetworkErrors, PutSandboxV1SandboxesBySandboxIdNetworkResponses, ReadSandboxFileData, ReadSandboxFileErrors, ReadSandboxFileResponses, ReleaseComputerLeaseData, ReleaseComputerLeaseErrors, ReleaseComputerLeaseResponses, RemixVideoData, RemixVideoErrors, RemoveSandboxFileData, RemoveSandboxFileErrors, RemoveSandboxFileResponses, RenameSandboxData, RenameSandboxErrors, RenameSandboxResponses, RenewComputerLeaseData, RenewComputerLeaseErrors, RenewComputerLeaseResponses, RenewCustomerAccessTokenData, RenewCustomerAccessTokenErrors, RenewCustomerAccessTokenResponses, RerankData, RerankErrors, RerankResponses, RetrieveConversationData, RetrieveConversationErrors, RetrieveConversationItemData, RetrieveConversationItemErrors, RetrieveConversationItemResponses, RetrieveConversationResponses, RetrieveModelData, RetrieveModelErrors, RetrieveModelResponses, RetrieveResponseData, RetrieveResponseResponses, RetrieveVideoData, RetrieveVideoErrors, RetrieveVideoResponses, RevokeCustomerTokensData, RevokeCustomerTokensErrors, RevokeCustomerTokensResponses, RunSandboxCommandData, RunSandboxCommandErrors, RunSandboxCommandResponses, SearchCrawlData, SearchCrawlErrors, SearchCrawlResponses, SearchExtractData, SearchExtractErrors, SearchExtractResponses, SearchMapData, SearchMapErrors, SearchMapResponses, SearchSearchData, SearchSearchErrors, SearchSearchResponses, SessionsArchiveData, SessionsArchiveErrors, SessionsArchiveResponses, SessionsCreateData, SessionsCreateErrors, SessionsCreateResponses, SessionsDeleteData, SessionsDeleteErrors, SessionsDeleteResponses, SessionsEventsListData, SessionsEventsListErrors, SessionsEventsListResponses, SessionsEventsSendData, SessionsEventsSendErrors, SessionsEventsSendResponses, SessionsEventsStreamData, SessionsEventsStreamResponse, SessionsEventsStreamResponses, SessionsListData, SessionsListErrors, SessionsListResponses, SessionsResourcesAddData, SessionsResourcesAddErrors, SessionsResourcesAddResponses, SessionsResourcesDeleteData, SessionsResourcesDeleteErrors, SessionsResourcesDeleteResponses, SessionsResourcesListData, SessionsResourcesListErrors, SessionsResourcesListResponses, SessionsResourcesRetrieveData, SessionsResourcesRetrieveErrors, SessionsResourcesRetrieveResponses, SessionsRetrieveData, SessionsRetrieveErrors, SessionsRetrieveResponses, SessionsThreadsArchiveData, SessionsThreadsArchiveErrors, SessionsThreadsArchiveResponses, SessionsThreadsEventsListData, SessionsThreadsEventsListErrors, SessionsThreadsEventsListResponses, SessionsThreadsEventsStreamData, SessionsThreadsEventsStreamResponse, SessionsThreadsEventsStreamResponses, SessionsThreadsListData, SessionsThreadsListErrors, SessionsThreadsListResponses, SessionsThreadsRetrieveData, SessionsThreadsRetrieveErrors, SessionsThreadsRetrieveResponses, SessionsUpdateData, SessionsUpdateErrors, SessionsUpdateResponses, SetRunFeedbackData, SetRunFeedbackErrors, SetRunFeedbackResponses, SkillsCreateData, SkillsCreateErrors, SkillsCreateResponses, SkillsDeleteData, SkillsDeleteErrors, SkillsDeleteResponses, SkillsListData, SkillsListErrors, SkillsListResponses, SkillsRetrieveData, SkillsRetrieveErrors, SkillsRetrieveResponses, SkillsVersionsCreateData, SkillsVersionsCreateErrors, SkillsVersionsCreateResponses, SkillsVersionsDeleteData, SkillsVersionsDeleteErrors, SkillsVersionsDeleteResponses, SkillsVersionsDownloadData, SkillsVersionsDownloadErrors, SkillsVersionsDownloadResponses, SkillsVersionsListData, SkillsVersionsListErrors, SkillsVersionsListResponses, SkillsVersionsRetrieveData, SkillsVersionsRetrieveErrors, SkillsVersionsRetrieveResponses, StopSessionBackgroundTaskData, StopSessionBackgroundTaskErrors, StopSessionBackgroundTaskResponses, TicketDeleteCommentsIdData, TicketDeleteCommentsIdErrors, TicketDeleteCommentsIdReactionsContentData, TicketDeleteCommentsIdReactionsContentErrors, TicketDeleteCommentsIdReactionsContentResponses, TicketDeleteCommentsIdResponses, TicketDeleteLabelsNameData, TicketDeleteLabelsNameErrors, TicketDeleteLabelsNameResponses, TicketDeleteMilestonesNumberData, TicketDeleteMilestonesNumberErrors, TicketDeleteMilestonesNumberResponses, TicketDeleteTicketsNumberDependenciesBlockedByNData, TicketDeleteTicketsNumberDependenciesBlockedByNErrors, TicketDeleteTicketsNumberDependenciesBlockedByNResponses, TicketDeleteTicketsNumberLockData, TicketDeleteTicketsNumberLockErrors, TicketDeleteTicketsNumberLockResponses, TicketDeleteTicketsNumberReactionsContentData, TicketDeleteTicketsNumberReactionsContentErrors, TicketDeleteTicketsNumberReactionsContentResponses, TicketDeleteTicketsNumberRelationsNData, TicketDeleteTicketsNumberRelationsNErrors, TicketDeleteTicketsNumberRelationsNResponses, TicketDeleteTicketsNumberSubTicketsChildData, TicketDeleteTicketsNumberSubTicketsChildErrors, TicketDeleteTicketsNumberSubTicketsChildResponses, TicketGetActivityData, TicketGetActivityErrors, TicketGetActivityResponses, TicketGetCommentsIdData, TicketGetCommentsIdErrors, TicketGetCommentsIdReactionsData, TicketGetCommentsIdReactionsErrors, TicketGetCommentsIdReactionsResponses, TicketGetCommentsIdResponses, TicketGetLabelsData, TicketGetLabelsErrors, TicketGetLabelsResponses, TicketGetMilestonesData, TicketGetMilestonesErrors, TicketGetMilestonesNumberData, TicketGetMilestonesNumberErrors, TicketGetMilestonesNumberResponses, TicketGetMilestonesResponses, TicketGetRepositoriesData, TicketGetRepositoriesErrors, TicketGetRepositoriesResponses, TicketGetTicketsData, TicketGetTicketsErrors, TicketGetTicketsNumberCommentsData, TicketGetTicketsNumberCommentsErrors, TicketGetTicketsNumberCommentsResponses, TicketGetTicketsNumberData, TicketGetTicketsNumberDependenciesBlockedByData, TicketGetTicketsNumberDependenciesBlockedByErrors, TicketGetTicketsNumberDependenciesBlockedByResponses, TicketGetTicketsNumberDependenciesBlockingData, TicketGetTicketsNumberDependenciesBlockingErrors, TicketGetTicketsNumberDependenciesBlockingResponses, TicketGetTicketsNumberErrors, TicketGetTicketsNumberEventsData, TicketGetTicketsNumberEventsErrors, TicketGetTicketsNumberEventsResponses, TicketGetTicketsNumberReactionsData, TicketGetTicketsNumberReactionsErrors, TicketGetTicketsNumberReactionsResponses, TicketGetTicketsNumberRelationsData, TicketGetTicketsNumberRelationsErrors, TicketGetTicketsNumberRelationsResponses, TicketGetTicketsNumberResponses, TicketGetTicketsNumberSubTicketsData, TicketGetTicketsNumberSubTicketsErrors, TicketGetTicketsNumberSubTicketsResponses, TicketGetTicketsResponses, TicketGetTypesData, TicketGetTypesErrors, TicketGetTypesResponses, TicketPatchCommentsIdData, TicketPatchCommentsIdErrors, TicketPatchCommentsIdResponses, TicketPatchLabelsNameData, TicketPatchLabelsNameErrors, TicketPatchLabelsNameResponses, TicketPatchMilestonesNumberData, TicketPatchMilestonesNumberErrors, TicketPatchMilestonesNumberResponses, TicketPatchTicketsNumberData, TicketPatchTicketsNumberErrors, TicketPatchTicketsNumberResponses, TicketPostCommentsIdReactionsData, TicketPostCommentsIdReactionsErrors, TicketPostCommentsIdReactionsResponses, TicketPostLabelsData, TicketPostLabelsErrors, TicketPostLabelsResponses, TicketPostMilestonesData, TicketPostMilestonesErrors, TicketPostMilestonesResponses, TicketPostTicketsData, TicketPostTicketsErrors, TicketPostTicketsNumberCommentsData, TicketPostTicketsNumberCommentsErrors, TicketPostTicketsNumberCommentsResponses, TicketPostTicketsNumberDependenciesBlockedByData, TicketPostTicketsNumberDependenciesBlockedByErrors, TicketPostTicketsNumberDependenciesBlockedByResponses, TicketPostTicketsNumberReactionsData, TicketPostTicketsNumberReactionsErrors, TicketPostTicketsNumberReactionsResponses, TicketPostTicketsNumberRelationsData, TicketPostTicketsNumberRelationsErrors, TicketPostTicketsNumberRelationsResponses, TicketPostTicketsNumberSubTicketsData, TicketPostTicketsNumberSubTicketsErrors, TicketPostTicketsNumberSubTicketsResponses, TicketPostTicketsResponses, TicketPutTicketsNumberLockData, TicketPutTicketsNumberLockErrors, TicketPutTicketsNumberLockResponses, UnarchiveAgentData, UnarchiveAgentErrors, UnarchiveAgentResponses, UnblockCustomerData, UnblockCustomerErrors, UnblockCustomerResponses, UpdateConversationData, UpdateConversationErrors, UpdateConversationResponses, UpgradeSandboxData, UpgradeSandboxErrors, UpgradeSandboxResponses, VaultArchiveSecretData, VaultArchiveSecretErrors, VaultArchiveSecretResponses, VaultArchiveVaultData, VaultArchiveVaultErrors, VaultArchiveVaultResponses, VaultAuthorizationCallbackData, VaultAuthorizationCallbackResponses, VaultCheckVaultsData, VaultCheckVaultsErrors, VaultCheckVaultsResponses, VaultConnectContinueData, VaultConnectDenyData, VaultConnectDenyResponses, VaultConnectPageData, VaultConnectPageErrors, VaultConnectPageResponses, VaultCreateAuthorizationData, VaultCreateAuthorizationErrors, VaultCreateAuthorizationResponses, VaultCreateSecretData, VaultCreateSecretErrors, VaultCreateSecretResponses, VaultCreateVaultData, VaultCreateVaultErrors, VaultCreateVaultResponses, VaultDeleteSecretData, VaultDeleteSecretErrors, VaultDeleteSecretResponses, VaultDeleteVaultData, VaultDeleteVaultErrors, VaultDeleteVaultResponses, VaultGetAuthorizationData, VaultGetAuthorizationErrors, VaultGetAuthorizationResponses, VaultGetReturnUrlsData, VaultGetReturnUrlsErrors, VaultGetReturnUrlsResponses, VaultGetSecretData, VaultGetSecretErrors, VaultGetSecretResponses, VaultGetVaultData, VaultGetVaultErrors, VaultGetVaultResponses, VaultImportSecretsData, VaultImportSecretsErrors, VaultImportSecretsResponses, VaultListEventsData, VaultListEventsErrors, VaultListEventsResponses, VaultListSecretsData, VaultListSecretsErrors, VaultListSecretsResponses, VaultListTemplatesData, VaultListTemplatesErrors, VaultListTemplatesResponses, VaultListVaultsData, VaultListVaultsErrors, VaultListVaultsResponses, VaultOAuthClientMetadataData, VaultOAuthClientMetadataResponses, VaultRefreshSecretData, VaultRefreshSecretErrors, VaultRefreshSecretResponses, VaultSetReturnUrlsData, VaultSetReturnUrlsErrors, VaultSetReturnUrlsResponses, VaultUpdateSecretData, VaultUpdateSecretErrors, VaultUpdateSecretResponses, VaultUpdateVaultData, VaultUpdateVaultErrors, VaultUpdateVaultResponses, VaultValidateSecretData, VaultValidateSecretErrors, VaultValidateSecretResponses, WriteSandboxFileData, WriteSandboxFileErrors, WriteSandboxFileResponses } from './types.gen.js';
|
|
2
|
+
import type { AgentsArchiveData, AgentsArchiveErrors, AgentsArchiveResponses, AgentsCreateData, AgentsCreateErrors, AgentsCreateResponses, AgentsListData, AgentsListErrors, AgentsListResponses, AgentsRetrieveData, AgentsRetrieveErrors, AgentsRetrieveResponses, AgentsUpdateData, AgentsUpdateErrors, AgentsUpdateResponses, AgentsVersionsListData, AgentsVersionsListErrors, AgentsVersionsListResponses, ApplicationCreateAssetUploadSessionData, ApplicationCreateAssetUploadSessionErrors, ApplicationCreateAssetUploadSessionResponses, ApplicationCreateDeploymentData, ApplicationCreateDeploymentErrors, ApplicationCreateDeploymentResponses, ApplicationCreateGrantData, ApplicationCreateGrantErrors, ApplicationCreateGrantResponses, ApplicationCreateVersionData, ApplicationCreateVersionErrors, ApplicationCreateVersionResponses, ApplicationCreateWorkerData, ApplicationCreateWorkerErrors, ApplicationCreateWorkerResponses, ApplicationDeleteGrantData, ApplicationDeleteGrantErrors, ApplicationDeleteGrantResponses, ApplicationDeleteSecretData, ApplicationDeleteSecretErrors, ApplicationDeleteSecretResponses, ApplicationDeleteWorkerData, ApplicationDeleteWorkerErrors, ApplicationDeleteWorkerResponses, ApplicationGetDeploymentData, ApplicationGetDeploymentErrors, ApplicationGetDeploymentResponses, ApplicationGetSubdomainData, ApplicationGetSubdomainErrors, ApplicationGetSubdomainResponses, ApplicationGetVersionAssetManifestData, ApplicationGetVersionAssetManifestErrors, ApplicationGetVersionAssetManifestResponses, ApplicationGetVersionData, ApplicationGetVersionErrors, ApplicationGetVersionResponses, ApplicationGetWorkerData, ApplicationGetWorkerErrors, ApplicationGetWorkerResponses, ApplicationListComponentsData, ApplicationListComponentsErrors, ApplicationListComponentsResponses, ApplicationListDeploymentsData, ApplicationListDeploymentsErrors, ApplicationListDeploymentsResponses, ApplicationListEventsData, ApplicationListEventsErrors, ApplicationListEventsResponses, ApplicationListGrantsData, ApplicationListGrantsErrors, ApplicationListGrantsResponses, ApplicationListSecretsData, ApplicationListSecretsErrors, ApplicationListSecretsResponses, ApplicationListVersionsData, ApplicationListVersionsErrors, ApplicationListVersionsResponses, ApplicationListWorkersData, ApplicationListWorkersErrors, ApplicationListWorkersResponses, ApplicationPutSecretData, ApplicationPutSecretErrors, ApplicationPutSecretResponses, ApplicationPutSubdomainData, ApplicationPutSubdomainErrors, ApplicationPutSubdomainResponses, ApplicationRestoreWorkerData, ApplicationRestoreWorkerErrors, ApplicationRestoreWorkerResponses, ApplicationUpdateWorkerData, ApplicationUpdateWorkerErrors, ApplicationUpdateWorkerResponses, ApplicationUploadAssetsData, ApplicationUploadAssetsErrors, ApplicationUploadAssetsResponses, ApplyAgentVersionData, ApplyAgentVersionErrors, ApplyAgentVersionResponses, AssignTemplateTagsData, AssignTemplateTagsErrors, AssignTemplateTagsResponses, AutomationActionsArchiveData, AutomationActionsArchiveErrors, AutomationActionsArchiveResponses, AutomationActionsCreateData, AutomationActionsCreateErrors, AutomationActionsCreateResponses, AutomationActionsDependentsData, AutomationActionsDependentsErrors, AutomationActionsDependentsResponses, AutomationActionsGetData, AutomationActionsGetErrors, AutomationActionsGetResponses, AutomationActionsInvocationsData, AutomationActionsInvocationsErrors, AutomationActionsInvocationsResponses, AutomationActionsListData, AutomationActionsListErrors, AutomationActionsListResponses, AutomationActionsRestoreData, AutomationActionsRestoreErrors, AutomationActionsRestoreResponses, AutomationActionsRevisionData, AutomationActionsRevisionErrors, AutomationActionsRevisionResponses, AutomationActionsRevisionsData, AutomationActionsRevisionsErrors, AutomationActionsRevisionsResponses, AutomationActionsRollbackData, AutomationActionsRollbackErrors, AutomationActionsRollbackResponses, AutomationActionsUpdateData, AutomationActionsUpdateErrors, AutomationActionsUpdateResponses, AutomationHooksReceiveData, AutomationHooksReceiveErrors, AutomationHooksReceiveResponses, AutomationHumanTasksCancelData, AutomationHumanTasksCancelErrors, AutomationHumanTasksCancelResponses, AutomationHumanTasksDelegateData, AutomationHumanTasksDelegateErrors, AutomationHumanTasksDelegateResponses, AutomationHumanTasksGetData, AutomationHumanTasksGetErrors, AutomationHumanTasksGetResponses, AutomationHumanTasksListData, AutomationHumanTasksListErrors, AutomationHumanTasksListResponses, AutomationHumanTasksRespondData, AutomationHumanTasksRespondErrors, AutomationHumanTasksRespondResponses, AutomationResolveResolveData, AutomationResolveResolveErrors, AutomationResolveResolveResponses, AutomationRunsArtifactsData, AutomationRunsArtifactsErrors, AutomationRunsArtifactsResponses, AutomationRunsCallsData, AutomationRunsCallsErrors, AutomationRunsCallsResponses, AutomationRunsCancelData, AutomationRunsCancelErrors, AutomationRunsCancelResponses, AutomationRunsCompleteWaitData, AutomationRunsCompleteWaitErrors, AutomationRunsCompleteWaitResponses, AutomationRunsCreateData, AutomationRunsCreateErrors, AutomationRunsCreateResponses, AutomationRunsEventsData, AutomationRunsEventsErrors, AutomationRunsEventsResponses, AutomationRunsGetData, AutomationRunsGetErrors, AutomationRunsGetResponses, AutomationRunsListData, AutomationRunsListErrors, AutomationRunsListResponses, AutomationRunsLogsData, AutomationRunsLogsErrors, AutomationRunsLogsResponses, AutomationRunsRerunData, AutomationRunsRerunErrors, AutomationRunsRerunResponses, AutomationRunsResumeData, AutomationRunsResumeErrors, AutomationRunsResumeResponses, AutomationRunsSourceData, AutomationRunsSourceErrors, AutomationRunsSourceResponses, AutomationRunsSuspendData, AutomationRunsSuspendErrors, AutomationRunsSuspendResponses, AutomationRunsTasksData, AutomationRunsTasksErrors, AutomationRunsTasksResponses, AutomationRunsWaitsData, AutomationRunsWaitsErrors, AutomationRunsWaitsResponses, AutomationScriptsArchiveData, AutomationScriptsArchiveErrors, AutomationScriptsArchiveResponses, AutomationScriptsCreateData, AutomationScriptsCreateErrors, AutomationScriptsCreateResponses, AutomationScriptsDeleteDistTagData, AutomationScriptsDeleteDistTagErrors, AutomationScriptsDeleteDistTagResponses, AutomationScriptsDeprecateData, AutomationScriptsDeprecateErrors, AutomationScriptsDeprecateResponses, AutomationScriptsDistTagsData, AutomationScriptsDistTagsErrors, AutomationScriptsDistTagsResponses, AutomationScriptsGetData, AutomationScriptsGetErrors, AutomationScriptsGetResponses, AutomationScriptsListData, AutomationScriptsListErrors, AutomationScriptsListResponses, AutomationScriptsPatchData, AutomationScriptsPatchErrors, AutomationScriptsPatchResponses, AutomationScriptsPublishData, AutomationScriptsPublishErrors, AutomationScriptsPublishResponses, AutomationScriptsRestoreData, AutomationScriptsRestoreErrors, AutomationScriptsRestoreResponses, AutomationScriptsSetDistTagData, AutomationScriptsSetDistTagErrors, AutomationScriptsSetDistTagResponses, AutomationScriptsVaultsDeleteData, AutomationScriptsVaultsDeleteErrors, AutomationScriptsVaultsDeleteResponses, AutomationScriptsVaultsListData, AutomationScriptsVaultsListErrors, AutomationScriptsVaultsListResponses, AutomationScriptsVaultsSetData, AutomationScriptsVaultsSetErrors, AutomationScriptsVaultsSetResponses, AutomationScriptsVersionData, AutomationScriptsVersionErrors, AutomationScriptsVersionResponses, AutomationScriptsVersionsData, AutomationScriptsVersionsErrors, AutomationScriptsVersionsResponses, AutomationTargetsTargetsData, AutomationTargetsTargetsErrors, AutomationTargetsTargetsResponses, AutomationTriggersCreateData, AutomationTriggersCreateErrors, AutomationTriggersCreateResponses, AutomationTriggersDeleteData, AutomationTriggersDeleteErrors, AutomationTriggersDeleteResponses, AutomationTriggersFireData, AutomationTriggersFireErrors, AutomationTriggersFireResponses, AutomationTriggersFiringsData, AutomationTriggersFiringsErrors, AutomationTriggersFiringsResponses, AutomationTriggersGetData, AutomationTriggersGetErrors, AutomationTriggersGetResponses, AutomationTriggersListData, AutomationTriggersListErrors, AutomationTriggersListResponses, AutomationTriggersPatchData, AutomationTriggersPatchErrors, AutomationTriggersPatchResponses, AutomationTriggersPauseData, AutomationTriggersPauseErrors, AutomationTriggersPauseResponses, AutomationTriggersPreviewData, AutomationTriggersPreviewErrors, AutomationTriggersPreviewResponses, AutomationTriggersResumeData, AutomationTriggersResumeErrors, AutomationTriggersResumeResponses, AutomationTriggersRotateWebhookData, AutomationTriggersRotateWebhookErrors, AutomationTriggersRotateWebhookResponses, AutomationValidateValidateData, AutomationValidateValidateErrors, AutomationValidateValidateResponses, AutomationWorkflowsArchiveData, AutomationWorkflowsArchiveErrors, AutomationWorkflowsArchiveResponses, AutomationWorkflowsCreateData, AutomationWorkflowsCreateErrors, AutomationWorkflowsCreateResponses, AutomationWorkflowsDeleteDistTagData, AutomationWorkflowsDeleteDistTagErrors, AutomationWorkflowsDeleteDistTagResponses, AutomationWorkflowsDeprecateData, AutomationWorkflowsDeprecateErrors, AutomationWorkflowsDeprecateResponses, AutomationWorkflowsDistTagsData, AutomationWorkflowsDistTagsErrors, AutomationWorkflowsDistTagsResponses, AutomationWorkflowsGetData, AutomationWorkflowsGetErrors, AutomationWorkflowsGetResponses, AutomationWorkflowsListData, AutomationWorkflowsListErrors, AutomationWorkflowsListResponses, AutomationWorkflowsPatchData, AutomationWorkflowsPatchErrors, AutomationWorkflowsPatchResponses, AutomationWorkflowsPublishData, AutomationWorkflowsPublishErrors, AutomationWorkflowsPublishResponses, AutomationWorkflowsRestoreData, AutomationWorkflowsRestoreErrors, AutomationWorkflowsRestoreResponses, AutomationWorkflowsSetDistTagData, AutomationWorkflowsSetDistTagErrors, AutomationWorkflowsSetDistTagResponses, AutomationWorkflowsVaultsDeleteData, AutomationWorkflowsVaultsDeleteErrors, AutomationWorkflowsVaultsDeleteResponses, AutomationWorkflowsVaultsListData, AutomationWorkflowsVaultsListErrors, AutomationWorkflowsVaultsListResponses, AutomationWorkflowsVaultsSetData, AutomationWorkflowsVaultsSetErrors, AutomationWorkflowsVaultsSetResponses, AutomationWorkflowsVersionData, AutomationWorkflowsVersionErrors, AutomationWorkflowsVersionResponses, AutomationWorkflowsVersionsData, AutomationWorkflowsVersionsErrors, AutomationWorkflowsVersionsResponses, BlockCustomerData, BlockCustomerErrors, BlockCustomerResponses, BrowserCloseSessionData, BrowserCloseSessionErrors, BrowserCloseSessionResponses, BrowserCompleteHandoffData, BrowserCompleteHandoffErrors, BrowserCompleteHandoffResponses, BrowserConnectData, BrowserConnectErrors, BrowserCreateContextData, BrowserCreateContextErrors, BrowserCreateContextResponses, BrowserCreateSessionData, BrowserCreateSessionErrors, BrowserCreateSessionResponses, BrowserDeleteContextData, BrowserDeleteContextErrors, BrowserDeleteContextResponses, BrowserGetContextData, BrowserGetContextErrors, BrowserGetContextResponses, BrowserGetDebugData, BrowserGetDebugErrors, BrowserGetDebugResponses, BrowserGetSessionData, BrowserGetSessionErrors, BrowserGetSessionResponses, BrowserListContextsData, BrowserListContextsErrors, BrowserListContextsResponses, BrowserListEventsData, BrowserListEventsErrors, BrowserListEventsResponses, BrowserListSessionsData, BrowserListSessionsErrors, BrowserListSessionsResponses, BrowserLiveViewData, BrowserLiveViewErrors, BrowserRequestHandoffData, BrowserRequestHandoffErrors, BrowserRequestHandoffResponses, BrowserRunPageActionData, BrowserRunPageActionErrors, BrowserRunPageActionResponses, BrowserSeleniumUnsupportedData, BrowserSeleniumUnsupportedErrors, BrowserStreamSessionData, BrowserStreamSessionResponse, BrowserStreamSessionResponses, BrowserUpdateContextData, BrowserUpdateContextErrors, BrowserUpdateContextResponses, BrowserViewerHeartbeatData, BrowserViewerHeartbeatErrors, BrowserViewerHeartbeatResponses, CancelResponseData, CancelResponseErrors, CancelResponseResponses, CanvasCreateCanvasData, CanvasCreateCanvasErrors, CanvasCreateCanvasResponses, CanvasCreateCollectionData, CanvasCreateCollectionErrors, CanvasCreateCollectionResponses, CanvasDeleteCanvasData, CanvasDeleteCanvasErrors, CanvasDeleteCanvasResponses, CanvasDeleteCollectionData, CanvasDeleteCollectionErrors, CanvasDeleteCollectionResponses, CanvasExecuteData, CanvasExecuteErrors, CanvasExecuteResponses, CanvasListCanvasesData, CanvasListCanvasesErrors, CanvasListCanvasesResponses, CanvasListCollectionsData, CanvasListCollectionsErrors, CanvasListCollectionsResponses, CanvasListImagesData, CanvasListImagesErrors, CanvasListImagesResponses, CanvasListNodesData, CanvasListNodesErrors, CanvasListNodesResponses, CanvasListVersionsData, CanvasListVersionsErrors, CanvasListVersionsResponses, CanvasRestoreCanvasData, CanvasRestoreCanvasErrors, CanvasRestoreCanvasResponses, CanvasRetrieveCanvasData, CanvasRetrieveCanvasErrors, CanvasRetrieveCanvasResponses, CanvasRetrieveCollectionData, CanvasRetrieveCollectionErrors, CanvasRetrieveCollectionResponses, CanvasUpdateCanvasData, CanvasUpdateCanvasErrors, CanvasUpdateCanvasResponses, CanvasUpdateCollectionData, CanvasUpdateCollectionErrors, CanvasUpdateCollectionResponses, CompactResponseData, CompactResponseErrors, CompactResponseResponses, CompactSessionData, CompactSessionErrors, CompactSessionResponses, ComputersArchiveData, ComputersArchiveErrors, ComputersArchiveResponses, ComputersAttachmentsCreateData, ComputersAttachmentsCreateErrors, ComputersAttachmentsCreateResponses, ComputersCreateData, ComputersCreateErrors, ComputersCreateResponses, ComputersDeleteData, ComputersDeleteErrors, ComputersDeleteResponses, ComputersFilesContentData, ComputersFilesContentErrors, ComputersFilesContentResponses, ComputersFilesConvertData, ComputersFilesConvertErrors, ComputersFilesConvertResponses, ComputersFilesListData, ComputersFilesListErrors, ComputersFilesListResponses, ComputersListData, ComputersListErrors, ComputersListResponses, ComputersRetrieveData, ComputersRetrieveErrors, ComputersRetrieveResponses, ComputersUpdateData, ComputersUpdateErrors, ComputersUpdateResponses, ConnectComputerData, ConnectComputerErrors, ConnectComputerResponses, CountResponseInputTokensData, CountResponseInputTokensErrors, CountResponseInputTokensResponses, CountTokensData, CountTokensErrors, CountTokensResponses, CreateAudioSpeechData, CreateAudioSpeechErrors, CreateAudioSpeechResponses, CreateAudioTranscriptionData, CreateAudioTranscriptionErrors, CreateAudioTranscriptionResponses, CreateChatCompletionData, CreateChatCompletionErrors, CreateChatCompletionResponses, CreateConversationData, CreateConversationItemsData, CreateConversationItemsErrors, CreateConversationItemsResponses, CreateConversationResponses, CreateCustomerAccessTokenData, CreateCustomerAccessTokenErrors, CreateCustomerAccessTokenResponses, CreateCustomerGrantCodeData, CreateCustomerGrantCodeErrors, CreateCustomerGrantCodeResponses, CreateEmbeddingData, CreateEmbeddingErrors, CreateEmbeddingResponses, CreateImageData, CreateImageErrors, CreateImageResponses, CreateMessageData, CreateMessageErrors, CreateMessageResponses, CreateOcrData, CreateOcrErrors, CreateOcrResponses, CreateOrganizationFeedbackData, CreateOrganizationFeedbackErrors, CreateOrganizationFeedbackMessageData, CreateOrganizationFeedbackMessageErrors, CreateOrganizationFeedbackMessageResponses, CreateOrganizationFeedbackResponses, CreateResponseData, CreateResponseErrors, CreateResponseResponses, CreateSystemoneData, CreateSystemoneErrors, CreateSystemoneResponses, CreateVideoData, CreateVideoErrors, CreateVideoResponses, CrmAssociationsCreateData, CrmAssociationsCreateDefaultData, CrmAssociationsCreateDefaultErrors, CrmAssociationsCreateDefaultResponses, CrmAssociationsCreateErrors, CrmAssociationsCreateResponses, CrmAssociationsListData, CrmAssociationsListErrors, CrmAssociationsListResponses, CrmAssociationsRemoveData, CrmAssociationsRemoveErrors, CrmAssociationsRemoveResponses, CrmChangesRevertData, CrmChangesRevertErrors, CrmChangesRevertResponses, CrmLayoutsRetrieveData, CrmLayoutsRetrieveErrors, CrmLayoutsRetrieveResponses, CrmLayoutsUpdateData, CrmLayoutsUpdateErrors, CrmLayoutsUpdateResponses, CrmLeadsQualifyData, CrmLeadsQualifyErrors, CrmLeadsQualifyResponses, CrmObjectsArchiveData, CrmObjectsArchiveErrors, CrmObjectsArchiveResponses, CrmObjectsBatchArchiveData, CrmObjectsBatchArchiveErrors, CrmObjectsBatchArchiveResponses, CrmObjectsBatchCreateData, CrmObjectsBatchCreateErrors, CrmObjectsBatchCreateResponses, CrmObjectsBatchReadData, CrmObjectsBatchReadErrors, CrmObjectsBatchReadResponses, CrmObjectsBatchUpdateData, CrmObjectsBatchUpdateErrors, CrmObjectsBatchUpdateResponses, CrmObjectsBatchUpsertData, CrmObjectsBatchUpsertErrors, CrmObjectsBatchUpsertResponses, CrmObjectsCreateData, CrmObjectsCreateErrors, CrmObjectsCreateResponses, CrmObjectsListData, CrmObjectsListErrors, CrmObjectsListResponses, CrmObjectsRetrieveData, CrmObjectsRetrieveErrors, CrmObjectsRetrieveResponses, CrmObjectsSearchData, CrmObjectsSearchErrors, CrmObjectsSearchResponses, CrmObjectsUpdateData, CrmObjectsUpdateErrors, CrmObjectsUpdateResponses, CrmPipelinesArchiveData, CrmPipelinesArchiveErrors, CrmPipelinesArchiveResponses, CrmPipelinesCreateData, CrmPipelinesCreateErrors, CrmPipelinesCreateResponses, CrmPipelinesListData, CrmPipelinesListErrors, CrmPipelinesListResponses, CrmPipelinesRetrieveData, CrmPipelinesRetrieveErrors, CrmPipelinesRetrieveResponses, CrmPipelinesStagesArchiveData, CrmPipelinesStagesArchiveErrors, CrmPipelinesStagesArchiveResponses, CrmPipelinesStagesCreateData, CrmPipelinesStagesCreateErrors, CrmPipelinesStagesCreateResponses, CrmPipelinesStagesUpdateData, CrmPipelinesStagesUpdateErrors, CrmPipelinesStagesUpdateResponses, CrmPipelinesUpdateData, CrmPipelinesUpdateErrors, CrmPipelinesUpdateResponses, CrmPropertiesArchiveData, CrmPropertiesArchiveErrors, CrmPropertiesArchiveResponses, CrmPropertiesCreateData, CrmPropertiesCreateErrors, CrmPropertiesCreateResponses, CrmPropertiesGroupsCreateData, CrmPropertiesGroupsCreateErrors, CrmPropertiesGroupsCreateResponses, CrmPropertiesGroupsListData, CrmPropertiesGroupsListErrors, CrmPropertiesGroupsListResponses, CrmPropertiesListData, CrmPropertiesListErrors, CrmPropertiesListResponses, CrmPropertiesRetrieveData, CrmPropertiesRetrieveErrors, CrmPropertiesRetrieveResponses, CrmPropertiesUpdateData, CrmPropertiesUpdateErrors, CrmPropertiesUpdateResponses, CrmSchemasCreateData, CrmSchemasCreateErrors, CrmSchemasCreateResponses, CrmSchemasListData, CrmSchemasListErrors, CrmSchemasListResponses, CutCancelExportData, CutCancelExportErrors, CutCancelExportResponses, CutCreateAnalysisData, CutCreateAnalysisErrors, CutCreateAnalysisResponses, CutCreateBindingData, CutCreateBindingErrors, CutCreateBindingResponses, CutCreateExportData, CutCreateExportErrors, CutCreateExportResponses, CutCreateProjectData, CutCreateProjectErrors, CutCreateProjectResponses, CutCreateRenderData, CutCreateRenderErrors, CutCreateRenderResponses, CutCreateVersionData, CutCreateVersionErrors, CutCreateVersionResponses, CutDeleteBindingData, CutDeleteBindingErrors, CutDeleteBindingResponses, CutDeleteProjectData, CutDeleteProjectErrors, CutDeleteProjectResponses, CutExecuteData, CutExecuteErrors, CutExecuteResponses, CutImportMediaData, CutImportMediaErrors, CutImportMediaResponses, CutListBindingsData, CutListBindingsErrors, CutListBindingsResponses, CutListExportsData, CutListExportsErrors, CutListExportsResponses, CutListFramesData, CutListFramesErrors, CutListFramesResponses, CutListProjectsData, CutListProjectsErrors, CutListProjectsResponses, CutListVersionsData, CutListVersionsErrors, CutListVersionsResponses, CutRestoreVersionData, CutRestoreVersionErrors, CutRestoreVersionResponses, CutRetrieveExportData, CutRetrieveExportErrors, CutRetrieveExportResponses, CutRetrieveProjectData, CutRetrieveProjectErrors, CutRetrieveProjectResponses, CutRetrieveRenderData, CutRetrieveRenderErrors, CutRetrieveRenderResponses, CutRetrieveStateData, CutRetrieveStateErrors, CutRetrieveStateResponses, CutRetrieveTimelineData, CutRetrieveTimelineErrors, CutRetrieveTimelineResponses, CutUndeleteProjectData, CutUndeleteProjectErrors, CutUndeleteProjectResponses, CutUpdateProjectData, CutUpdateProjectErrors, CutUpdateProjectResponses, DatabaseAddFieldData, DatabaseAddFieldErrors, DatabaseAddFieldResponses, DatabaseCreateDatabaseData, DatabaseCreateDatabaseErrors, DatabaseCreateDatabaseResponses, DatabaseCreateTableData, DatabaseCreateTableErrors, DatabaseCreateTableResponses, DatabaseDeleteData, DatabaseDeleteDatabaseData, DatabaseDeleteDatabaseErrors, DatabaseDeleteDatabaseResponses, DatabaseDeleteErrors, DatabaseDeleteFieldData, DatabaseDeleteFieldErrors, DatabaseDeleteFieldResponses, DatabaseDeleteResponses, DatabaseDeleteTableData, DatabaseDeleteTableErrors, DatabaseDeleteTableResponses, DatabaseGetDatabaseData, DatabaseGetDatabaseErrors, DatabaseGetDatabaseResponses, DatabaseGetTableData, DatabaseGetTableErrors, DatabaseGetTableResponses, DatabaseHeadData, DatabaseHeadErrors, DatabaseHeadResponses, DatabaseInsertData, DatabaseInsertErrors, DatabaseInsertResponses, DatabaseListDatabasesData, DatabaseListDatabasesErrors, DatabaseListDatabasesResponses, DatabaseListEventsData, DatabaseListEventsErrors, DatabaseListEventsResponses, DatabaseListTablesData, DatabaseListTablesErrors, DatabaseListTablesResponses, DatabasePurgeDatabaseData, DatabasePurgeDatabaseErrors, DatabasePurgeDatabaseResponses, DatabaseRestoreDatabaseData, DatabaseRestoreDatabaseErrors, DatabaseRestoreDatabaseResponses, DatabaseSelectData, DatabaseSelectErrors, DatabaseSelectResponses, DatabaseUpdateData, DatabaseUpdateDatabaseData, DatabaseUpdateDatabaseErrors, DatabaseUpdateDatabaseResponses, DatabaseUpdateErrors, DatabaseUpdateFieldData, DatabaseUpdateFieldErrors, DatabaseUpdateFieldResponses, DatabaseUpdateResponses, DatabaseUpdateTableData, DatabaseUpdateTableErrors, DatabaseUpdateTableResponses, DeleteConversationData, DeleteConversationErrors, DeleteConversationItemData, DeleteConversationItemErrors, DeleteConversationItemResponses, DeleteConversationResponses, DeleteCurrentCustomerAccessTokenData, DeleteCurrentCustomerAccessTokenErrors, DeleteCurrentCustomerAccessTokenResponses, DeleteCustomerData, DeleteCustomerErrors, DeleteCustomerResponses, DeleteResponseData, DeleteResponseResponses, DeleteRunFeedbackData, DeleteRunFeedbackErrors, DeleteRunFeedbackResponses, DeleteSandboxV1SandboxesBySandboxIdData, DeleteSandboxV1SandboxesBySandboxIdErrors, DeleteSandboxV1SandboxesBySandboxIdResponses, DeleteSandboxV1SnapshotsBySnapshotIdData, DeleteSandboxV1SnapshotsBySnapshotIdErrors, DeleteSandboxV1SnapshotsBySnapshotIdResponses, DeleteSandboxV1VolumesByVolumeIdData, DeleteSandboxV1VolumesByVolumeIdErrors, DeleteSandboxV1VolumesByVolumeIdResponses, DeleteTemplateTagsData, DeleteTemplateTagsErrors, DeleteTemplateTagsResponses, DeleteUserTemplateData, DeleteUserTemplateErrors, DeleteUserTemplateResponses, DeleteVideoData, DeleteVideoErrors, DeleteVideoResponses, DeploymentRunsListData, DeploymentRunsListErrors, DeploymentRunsListResponses, DeploymentRunsRetrieveData, DeploymentRunsRetrieveErrors, DeploymentRunsRetrieveResponses, DeploymentsArchiveData, DeploymentsArchiveErrors, DeploymentsArchiveResponses, DeploymentsCreateData, DeploymentsCreateErrors, DeploymentsCreateResponses, DeploymentsListData, DeploymentsListErrors, DeploymentsListResponses, DeploymentsPauseData, DeploymentsPauseErrors, DeploymentsPauseResponses, DeploymentsRetrieveData, DeploymentsRetrieveErrors, DeploymentsRetrieveResponses, DeploymentsRunData, DeploymentsRunErrors, DeploymentsRunResponses, DeploymentsUnpauseData, DeploymentsUnpauseErrors, DeploymentsUnpauseResponses, DeploymentsUpdateData, DeploymentsUpdateErrors, DeploymentsUpdateResponses, DevopsTestCasesGetData, DevopsTestCasesGetErrors, DevopsTestCasesGetResponses, DevopsTestCasesListData, DevopsTestCasesListErrors, DevopsTestCasesListResponses, DevopsTestCatalogGetData, DevopsTestCatalogGetErrors, DevopsTestCatalogGetResponses, DevopsTestExecutionsGetData, DevopsTestExecutionsGetErrors, DevopsTestExecutionsGetResponses, DevopsTestExecutionsListData, DevopsTestExecutionsListErrors, DevopsTestExecutionsListResponses, DevopsTestPlansCreateData, DevopsTestPlansCreateErrors, DevopsTestPlansCreateResponses, DevopsTestPlansDeleteData, DevopsTestPlansDeleteErrors, DevopsTestPlansDeleteResponses, DevopsTestPlansGetData, DevopsTestPlansGetErrors, DevopsTestPlansGetResponses, DevopsTestPlansListData, DevopsTestPlansListErrors, DevopsTestPlansListResponses, DevopsTestPlansPauseData, DevopsTestPlansPauseErrors, DevopsTestPlansPauseResponses, DevopsTestPlansResumeData, DevopsTestPlansResumeErrors, DevopsTestPlansResumeResponses, DevopsTestPlansUpdateData, DevopsTestPlansUpdateErrors, DevopsTestPlansUpdateResponses, DevopsTestReportsUploadData, DevopsTestReportsUploadErrors, DevopsTestReportsUploadResponses, DevopsTestRunsCancelData, DevopsTestRunsCancelErrors, DevopsTestRunsCancelResponses, DevopsTestRunsCreateData, DevopsTestRunsCreateErrors, DevopsTestRunsCreateResponses, DevopsTestRunsGetData, DevopsTestRunsGetErrors, DevopsTestRunsGetResponses, DevopsTestRunsListData, DevopsTestRunsListErrors, DevopsTestRunsListResponses, DevopsTestSuitesGetData, DevopsTestSuitesGetErrors, DevopsTestSuitesGetResponses, DevopsTestSuitesListData, DevopsTestSuitesListErrors, DevopsTestSuitesListResponses, DownloadVideoContentData, DownloadVideoContentErrors, DownloadVideoContentResponses, EditImageData, EditImageErrors, EditImageResponses, EnvironmentsArchiveData, EnvironmentsArchiveErrors, EnvironmentsArchiveResponses, EnvironmentsCreateData, EnvironmentsCreateErrors, EnvironmentsCreateResponses, EnvironmentsListData, EnvironmentsListErrors, EnvironmentsListResponses, EnvironmentsRetrieveData, EnvironmentsRetrieveErrors, EnvironmentsRetrieveResponses, EnvironmentsUpdateData, EnvironmentsUpdateErrors, EnvironmentsUpdateResponses, ExportOrganizationChargesData, ExportOrganizationChargesErrors, ExportOrganizationChargesResponses, ExtendSandboxData, ExtendSandboxErrors, ExtendSandboxResponses, FileAddUploadPartData, FileAddUploadPartErrors, FileAddUploadPartResponses, FileCancelUploadData, FileCancelUploadErrors, FileCancelUploadResponses, FileCompleteUploadData, FileCompleteUploadErrors, FileCompleteUploadResponses, FileCreateContentUrlData, FileCreateContentUrlErrors, FileCreateContentUrlResponses, FileCreateFileData, FileCreateFileErrors, FileCreateFileResponses, FileCreateSignedUploadData, FileCreateSignedUploadErrors, FileCreateSignedUploadResponses, FileCreateUploadData, FileCreateUploadErrors, FileCreateUploadResponses, FileDeleteFileData, FileDeleteFileErrors, FileDeleteFileResponses, FileListFilesData, FileListFilesErrors, FileListFilesResponses, FileRetrieveFileContentData, FileRetrieveFileContentErrors, FileRetrieveFileContentResponses, FileRetrieveFileData, FileRetrieveFileErrors, FileRetrieveFileResponses, FileRetrieveUploadData, FileRetrieveUploadErrors, FileRetrieveUploadResponses, FileRevokeContentLinkData, FileRevokeContentLinkErrors, FileRevokeContentLinkResponses, ForkSessionData, ForkSessionErrors, ForkSessionResponses, GetAgentAppearanceData, GetAgentAppearanceErrors, GetAgentAppearanceResponses, GetCustomerData, GetCustomerDeletionData, GetCustomerDeletionErrors, GetCustomerDeletionResponses, GetCustomerErrors, GetCustomerResponses, GetGenerationData, GetGenerationErrors, GetGenerationResponses, GetObservedProcessOutputData, GetObservedProcessOutputErrors, GetObservedProcessOutputResponses, GetOrganizationEventData, GetOrganizationEventErrors, GetOrganizationEventResponses, GetOrganizationFeedbackCountsData, GetOrganizationFeedbackCountsErrors, GetOrganizationFeedbackCountsResponses, GetOrganizationFeedbackData, GetOrganizationFeedbackErrors, GetOrganizationFeedbackResponses, GetSandboxV1SandboxesBySandboxIdData, GetSandboxV1SandboxesBySandboxIdErrors, GetSandboxV1SandboxesBySandboxIdLogsData, GetSandboxV1SandboxesBySandboxIdLogsErrors, GetSandboxV1SandboxesBySandboxIdLogsResponses, GetSandboxV1SandboxesBySandboxIdMetricsData, GetSandboxV1SandboxesBySandboxIdMetricsErrors, GetSandboxV1SandboxesBySandboxIdMetricsResponses, GetSandboxV1SandboxesBySandboxIdResponses, GetSandboxV1SandboxesData, GetSandboxV1SandboxesErrors, GetSandboxV1SandboxesResponses, GetSandboxV1SnapshotsData, GetSandboxV1SnapshotsErrors, GetSandboxV1SnapshotsResponses, GetSandboxV1VolumesByVolumeIdData, GetSandboxV1VolumesByVolumeIdErrors, GetSandboxV1VolumesByVolumeIdResponses, GetSandboxV1VolumesData, GetSandboxV1VolumesErrors, GetSandboxV1VolumesResponses, GetSessionBackgroundTaskOutputData, GetSessionBackgroundTaskOutputErrors, GetSessionBackgroundTaskOutputResponses, GetSessionCompactionData, GetSessionCompactionErrors, GetSessionCompactionResponses, GetSessionContextData, GetSessionContextErrors, GetSessionContextResponses, GetTemplateBuildStatusData, GetTemplateBuildStatusErrors, GetTemplateBuildStatusResponses, GetTemplateWithBuildsData, GetTemplateWithBuildsErrors, GetTemplateWithBuildsResponses, HealthCheckData, HealthCheckResponses, KnowledgeAttachFileData, KnowledgeAttachFileErrors, KnowledgeAttachFileResponses, KnowledgeCancelFileBatchData, KnowledgeCancelFileBatchErrors, KnowledgeCancelFileBatchResponses, KnowledgeCreateFileBatchData, KnowledgeCreateFileBatchErrors, KnowledgeCreateFileBatchResponses, KnowledgeCreateVectorStoreData, KnowledgeCreateVectorStoreErrors, KnowledgeCreateVectorStoreResponses, KnowledgeDeleteVectorStoreData, KnowledgeDeleteVectorStoreErrors, KnowledgeDeleteVectorStoreResponses, KnowledgeListBatchFilesData, KnowledgeListBatchFilesErrors, KnowledgeListBatchFilesResponses, KnowledgeListEventsData, KnowledgeListEventsErrors, KnowledgeListEventsResponses, KnowledgeListFilesData, KnowledgeListFilesErrors, KnowledgeListFilesResponses, KnowledgeListSegmentsData, KnowledgeListSegmentsErrors, KnowledgeListSegmentsResponses, KnowledgeListVectorStoresData, KnowledgeListVectorStoresErrors, KnowledgeListVectorStoresResponses, KnowledgePurgeVectorStoreData, KnowledgePurgeVectorStoreErrors, KnowledgePurgeVectorStoreResponses, KnowledgeRemoveFileData, KnowledgeRemoveFileErrors, KnowledgeRemoveFileResponses, KnowledgeRestoreVectorStoreData, KnowledgeRestoreVectorStoreErrors, KnowledgeRestoreVectorStoreResponses, KnowledgeRetrieveFileBatchData, KnowledgeRetrieveFileBatchErrors, KnowledgeRetrieveFileBatchResponses, KnowledgeRetrieveFileContentData, KnowledgeRetrieveFileContentErrors, KnowledgeRetrieveFileContentResponses, KnowledgeRetrieveFileData, KnowledgeRetrieveFileErrors, KnowledgeRetrieveFileResponses, KnowledgeRetrieveSegmentData, KnowledgeRetrieveSegmentErrors, KnowledgeRetrieveSegmentResponses, KnowledgeRetrieveVectorStoreData, KnowledgeRetrieveVectorStoreErrors, KnowledgeRetrieveVectorStoreResponses, KnowledgeRetryFileData, KnowledgeRetryFileErrors, KnowledgeRetryFileResponses, KnowledgeSearchVectorStoreData, KnowledgeSearchVectorStoreErrors, KnowledgeSearchVectorStoreResponses, KnowledgeUpdateFileData, KnowledgeUpdateFileErrors, KnowledgeUpdateFileResponses, KnowledgeUpdateVectorStoreData, KnowledgeUpdateVectorStoreErrors, KnowledgeUpdateVectorStoreResponses, ListConversationItemsData, ListConversationItemsErrors, ListConversationItemsResponses, ListCustomersData, ListCustomersErrors, ListCustomersResponses, ListModelsData, ListModelsErrors, ListModelsResponses, ListObservedProcessesData, ListObservedProcessesErrors, ListObservedProcessesResponses, ListOrganizationCostsData, ListOrganizationCostsErrors, ListOrganizationCostsResponses, ListOrganizationEventsData, ListOrganizationEventsErrors, ListOrganizationEventsResponses, ListOrganizationFeedbackData, ListOrganizationFeedbackErrors, ListOrganizationFeedbackMessagesData, ListOrganizationFeedbackMessagesErrors, ListOrganizationFeedbackMessagesResponses, ListOrganizationFeedbackResponses, ListOrganizationMembersData, ListOrganizationMembersErrors, ListOrganizationMembersResponses, ListOrganizationUsageData, ListOrganizationUsageErrors, ListOrganizationUsageResponses, ListResponseInputItemsData, ListResponseInputItemsResponses, ListSandboxFilesData, ListSandboxFilesErrors, ListSandboxFilesResponses, ListSandboxTemplatesData, ListSandboxTemplatesErrors, ListSandboxTemplatesResponses, ListSessionBackgroundTasksData, ListSessionBackgroundTasksErrors, ListSessionBackgroundTasksResponses, ListSessionCompactionsData, ListSessionCompactionsErrors, ListSessionCompactionsResponses, ListTemplateTagsData, ListTemplateTagsErrors, ListTemplateTagsResponses, ListToolsetsData, ListToolsetsErrors, ListToolsetsResponses, ListVideosData, ListVideosErrors, ListVideosResponses, MakeSandboxDirectoryData, MakeSandboxDirectoryErrors, MakeSandboxDirectoryResponses, MediaBatchAssetsData, MediaBatchAssetsErrors, MediaBatchAssetsResponses, MediaCancelJobData, MediaCancelJobErrors, MediaCancelJobResponses, MediaCreateBatchData, MediaCreateBatchErrors, MediaCreateBatchResponses, MediaCreateDeliveryTokenData, MediaCreateDeliveryTokenErrors, MediaCreateDeliveryTokenResponses, MediaCreateFrameUrlsData, MediaCreateFrameUrlsErrors, MediaCreateFrameUrlsResponses, MediaCreateGenerationData, MediaCreateGenerationErrors, MediaCreateGenerationResponses, MediaCreateLibraryData, MediaCreateLibraryErrors, MediaCreateLibraryResponses, MediaDeleteAssetData, MediaDeleteAssetErrors, MediaDeleteAssetResponses, MediaDeleteLibraryData, MediaDeleteLibraryErrors, MediaDeleteLibraryResponses, MediaExpressionSearchData, MediaExpressionSearchErrors, MediaExpressionSearchResponses, MediaGetAssetData, MediaGetAssetErrors, MediaGetAssetResponses, MediaGetBatchData, MediaGetBatchErrors, MediaGetBatchResponses, MediaGetGenerationCapabilitiesData, MediaGetGenerationCapabilitiesErrors, MediaGetGenerationCapabilitiesResponses, MediaGetJobData, MediaGetJobErrors, MediaGetJobResponses, MediaGetLibraryData, MediaGetLibraryErrors, MediaGetLibraryResponses, MediaImportAssetData, MediaImportAssetErrors, MediaImportAssetResponses, MediaListAssetsData, MediaListAssetsErrors, MediaListAssetsResponses, MediaListEventsData, MediaListEventsErrors, MediaListEventsResponses, MediaListFoldersData, MediaListFoldersErrors, MediaListFoldersResponses, MediaListJobsData, MediaListJobsErrors, MediaListJobsResponses, MediaListLibrariesData, MediaListLibrariesErrors, MediaListLibrariesResponses, MediaListUnderstandingsByLibraryData, MediaListUnderstandingsByLibraryErrors, MediaListUnderstandingsByLibraryResponses, MediaListUnderstandingsData, MediaListUnderstandingsErrors, MediaListUnderstandingsResponses, MediaPurgeLibraryData, MediaPurgeLibraryErrors, MediaPurgeLibraryResponses, MediaReprocessAssetData, MediaReprocessAssetErrors, MediaReprocessAssetResponses, MediaRestoreLibraryData, MediaRestoreLibraryErrors, MediaRestoreLibraryResponses, MediaSaveGenerationOutputData, MediaSaveGenerationOutputErrors, MediaSaveGenerationOutputResponses, MediaSearchData, MediaSearchErrors, MediaSearchResponses, MediaSemanticSearchData, MediaSemanticSearchErrors, MediaSemanticSearchResponses, MediaUnderstandingFailureSummaryData, MediaUnderstandingFailureSummaryErrors, MediaUnderstandingFailureSummaryResponses, MediaUpdateAssetData, MediaUpdateAssetErrors, MediaUpdateAssetResponses, MediaUpdateLibraryData, MediaUpdateLibraryErrors, MediaUpdateLibraryResponses, MediaUploadAssetData, MediaUploadAssetErrors, MediaUploadAssetResponses, MediaVisualSearchData, MediaVisualSearchErrors, MediaVisualSearchResponses, MetaDocsRetrieveData, MetaDocsRetrieveErrors, MetaDocsRetrieveResponses, MetaDocsSearchData, MetaDocsSearchErrors, MetaDocsSearchResponses, MetaMethodsRetrieveData, MetaMethodsRetrieveErrors, MetaMethodsRetrieveResponses, MetaMethodsSearchData, MetaMethodsSearchErrors, MetaMethodsSearchResponses, OntologyApplyChangesetData, OntologyApplyChangesetErrors, OntologyApplyChangesetResponses, OntologyCreateNodeData, OntologyCreateNodeErrors, OntologyCreateNodeResponses, OntologyCreateRelationData, OntologyCreateRelationErrors, OntologyCreateRelationResponses, OntologyInvalidateRelationData, OntologyInvalidateRelationErrors, OntologyInvalidateRelationResponses, OntologyListNodesData, OntologyListNodesErrors, OntologyListNodesResponses, OntologyListRelationsData, OntologyListRelationsErrors, OntologyListRelationsResponses, OntologyListTypesData, OntologyListTypesErrors, OntologyListTypesResponses, OntologyMergeNodeData, OntologyMergeNodeErrors, OntologyMergeNodeResponses, OntologyRegisterTypeData, OntologyRegisterTypeErrors, OntologyRetrieveNodeData, OntologyRetrieveNodeErrors, OntologyRetrieveNodeResponses, OntologyRetrieveRelationData, OntologyRetrieveRelationErrors, OntologyRetrieveRelationResponses, OntologyRetrieveTypeData, OntologyRetrieveTypeErrors, OntologyRetrieveTypeResponses, OntologySearchData, OntologySearchErrors, OntologySearchResponses, OntologyUpdateNodeData, OntologyUpdateNodeErrors, OntologyUpdateNodeResponses, PostSandboxV1SandboxesBySandboxIdConnectData, PostSandboxV1SandboxesBySandboxIdConnectErrors, PostSandboxV1SandboxesBySandboxIdConnectResponses, PostSandboxV1SandboxesBySandboxIdForkData, PostSandboxV1SandboxesBySandboxIdForkErrors, PostSandboxV1SandboxesBySandboxIdForkResponses, PostSandboxV1SandboxesBySandboxIdPauseData, PostSandboxV1SandboxesBySandboxIdPauseErrors, PostSandboxV1SandboxesBySandboxIdPauseResponses, PostSandboxV1SandboxesBySandboxIdSnapshotsData, PostSandboxV1SandboxesBySandboxIdSnapshotsErrors, PostSandboxV1SandboxesBySandboxIdSnapshotsResponses, PostSandboxV1SandboxesBySandboxIdTimeoutData, PostSandboxV1SandboxesBySandboxIdTimeoutErrors, PostSandboxV1SandboxesBySandboxIdTimeoutResponses, PostSandboxV1SandboxesData, PostSandboxV1SandboxesErrors, PostSandboxV1SandboxesResponses, PostSandboxV1VolumesData, PostSandboxV1VolumesErrors, PostSandboxV1VolumesResponses, PutSandboxV1SandboxesBySandboxIdNetworkData, PutSandboxV1SandboxesBySandboxIdNetworkErrors, PutSandboxV1SandboxesBySandboxIdNetworkResponses, ReadSandboxFileData, ReadSandboxFileErrors, ReadSandboxFileResponses, ReleaseComputerLeaseData, ReleaseComputerLeaseErrors, ReleaseComputerLeaseResponses, RemixVideoData, RemixVideoErrors, RemoveSandboxFileData, RemoveSandboxFileErrors, RemoveSandboxFileResponses, RenameSandboxData, RenameSandboxErrors, RenameSandboxResponses, RenewComputerLeaseData, RenewComputerLeaseErrors, RenewComputerLeaseResponses, RenewCustomerAccessTokenData, RenewCustomerAccessTokenErrors, RenewCustomerAccessTokenResponses, RequestTemplateBuildData, RequestTemplateBuildErrors, RequestTemplateBuildResponses, RerankData, RerankErrors, RerankResponses, ResolveTemplateAliasData, ResolveTemplateAliasErrors, ResolveTemplateAliasResponses, RetrieveConversationData, RetrieveConversationErrors, RetrieveConversationItemData, RetrieveConversationItemErrors, RetrieveConversationItemResponses, RetrieveConversationResponses, RetrieveModelData, RetrieveModelErrors, RetrieveModelResponses, RetrieveResponseData, RetrieveResponseResponses, RetrieveVideoData, RetrieveVideoErrors, RetrieveVideoResponses, RevokeCustomerTokensData, RevokeCustomerTokensErrors, RevokeCustomerTokensResponses, RunSandboxCommandData, RunSandboxCommandErrors, RunSandboxCommandResponses, SearchCrawlData, SearchCrawlErrors, SearchCrawlResponses, SearchExtractData, SearchExtractErrors, SearchExtractResponses, SearchMapData, SearchMapErrors, SearchMapResponses, SearchSearchData, SearchSearchErrors, SearchSearchResponses, SessionsArchiveData, SessionsArchiveErrors, SessionsArchiveResponses, SessionsCreateData, SessionsCreateErrors, SessionsCreateResponses, SessionsDeleteData, SessionsDeleteErrors, SessionsDeleteResponses, SessionsEventsListData, SessionsEventsListErrors, SessionsEventsListResponses, SessionsEventsSendData, SessionsEventsSendErrors, SessionsEventsSendResponses, SessionsEventsStreamData, SessionsEventsStreamResponse, SessionsEventsStreamResponses, SessionsListData, SessionsListErrors, SessionsListResponses, SessionsResourcesAddData, SessionsResourcesAddErrors, SessionsResourcesAddResponses, SessionsResourcesDeleteData, SessionsResourcesDeleteErrors, SessionsResourcesDeleteResponses, SessionsResourcesListData, SessionsResourcesListErrors, SessionsResourcesListResponses, SessionsResourcesRetrieveData, SessionsResourcesRetrieveErrors, SessionsResourcesRetrieveResponses, SessionsRetrieveData, SessionsRetrieveErrors, SessionsRetrieveResponses, SessionsThreadsArchiveData, SessionsThreadsArchiveErrors, SessionsThreadsArchiveResponses, SessionsThreadsEventsListData, SessionsThreadsEventsListErrors, SessionsThreadsEventsListResponses, SessionsThreadsEventsStreamData, SessionsThreadsEventsStreamResponse, SessionsThreadsEventsStreamResponses, SessionsThreadsListData, SessionsThreadsListErrors, SessionsThreadsListResponses, SessionsThreadsRetrieveData, SessionsThreadsRetrieveErrors, SessionsThreadsRetrieveResponses, SessionsUpdateData, SessionsUpdateErrors, SessionsUpdateResponses, SetRunFeedbackData, SetRunFeedbackErrors, SetRunFeedbackResponses, SkillsCreateData, SkillsCreateErrors, SkillsCreateResponses, SkillsDeleteData, SkillsDeleteErrors, SkillsDeleteResponses, SkillsListData, SkillsListErrors, SkillsListResponses, SkillsRetrieveData, SkillsRetrieveErrors, SkillsRetrieveResponses, SkillsVersionsCreateData, SkillsVersionsCreateErrors, SkillsVersionsCreateResponses, SkillsVersionsDeleteData, SkillsVersionsDeleteErrors, SkillsVersionsDeleteResponses, SkillsVersionsDownloadData, SkillsVersionsDownloadErrors, SkillsVersionsDownloadResponses, SkillsVersionsListData, SkillsVersionsListErrors, SkillsVersionsListResponses, SkillsVersionsRetrieveData, SkillsVersionsRetrieveErrors, SkillsVersionsRetrieveResponses, StartTemplateBuildData, StartTemplateBuildErrors, StartTemplateBuildResponses, StopSessionBackgroundTaskData, StopSessionBackgroundTaskErrors, StopSessionBackgroundTaskResponses, StudioCodexesCreateData, StudioCodexesCreateErrors, StudioCodexesCreateResponses, StudioCodexesDeleteData, StudioCodexesDeleteErrors, StudioCodexesDeleteResponses, StudioCodexesGetData, StudioCodexesGetErrors, StudioCodexesGetResponses, StudioCodexesListData, StudioCodexesListErrors, StudioCodexesListResponses, StudioCodexesUpdateData, StudioCodexesUpdateErrors, StudioCodexesUpdateResponses, StudioDraftsCreateData, StudioDraftsCreateErrors, StudioDraftsCreateResponses, StudioDraftsExportData, StudioDraftsExportErrors, StudioDraftsExportResponses, StudioDraftsGetData, StudioDraftsGetErrors, StudioDraftsGetResponses, StudioDraftsListData, StudioDraftsListErrors, StudioDraftsListResponses, StudioDraftsOutlineData, StudioDraftsOutlineErrors, StudioDraftsOutlineResponses, StudioDraftsRebaseData, StudioDraftsRebaseErrors, StudioDraftsRebaseResponses, StudioDraftsReviewData, StudioDraftsReviewErrors, StudioDraftsReviewResponses, StudioDraftsStatusData, StudioDraftsStatusErrors, StudioDraftsStatusResponses, StudioDraftsUpdateData, StudioDraftsUpdateErrors, StudioDraftsUpdateResponses, StudioEntriesCreateData, StudioEntriesCreateErrors, StudioEntriesCreateResponses, StudioEntriesDeleteData, StudioEntriesDeleteErrors, StudioEntriesDeleteResponses, StudioEntriesGetData, StudioEntriesGetErrors, StudioEntriesGetResponses, StudioEntriesListData, StudioEntriesListErrors, StudioEntriesListResponses, StudioEntriesUpdateData, StudioEntriesUpdateErrors, StudioEntriesUpdateResponses, StudioGenresGetData, StudioGenresGetErrors, StudioGenresGetResponses, StudioGenresListData, StudioGenresListErrors, StudioGenresListResponses, StudioPlatformsGetData, StudioPlatformsGetErrors, StudioPlatformsGetResponses, StudioPlatformsListData, StudioPlatformsListErrors, StudioPlatformsListResponses, StudioStylesCreateData, StudioStylesCreateErrors, StudioStylesCreateResponses, StudioStylesDeleteData, StudioStylesDeleteErrors, StudioStylesDeleteResponses, StudioStylesGetData, StudioStylesGetErrors, StudioStylesGetResponses, StudioStylesListData, StudioStylesListErrors, StudioStylesListResponses, StudioStylesUpdateData, StudioStylesUpdateErrors, StudioStylesUpdateResponses, StudioTemplatesCreateData, StudioTemplatesCreateErrors, StudioTemplatesCreateResponses, StudioTemplatesDeleteData, StudioTemplatesDeleteErrors, StudioTemplatesDeleteResponses, StudioTemplatesGetData, StudioTemplatesGetErrors, StudioTemplatesGetResponses, StudioTemplatesListData, StudioTemplatesListErrors, StudioTemplatesListResponses, StudioThemesCreateData, StudioThemesCreateErrors, StudioThemesCreateResponses, StudioThemesDeleteData, StudioThemesDeleteErrors, StudioThemesDeleteResponses, StudioThemesGetData, StudioThemesGetErrors, StudioThemesGetResponses, StudioThemesListData, StudioThemesListErrors, StudioThemesListResponses, StudioThemesUpdateData, StudioThemesUpdateErrors, StudioThemesUpdateResponses, StudioUnitsBatchCreateData, StudioUnitsBatchCreateErrors, StudioUnitsBatchCreateResponses, StudioUnitsBatchUpdateData, StudioUnitsBatchUpdateErrors, StudioUnitsBatchUpdateResponses, StudioUnitsContextData, StudioUnitsContextErrors, StudioUnitsContextResponses, StudioUnitsCreateData, StudioUnitsCreateErrors, StudioUnitsCreateResponses, StudioUnitsGetData, StudioUnitsGetErrors, StudioUnitsGetResponses, StudioUnitsMoveData, StudioUnitsMoveErrors, StudioUnitsMoveResponses, StudioUnitsPatchBlocksData, StudioUnitsPatchBlocksErrors, StudioUnitsPatchBlocksResponses, StudioUnitsUpdateData, StudioUnitsUpdateErrors, StudioUnitsUpdateResponses, StudioWorksCreateData, StudioWorksCreateErrors, StudioWorksCreateResponses, StudioWorksGetData, StudioWorksGetErrors, StudioWorksGetResponses, StudioWorksListData, StudioWorksListErrors, StudioWorksListResponses, StudioWorksResolveData, StudioWorksResolveErrors, StudioWorksResolveResponses, StudioWorksUpdateBriefData, StudioWorksUpdateBriefErrors, StudioWorksUpdateBriefResponses, StudioWorksUpdateData, StudioWorksUpdateErrors, StudioWorksUpdateResponses, TicketDeleteCommentsIdData, TicketDeleteCommentsIdErrors, TicketDeleteCommentsIdReactionsContentData, TicketDeleteCommentsIdReactionsContentErrors, TicketDeleteCommentsIdReactionsContentResponses, TicketDeleteCommentsIdResponses, TicketDeleteLabelsNameData, TicketDeleteLabelsNameErrors, TicketDeleteLabelsNameResponses, TicketDeleteMilestonesNumberData, TicketDeleteMilestonesNumberErrors, TicketDeleteMilestonesNumberResponses, TicketDeleteTicketsNumberDependenciesBlockedByNData, TicketDeleteTicketsNumberDependenciesBlockedByNErrors, TicketDeleteTicketsNumberDependenciesBlockedByNResponses, TicketDeleteTicketsNumberLockData, TicketDeleteTicketsNumberLockErrors, TicketDeleteTicketsNumberLockResponses, TicketDeleteTicketsNumberReactionsContentData, TicketDeleteTicketsNumberReactionsContentErrors, TicketDeleteTicketsNumberReactionsContentResponses, TicketDeleteTicketsNumberRelationsNData, TicketDeleteTicketsNumberRelationsNErrors, TicketDeleteTicketsNumberRelationsNResponses, TicketDeleteTicketsNumberSubTicketsChildData, TicketDeleteTicketsNumberSubTicketsChildErrors, TicketDeleteTicketsNumberSubTicketsChildResponses, TicketGetActivityData, TicketGetActivityErrors, TicketGetActivityResponses, TicketGetCommentsIdData, TicketGetCommentsIdErrors, TicketGetCommentsIdReactionsData, TicketGetCommentsIdReactionsErrors, TicketGetCommentsIdReactionsResponses, TicketGetCommentsIdResponses, TicketGetLabelsData, TicketGetLabelsErrors, TicketGetLabelsResponses, TicketGetMilestonesData, TicketGetMilestonesErrors, TicketGetMilestonesNumberData, TicketGetMilestonesNumberErrors, TicketGetMilestonesNumberResponses, TicketGetMilestonesResponses, TicketGetRepositoriesData, TicketGetRepositoriesErrors, TicketGetRepositoriesResponses, TicketGetTicketsData, TicketGetTicketsErrors, TicketGetTicketsNumberCommentsData, TicketGetTicketsNumberCommentsErrors, TicketGetTicketsNumberCommentsResponses, TicketGetTicketsNumberData, TicketGetTicketsNumberDependenciesBlockedByData, TicketGetTicketsNumberDependenciesBlockedByErrors, TicketGetTicketsNumberDependenciesBlockedByResponses, TicketGetTicketsNumberDependenciesBlockingData, TicketGetTicketsNumberDependenciesBlockingErrors, TicketGetTicketsNumberDependenciesBlockingResponses, TicketGetTicketsNumberErrors, TicketGetTicketsNumberEventsData, TicketGetTicketsNumberEventsErrors, TicketGetTicketsNumberEventsResponses, TicketGetTicketsNumberReactionsData, TicketGetTicketsNumberReactionsErrors, TicketGetTicketsNumberReactionsResponses, TicketGetTicketsNumberRelationsData, TicketGetTicketsNumberRelationsErrors, TicketGetTicketsNumberRelationsResponses, TicketGetTicketsNumberResponses, TicketGetTicketsNumberSubTicketsData, TicketGetTicketsNumberSubTicketsErrors, TicketGetTicketsNumberSubTicketsResponses, TicketGetTicketsResponses, TicketGetTypesData, TicketGetTypesErrors, TicketGetTypesResponses, TicketPatchCommentsIdData, TicketPatchCommentsIdErrors, TicketPatchCommentsIdResponses, TicketPatchLabelsNameData, TicketPatchLabelsNameErrors, TicketPatchLabelsNameResponses, TicketPatchMilestonesNumberData, TicketPatchMilestonesNumberErrors, TicketPatchMilestonesNumberResponses, TicketPatchTicketsNumberData, TicketPatchTicketsNumberErrors, TicketPatchTicketsNumberResponses, TicketPostCommentsIdReactionsData, TicketPostCommentsIdReactionsErrors, TicketPostCommentsIdReactionsResponses, TicketPostLabelsData, TicketPostLabelsErrors, TicketPostLabelsResponses, TicketPostMilestonesData, TicketPostMilestonesErrors, TicketPostMilestonesResponses, TicketPostTicketsData, TicketPostTicketsErrors, TicketPostTicketsNumberCommentsData, TicketPostTicketsNumberCommentsErrors, TicketPostTicketsNumberCommentsResponses, TicketPostTicketsNumberDependenciesBlockedByData, TicketPostTicketsNumberDependenciesBlockedByErrors, TicketPostTicketsNumberDependenciesBlockedByResponses, TicketPostTicketsNumberReactionsData, TicketPostTicketsNumberReactionsErrors, TicketPostTicketsNumberReactionsResponses, TicketPostTicketsNumberRelationsData, TicketPostTicketsNumberRelationsErrors, TicketPostTicketsNumberRelationsResponses, TicketPostTicketsNumberSubTicketsData, TicketPostTicketsNumberSubTicketsErrors, TicketPostTicketsNumberSubTicketsResponses, TicketPostTicketsResponses, TicketPutTicketsNumberLockData, TicketPutTicketsNumberLockErrors, TicketPutTicketsNumberLockResponses, UnarchiveAgentData, UnarchiveAgentErrors, UnarchiveAgentResponses, UnblockCustomerData, UnblockCustomerErrors, UnblockCustomerResponses, UpdateConversationData, UpdateConversationErrors, UpdateConversationResponses, UpgradeSandboxData, UpgradeSandboxErrors, UpgradeSandboxResponses, VaultArchiveSecretData, VaultArchiveSecretErrors, VaultArchiveSecretResponses, VaultArchiveVaultData, VaultArchiveVaultErrors, VaultArchiveVaultResponses, VaultAuthorizationCallbackData, VaultAuthorizationCallbackResponses, VaultCheckVaultsData, VaultCheckVaultsErrors, VaultCheckVaultsResponses, VaultConnectContinueData, VaultConnectDenyData, VaultConnectDenyResponses, VaultConnectPageData, VaultConnectPageErrors, VaultConnectPageResponses, VaultCreateAuthorizationData, VaultCreateAuthorizationErrors, VaultCreateAuthorizationResponses, VaultCreateSecretData, VaultCreateSecretErrors, VaultCreateSecretResponses, VaultCreateVaultData, VaultCreateVaultErrors, VaultCreateVaultResponses, VaultDeleteSecretData, VaultDeleteSecretErrors, VaultDeleteSecretResponses, VaultDeleteVaultData, VaultDeleteVaultErrors, VaultDeleteVaultResponses, VaultGetAuthorizationData, VaultGetAuthorizationErrors, VaultGetAuthorizationResponses, VaultGetReturnUrlsData, VaultGetReturnUrlsErrors, VaultGetReturnUrlsResponses, VaultGetSecretData, VaultGetSecretErrors, VaultGetSecretResponses, VaultGetVaultData, VaultGetVaultErrors, VaultGetVaultResponses, VaultImportSecretsData, VaultImportSecretsErrors, VaultImportSecretsResponses, VaultListEventsData, VaultListEventsErrors, VaultListEventsResponses, VaultListSecretsData, VaultListSecretsErrors, VaultListSecretsResponses, VaultListTemplatesData, VaultListTemplatesErrors, VaultListTemplatesResponses, VaultListVaultsData, VaultListVaultsErrors, VaultListVaultsResponses, VaultOAuthClientMetadataData, VaultOAuthClientMetadataResponses, VaultRefreshSecretData, VaultRefreshSecretErrors, VaultRefreshSecretResponses, VaultSetReturnUrlsData, VaultSetReturnUrlsErrors, VaultSetReturnUrlsResponses, VaultUpdateSecretData, VaultUpdateSecretErrors, VaultUpdateSecretResponses, VaultUpdateVaultData, VaultUpdateVaultErrors, VaultUpdateVaultResponses, VaultValidateSecretData, VaultValidateSecretErrors, VaultValidateSecretResponses, WriteSandboxFileData, WriteSandboxFileErrors, WriteSandboxFileResponses } from './types.gen.js';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -148,7 +148,7 @@ export declare const computersList: <ThrowOnError extends boolean = false>(optio
|
|
|
148
148
|
/**
|
|
149
149
|
* Create Computer
|
|
150
150
|
*
|
|
151
|
-
* Create a durable computer: a named machine whose files outlive sessions, for personal agents.
|
|
151
|
+
* Create a durable computer: a named machine whose files outlive sessions, for general and personal agents.
|
|
152
152
|
*
|
|
153
153
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
|
|
154
154
|
*/
|
|
@@ -209,6 +209,14 @@ export declare const computersFilesList: <ThrowOnError extends boolean = false>(
|
|
|
209
209
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.
|
|
210
210
|
*/
|
|
211
211
|
export declare const computersFilesContent: <ThrowOnError extends boolean = false>(options: Options<ComputersFilesContentData, ThrowOnError>) => RequestResult<ComputersFilesContentResponses, ComputersFilesContentErrors, ThrowOnError>;
|
|
212
|
+
/**
|
|
213
|
+
* Convert a Computer Document to PDF
|
|
214
|
+
*
|
|
215
|
+
* Convert an Office document (docx, doc, ppt, pptx, rtf, odt; up to 16 MiB) to PDF inside a platform-owned ephemeral document sandbox, whatever machine family the computer itself runs on. Returns base64 PDF bytes.
|
|
216
|
+
*
|
|
217
|
+
* Praxis extension: the preview conversion endpoint. The browser never parses an untrusted document — LibreOffice runs only inside an ephemeral document-family sandbox and the converter instance is killed after use. The file stays tenant-owned; non-convertible types answer EXTENSION_NOT_CONVERTIBLE and a failed conversion answers CONVERSION_FAILED.
|
|
218
|
+
*/
|
|
219
|
+
export declare const computersFilesConvert: <ThrowOnError extends boolean = false>(options: Options<ComputersFilesConvertData, ThrowOnError>) => RequestResult<ComputersFilesConvertResponses, ComputersFilesConvertErrors, ThrowOnError>;
|
|
212
220
|
/**
|
|
213
221
|
* Connect computer
|
|
214
222
|
*
|
|
@@ -286,7 +294,7 @@ export declare const stopSessionBackgroundTask: <ThrowOnError extends boolean =
|
|
|
286
294
|
*
|
|
287
295
|
* Request session context compaction and retrieve an operation receipt.
|
|
288
296
|
*
|
|
289
|
-
* Available only on /agent/v1. The body may be omitted or {}. Optional instructions must be a string and is forwarded unchanged. Idempotency-Key is forwarded unchanged; a UUID is generated when absent. Returns { type: session_compaction, id, status, reason? }, where id is the operation ID. queued/running return 202; skipped/succeeded/failed return 200. Non-string instructions return 400 invalid_request_error. Missing or inaccessible managed sessions return 404 not_found_error.
|
|
297
|
+
* Available only on /agent/v1. The body may be omitted or {}. Optional instructions must be a string and is forwarded unchanged. Idempotency-Key is forwarded unchanged; a UUID is generated when absent. Returns { type: session_compaction, id, status, reason? }, where id is the operation ID. queued/running return 202; skipped/succeeded/failed/cancelled return 200. Non-string instructions return 400 invalid_request_error. Missing or inaccessible managed sessions return 404 not_found_error.
|
|
290
298
|
*/
|
|
291
299
|
export declare const compactSession: <ThrowOnError extends boolean = false>(options: Options<CompactSessionData, ThrowOnError>) => RequestResult<CompactSessionResponses, CompactSessionErrors, ThrowOnError>;
|
|
292
300
|
/**
|
|
@@ -302,7 +310,7 @@ export declare const getSessionCompaction: <ThrowOnError extends boolean = false
|
|
|
302
310
|
*
|
|
303
311
|
* Read session compaction history and summaries.
|
|
304
312
|
*
|
|
305
|
-
* Available only on /agent/v1. Returns { data: [...] }. Each entry contains type, id, event_id, trigger, status, model, compacted_message_count, input_tokens_before, input_tokens_after, summary, error and created_at, as recorded by the service. Missing or inaccessible managed sessions return 404 not_found_error.
|
|
313
|
+
* Available only on /agent/v1. Returns { data: [...], active }. active is the queued or running compaction ({ type: session_compaction, id, status, trigger: manual|auto|idle }), or null when none; manual work takes precedence. Each data entry contains type, id, event_id, trigger, status, model, compacted_message_count, input_tokens_before, input_tokens_after, summary, error and created_at, as recorded by the service. Missing or inaccessible managed sessions return 404 not_found_error.
|
|
306
314
|
*/
|
|
307
315
|
export declare const listSessionCompactions: <ThrowOnError extends boolean = false>(options: Options<ListSessionCompactionsData, ThrowOnError>) => RequestResult<ListSessionCompactionsResponses, ListSessionCompactionsErrors, ThrowOnError>;
|
|
308
316
|
/**
|
|
@@ -347,6 +355,12 @@ export declare const browserGetDebug: <ThrowOnError extends boolean = false>(opt
|
|
|
347
355
|
* 按事件序号升序读取指定会话的事件账本,包含生命周期和接管等事件,不包含页面点击或输入内容。可按 types 筛选,并将 nextCursor 原样传入读取后续页。
|
|
348
356
|
*/
|
|
349
357
|
export declare const browserListEvents: <ThrowOnError extends boolean = false>(options: Options<BrowserListEventsData, ThrowOnError>) => RequestResult<BrowserListEventsResponses, BrowserListEventsErrors, ThrowOnError>;
|
|
358
|
+
/**
|
|
359
|
+
* 执行页面动作
|
|
360
|
+
*
|
|
361
|
+
* 在会话的浏览器里执行一个页面动作并返回结果,由浏览器服务执行,客户端不需要 Playwright。同一会话的动作按到达顺序串行执行,单个动作 30 秒内完成。先用 snapshot 读取页面:元素带 [ref=eN],click、fill 按 ref 操作;ref 只在最近一次快照里有效,页面跳转后失效(409 ACTION_REF_STALE,重新 snapshot)。省略 tab 时作用于当前标签页。
|
|
362
|
+
*/
|
|
363
|
+
export declare const browserRunPageAction: <ThrowOnError extends boolean = false>(options: Options<BrowserRunPageActionData, ThrowOnError>) => RequestResult<BrowserRunPageActionResponses, BrowserRunPageActionErrors, ThrowOnError>;
|
|
350
364
|
/**
|
|
351
365
|
* 请求人工接管
|
|
352
366
|
*
|
|
@@ -368,7 +382,7 @@ export declare const browserViewerHeartbeat: <ThrowOnError extends boolean = fal
|
|
|
368
382
|
/**
|
|
369
383
|
* 列出浏览器上下文
|
|
370
384
|
*
|
|
371
|
-
* 分页列出当前账户保存的登录态,按登录态 ID 升序排列。每项返回名称、标签及保存内容的统计信息;将 nextCursor 原样传入读取下一页,直到其为 null
|
|
385
|
+
* 分页列出当前账户保存的登录态,按登录态 ID 升序排列。每项返回名称、标签及保存内容的统计信息;将 nextCursor 原样传入读取下一页,直到其为 null。传 name 时只返回该名称的登录态;名称在当前账户内唯一,所以最多一条。
|
|
372
386
|
*/
|
|
373
387
|
export declare const browserListContexts: <ThrowOnError extends boolean = false>(options?: Options<BrowserListContextsData, ThrowOnError>) => RequestResult<BrowserListContextsResponses, BrowserListContextsErrors, ThrowOnError>;
|
|
374
388
|
/**
|
|
@@ -428,7 +442,7 @@ export declare const fileListFiles: <ThrowOnError extends boolean = false>(optio
|
|
|
428
442
|
/**
|
|
429
443
|
* Upload file
|
|
430
444
|
*
|
|
431
|
-
* Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.
|
|
445
|
+
* Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File(["Return within 23 days."], "policy.txt", { type: "text/plain" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.
|
|
432
446
|
*/
|
|
433
447
|
export declare const fileCreateFile: <ThrowOnError extends boolean = false>(options: Options<FileCreateFileData, ThrowOnError>) => RequestResult<FileCreateFileResponses, FileCreateFileErrors, ThrowOnError>;
|
|
434
448
|
/**
|
|
@@ -452,19 +466,19 @@ export declare const fileRetrieveFileContent: <ThrowOnError extends boolean = fa
|
|
|
452
466
|
/**
|
|
453
467
|
* Create an upload
|
|
454
468
|
*
|
|
455
|
-
* Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most
|
|
469
|
+
* Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 20 GiB (21474836480 bytes) and only user_data, assistants and vision purposes. Send parts of at most 64000000 bytes; an unfinished upload waits for them for 7 days, so a client can create → send parts → query GET /file/v1/uploads/{upload_id} → resend only the missing parts → complete. Optional part_size fixes every part length and makes each numbered part retryable with identical bytes. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.
|
|
456
470
|
*/
|
|
457
471
|
export declare const fileCreateUpload: <ThrowOnError extends boolean = false>(options: Options<FileCreateUploadData, ThrowOnError>) => RequestResult<FileCreateUploadResponses, FileCreateUploadErrors, ThrowOnError>;
|
|
458
472
|
/**
|
|
459
473
|
* Add an upload part
|
|
460
474
|
*
|
|
461
|
-
* Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.
|
|
475
|
+
* Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID, and query GET /file/v1/uploads/{upload_id} to see which numbers already arrived. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.
|
|
462
476
|
*/
|
|
463
477
|
export declare const fileAddUploadPart: <ThrowOnError extends boolean = false>(options: Options<FileAddUploadPartData, ThrowOnError>) => RequestResult<FileAddUploadPartResponses, FileAddUploadPartErrors, ThrowOnError>;
|
|
464
478
|
/**
|
|
465
479
|
* Complete an upload
|
|
466
480
|
*
|
|
467
|
-
* Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.
|
|
481
|
+
* Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. When parts were lost, query GET /file/v1/uploads/{upload_id} and resend them before completing. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.
|
|
468
482
|
*/
|
|
469
483
|
export declare const fileCompleteUpload: <ThrowOnError extends boolean = false>(options: Options<FileCompleteUploadData, ThrowOnError>) => RequestResult<FileCompleteUploadResponses, FileCompleteUploadErrors, ThrowOnError>;
|
|
470
484
|
/**
|
|
@@ -473,6 +487,30 @@ export declare const fileCompleteUpload: <ThrowOnError extends boolean = false>(
|
|
|
473
487
|
* Cancel an unfinished upload using upload_id from create and release its reserved storage. Further parts and completion are rejected. Cancelling an already cancelled upload returns the same terminal result; a completed upload cannot be cancelled. Delete its resulting file instead.
|
|
474
488
|
*/
|
|
475
489
|
export declare const fileCancelUpload: <ThrowOnError extends boolean = false>(options: Options<FileCancelUploadData, ThrowOnError>) => RequestResult<FileCancelUploadResponses, FileCancelUploadErrors, ThrowOnError>;
|
|
490
|
+
/**
|
|
491
|
+
* Retrieve an upload
|
|
492
|
+
*
|
|
493
|
+
* Read the state of an unfinished upload — its status, declared bytes, fixed part_size and the parts it already holds (received_parts, each with part_number, bytes and sha256). After a break or a failed part, call it to resend only the missing numbers, then complete. A cancelled or expired upload is refused; a completed one returns its file. A missing or other-organization upload returns 404.
|
|
494
|
+
*/
|
|
495
|
+
export declare const fileRetrieveUpload: <ThrowOnError extends boolean = false>(options: Options<FileRetrieveUploadData, ThrowOnError>) => RequestResult<FileRetrieveUploadResponses, FileRetrieveUploadErrors, ThrowOnError>;
|
|
496
|
+
/**
|
|
497
|
+
* Create a one-time upload URL
|
|
498
|
+
*
|
|
499
|
+
* Upload a local file of up to 20 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes) and PUT each chunk to its numbered parts[].url in any order; an interrupted client GETs status_url to see the received parts and resends only what is missing, then POSTs complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 604800 (7 days) for multipart, at most 604800; all multipart URLs, including status_url, share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {"filename":"photo.png","bytes":2048,"content_type":"image/png"}.
|
|
500
|
+
*/
|
|
501
|
+
export declare const fileCreateSignedUpload: <ThrowOnError extends boolean = false>(options: Options<FileCreateSignedUploadData, ThrowOnError>) => RequestResult<FileCreateSignedUploadResponses, FileCreateSignedUploadErrors, ThrowOnError>;
|
|
502
|
+
/**
|
|
503
|
+
* Create a download URL
|
|
504
|
+
*
|
|
505
|
+
* Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 900 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {"ttl_seconds":3600}.
|
|
506
|
+
*/
|
|
507
|
+
export declare const fileCreateContentUrl: <ThrowOnError extends boolean = false>(options: Options<FileCreateContentUrlData, ThrowOnError>) => RequestResult<FileCreateContentUrlResponses, FileCreateContentUrlErrors, ThrowOnError>;
|
|
508
|
+
/**
|
|
509
|
+
* Revoke a file content link
|
|
510
|
+
*
|
|
511
|
+
* Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 15 minutes; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {"token":"<token from /c/>"}.
|
|
512
|
+
*/
|
|
513
|
+
export declare const fileRevokeContentLink: <ThrowOnError extends boolean = false>(options: Options<FileRevokeContentLinkData, ThrowOnError>) => RequestResult<FileRevokeContentLinkResponses, FileRevokeContentLinkErrors, ThrowOnError>;
|
|
476
514
|
/**
|
|
477
515
|
* Health Check
|
|
478
516
|
*
|
|
@@ -507,6 +545,18 @@ export declare const metaMethodsSearch: <ThrowOnError extends boolean = false>(o
|
|
|
507
545
|
*
|
|
508
546
|
*/
|
|
509
547
|
export declare const metaMethodsRetrieve: <ThrowOnError extends boolean = false>(options: Options<MetaMethodsRetrieveData, ThrowOnError>) => RequestResult<MetaMethodsRetrieveResponses, MetaMethodsRetrieveErrors, ThrowOnError>;
|
|
548
|
+
/**
|
|
549
|
+
* Read documentation Markdown
|
|
550
|
+
*
|
|
551
|
+
* Read a platform guide or reference before implementing an unfamiliar capability. Public; no API key required. Take path from praxis.meta.docs.search, or use developers/automation/guides/write-workflow. Append #heading-id to path to read only that section, including its subsections. Encode the hash as %23 over HTTP; SDK callers pass it in the path string. lang defaults to zh; en selects the English page. Unknown pages or anchors return DOC_NOT_FOUND; search again for a valid path.
|
|
552
|
+
*/
|
|
553
|
+
export declare const metaDocsRetrieve: <ThrowOnError extends boolean = false>(options: Options<MetaDocsRetrieveData, ThrowOnError>) => RequestResult<MetaDocsRetrieveResponses, MetaDocsRetrieveErrors, ThrowOnError>;
|
|
554
|
+
/**
|
|
555
|
+
* Search platform documentation
|
|
556
|
+
*
|
|
557
|
+
* Find guides and references by keyword before reading them with praxis.meta.docs.retrieve. Public; no API key required. Matches documentation titles, headings and page text without case sensitivity; all query words must occur. q is required; limit defaults to 20 and accepts 1–50. lang defaults to zh or use en for English. Returns paths, page titles, canonical URLs and short matching snippets; no matches returns an empty array.
|
|
558
|
+
*/
|
|
559
|
+
export declare const metaDocsSearch: <ThrowOnError extends boolean = false>(options: Options<MetaDocsSearchData, ThrowOnError>) => RequestResult<MetaDocsSearchResponses, MetaDocsSearchErrors, ThrowOnError>;
|
|
510
560
|
/**
|
|
511
561
|
* List Models
|
|
512
562
|
*
|
|
@@ -555,6 +605,12 @@ export declare const downloadVideoContent: <ThrowOnError extends boolean = false
|
|
|
555
605
|
* Not supported in this release; always returns 400.
|
|
556
606
|
*/
|
|
557
607
|
export declare const remixVideo: <ThrowOnError extends boolean = false>(options: Options<RemixVideoData, ThrowOnError>) => RequestResult<unknown, RemixVideoErrors, ThrowOnError>;
|
|
608
|
+
/**
|
|
609
|
+
* Ask structured decision questions
|
|
610
|
+
*
|
|
611
|
+
* Ask typed questions about a state and get calibrated probabilities instead of generated text. Same request and response as TypeSafe System One. Use model ids from model.models.list declaring typesafe.systemone. Send one or more noul, choice or score questions; answers use the same question ids. Input tokens are charged at the catalog input price; output tokens are free. usage.cost and X-Praxis-Cost-Usd expose the same customer charge in USD. box questions and assets are unsupported and return 400: images are not supported. Unknown top-level fields pass unchanged to the native upstream.
|
|
612
|
+
*/
|
|
613
|
+
export declare const createSystemone: <ThrowOnError extends boolean = false>(options: Options<CreateSystemoneData, ThrowOnError>) => RequestResult<CreateSystemoneResponses, CreateSystemoneErrors, ThrowOnError>;
|
|
558
614
|
/**
|
|
559
615
|
* Transcribe audio
|
|
560
616
|
*
|
|
@@ -705,6 +761,12 @@ export declare const compactResponse: <ThrowOnError extends boolean = false>(opt
|
|
|
705
761
|
* Request an input-token count for Responses input. Unlike OpenAI, this operation is unavailable and returns 501; use the documented Messages token-count operation only when its input shape and estimation limits fit your task.
|
|
706
762
|
*/
|
|
707
763
|
export declare const countResponseInputTokens: <ThrowOnError extends boolean = false>(options: Options<CountResponseInputTokensData, ThrowOnError>) => RequestResult<CountResponseInputTokensResponses, CountResponseInputTokensErrors, ThrowOnError>;
|
|
764
|
+
/**
|
|
765
|
+
* List organization members
|
|
766
|
+
*
|
|
767
|
+
* Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.
|
|
768
|
+
*/
|
|
769
|
+
export declare const listOrganizationMembers: <ThrowOnError extends boolean = false>(options?: Options<ListOrganizationMembersData, ThrowOnError>) => RequestResult<ListOrganizationMembersResponses, ListOrganizationMembersErrors, ThrowOnError>;
|
|
708
770
|
/**
|
|
709
771
|
* List your organization's feedback
|
|
710
772
|
*
|
|
@@ -851,7 +913,7 @@ export declare const makeSandboxDirectory: <ThrowOnError extends boolean = false
|
|
|
851
913
|
/**
|
|
852
914
|
* Run a command in the sandbox
|
|
853
915
|
*
|
|
854
|
-
* Execute a shell command and wait for stdout, stderr and exitCode. Supply cmd, optional cwd and envs, and timeoutMs (1–
|
|
916
|
+
* Execute a shell command and wait for stdout, stderr and exitCode. Supply cmd, optional cwd and envs, and timeoutMs (1–3600000 milliseconds, default 600000, that is 10 minutes; E2B defaults to 60000). Unlike E2B, this endpoint is synchronous only: no background mode, callbacks or unlimited timeout (timeoutMs 0); output is bounded to 1 MiB including stream framing. Nonzero exit codes return 200 with the result. A timeout returns COMMAND_TIMEOUT (504); transport timeout does not confirm process termination, so do not blindly retry commands with side effects. Example body: {"cmd":"echo hi"}.
|
|
855
917
|
*/
|
|
856
918
|
export declare const runSandboxCommand: <ThrowOnError extends boolean = false>(options: Options<RunSandboxCommandData, ThrowOnError>) => RequestResult<RunSandboxCommandResponses, RunSandboxCommandErrors, ThrowOnError>;
|
|
857
919
|
/**
|
|
@@ -875,13 +937,13 @@ export declare const sessionsUpdate: <ThrowOnError extends boolean = false>(opti
|
|
|
875
937
|
/**
|
|
876
938
|
* List agents
|
|
877
939
|
*
|
|
878
|
-
* List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents
|
|
940
|
+
* List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=general or kind=personal for durable-computer agents, kind=service for per-session environments, or kind=assume for external MCP clients. Pass next_page from the response as page to read the next page; a null next_page means the end.
|
|
879
941
|
*/
|
|
880
942
|
export declare const agentsList: <ThrowOnError extends boolean = false>(options?: Options<AgentsListData, ThrowOnError>) => RequestResult<AgentsListResponses, AgentsListErrors, ThrowOnError>;
|
|
881
943
|
/**
|
|
882
944
|
* Create agent
|
|
883
945
|
*
|
|
884
|
-
* Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. skills attaches uploaded custom skills as [{type: "custom", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send "latest", to use the skill's newest version when a session starts. type anthropic returns 400. Use tools: [{type: "agent_toolset_20260401"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: "agent_toolset_20260401", default_config: {enabled: false}, configs: [{name: "codemode", enabled: true}, {name: "bash", enabled: true, permission_policy: {type: "always_ask"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. model and every models.allowed entry must be a catalog model that can run an agent: an unknown id returns 400 "model <id> is not in the model catalog" and an embedding, image or speech model returns 400 "model <id> cannot run an agent". name is a label, not a unique key: 1 to 256 characters after trimming, no NUL or line breaks. avatar is trimmed, must not contain spaces or point at a loopback, private or internal host, and its scheme is stored in lowercase. script and workflow binding ids are stored in lowercase, the form automation matches; bindings together with environment_id null return 400 because bindings need a machine. Example: {"name":"helper","model":{"id":"deepseek-flash"},"tools":[{"type":"agent_toolset_20260401"}]}.
|
|
946
|
+
* Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. skills attaches uploaded custom skills as [{type: "custom", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send "latest", to use the skill's newest version when a session starts. type anthropic returns 400. Use tools: [{type: "agent_toolset_20260401"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: "agent_toolset_20260401", default_config: {enabled: false}, configs: [{name: "codemode", enabled: true}, {name: "bash", enabled: true, permission_policy: {type: "always_ask"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. model and every models.allowed entry must be a catalog model that can run an agent: an unknown id returns 400 "model <id> is not in the model catalog" and an embedding, image or speech model returns 400 "model <id> cannot run an agent". name is a label, not a unique key: 1 to 256 characters after trimming, no NUL or line breaks. avatar is trimmed, must not contain spaces or point at a loopback, private or internal host, and its scheme is stored in lowercase. script and workflow binding ids are stored in lowercase, the form automation matches; bindings together with environment_id null return 400 because bindings need a machine. Example: {"name":"helper","model":{"id":"deepseek-flash"},"tools":[{"type":"agent_toolset_20260401"}]}. For kind assume, provide name without model, models, subagent_model, subagents or multiagent; omit computer_id to register a new computer named after the agent without starting an instance, or provide an existing computer_id; vault_ids are accepted, bindings and environment_id are refused. Drive assume agents over MCP at /agent/v1/agents/{id}/mcp.
|
|
885
947
|
*/
|
|
886
948
|
export declare const agentsCreate: <ThrowOnError extends boolean = false>(options: Options<AgentsCreateData, ThrowOnError>) => RequestResult<AgentsCreateResponses, AgentsCreateErrors, ThrowOnError>;
|
|
887
949
|
/**
|
|
@@ -893,7 +955,7 @@ export declare const agentsRetrieve: <ThrowOnError extends boolean = false>(opti
|
|
|
893
955
|
/**
|
|
894
956
|
* Update agent
|
|
895
957
|
*
|
|
896
|
-
* Save configuration changes as a new immutable version. Send latest_version from a default retrieve or update response as the request version for optimistic concurrency; a stale value returns 409. apply defaults to true and makes the new version effective; apply false saves without changing active_version. The response contains the effective configuration, with version equal to active_version and latest_version naming the newest saved version. An unchanged configuration, including a note-only update, is a no-op returning 200 and the current effective version without creating or activating a version. version_note records up to 280 characters only when a configuration change creates a new version; null is equivalent to omission. Use agents.versions.apply to activate an existing saved version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: "custom", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send "latest", to use the skill's newest version when a session starts. type anthropic returns 400.
|
|
958
|
+
* Save configuration changes as a new immutable version. Send latest_version from a default retrieve or update response as the request version for optimistic concurrency; a stale value returns 409. apply defaults to true and makes the new version effective; apply false saves without changing active_version. The response contains the effective configuration, with version equal to active_version and latest_version naming the newest saved version. An unchanged configuration, including a note-only update, is a no-op returning 200 and the current effective version without creating or activating a version. version_note records up to 280 characters only when a configuration change creates a new version; null is equivalent to omission. Use agents.versions.apply to activate an existing saved version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: "custom", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send "latest", to use the skill's newest version when a session starts. type anthropic returns 400. Assume agents reject model, models, subagent_model, subagents and multiagent on every update; other fields follow the general agent rules, with vault_ids also accepted.
|
|
897
959
|
*/
|
|
898
960
|
export declare const agentsUpdate: <ThrowOnError extends boolean = false>(options: Options<AgentsUpdateData, ThrowOnError>) => RequestResult<AgentsUpdateResponses, AgentsUpdateErrors, ThrowOnError>;
|
|
899
961
|
/**
|
|
@@ -917,7 +979,7 @@ export declare const sessionsList: <ThrowOnError extends boolean = false>(option
|
|
|
917
979
|
/**
|
|
918
980
|
* Create session
|
|
919
981
|
*
|
|
920
|
-
* Create a session: one conversation with an agent. Pass agent as an agent id or {type:"agent", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:"agent_with_overrides", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:"limit", max_list_cost:{amount, currency:"USD"}} where amount is a positive decimal string of US dollars with at most 2 decimal places ("20.00" is USD 20.00); omitted budget defaults to "20.00" and null removes the limit. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.
|
|
982
|
+
* Create a session: one conversation with an agent. Pass agent as an agent id or {type:"agent", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:"agent_with_overrides", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:"limit", max_list_cost:{amount, currency:"USD"}} where amount is a positive decimal string of US dollars with at most 2 decimal places ("20.00" is USD 20.00); omitted budget defaults to "20.00" and null removes the limit. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion. Assume agents return 400 INVALID_PARAMS; drive them over MCP at /agent/v1/agents/{id}/mcp instead.
|
|
921
983
|
*/
|
|
922
984
|
export declare const sessionsCreate: <ThrowOnError extends boolean = false>(options: Options<SessionsCreateData, ThrowOnError>) => RequestResult<SessionsCreateResponses, SessionsCreateErrors, ThrowOnError>;
|
|
923
985
|
/**
|
|
@@ -1037,7 +1099,7 @@ export declare const deploymentsList: <ThrowOnError extends boolean = false>(opt
|
|
|
1037
1099
|
/**
|
|
1038
1100
|
* Create deployment
|
|
1039
1101
|
*
|
|
1040
|
-
* Freeze session parameters as a deployment; this operation does not open a session. Pass an agent id or versioned reference, a name, 1–50 user.message initial events and an environment_id from environments.list. Unlike Anthropic Managed Agents, /agent/v1 also accepts agent_with_overrides (model, permission_mode and cwd) and target=computer for personal agents, with environment_id omitted. Cron schedules use five POSIX fields and an IANA timezone. File resources are accepted. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Active schedules run every minute when due; session creation errors pause the deployment. Unsupported tools, mcp_servers, system and skills overrides return 400.
|
|
1102
|
+
* Freeze session parameters as a deployment; this operation does not open a session. Pass an agent id or versioned reference, a name, 1–50 user.message initial events and an environment_id from environments.list. Unlike Anthropic Managed Agents, /agent/v1 also accepts agent_with_overrides (model, permission_mode and cwd) and target=computer for general and personal agents, with environment_id omitted. Cron schedules use five POSIX fields and an IANA timezone. File resources are accepted. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Active schedules run every minute when due; session creation errors pause the deployment. Unsupported tools, mcp_servers, system and skills overrides return 400.
|
|
1041
1103
|
*/
|
|
1042
1104
|
export declare const deploymentsCreate: <ThrowOnError extends boolean = false>(options: Options<DeploymentsCreateData, ThrowOnError>) => RequestResult<DeploymentsCreateResponses, DeploymentsCreateErrors, ThrowOnError>;
|
|
1043
1105
|
/**
|
|
@@ -1265,7 +1327,7 @@ export declare const applicationListGrants: <ThrowOnError extends boolean = fals
|
|
|
1265
1327
|
/**
|
|
1266
1328
|
* Create grant
|
|
1267
1329
|
*
|
|
1268
|
-
*
|
|
1330
|
+
* Record access to an organization-owned database or knowledge base, all organization files (files, id *), or models (models, id *, read only). Each resource and optional alias must be unique within this Worker. Foreign and missing resources both return RESOURCE_NOT_FOUND (404); an unavailable resource service returns PROVIDER_CAPACITY (503, retryable).
|
|
1269
1331
|
*/
|
|
1270
1332
|
export declare const applicationCreateGrant: <ThrowOnError extends boolean = false>(options: Options<ApplicationCreateGrantData, ThrowOnError>) => RequestResult<ApplicationCreateGrantResponses, ApplicationCreateGrantErrors, ThrowOnError>;
|
|
1271
1333
|
/**
|
|
@@ -1313,7 +1375,7 @@ export declare const automationActionsGet: <ThrowOnError extends boolean = false
|
|
|
1313
1375
|
/**
|
|
1314
1376
|
* Update an action
|
|
1315
1377
|
*
|
|
1316
|
-
* Update after checking compatibility against the current and five recent revisions. Widening inputs and narrowing outputs are compatible, including length, item count, property count, type (integer/number), and multipleOf (the new input factor divides the old one; the reverse holds for outputs). dry_run=true returns only CompatResult and may omit If-Match; a supplied header is still checked, and * matches any existing representation. Normal updates require If-Match and return ActionDef with ETag; previews return no ETag. Omitted optional fields retain their existing values only for description and labels; when constructing a new revision, errors defaults to [], omitted annotations keys to false, timeout_ms to
|
|
1378
|
+
* Update after checking compatibility against the current and five recent revisions. Widening inputs and narrowing outputs are compatible, including length, item count, property count, type (integer/number), and multipleOf (the new input factor divides the old one; the reverse holds for outputs). dry_run=true returns only CompatResult and may omit If-Match; a supplied header is still checked, and * matches any existing representation. Normal updates require If-Match and return ActionDef with ETag; previews return no ETag. Omitted optional fields retain their existing values only for description and labels; when constructing a new revision, errors defaults to [], omitted annotations keys to false, timeout_ms to 300000, and message to null. Incompatible normal updates return 422 SCHEMA_INCOMPATIBLE with issues; unchanged contents retain the existing revision.
|
|
1317
1379
|
*/
|
|
1318
1380
|
export declare const automationActionsUpdate: <ThrowOnError extends boolean = false>(options: Options<AutomationActionsUpdateData, ThrowOnError>) => RequestResult<AutomationActionsUpdateResponses, AutomationActionsUpdateErrors, ThrowOnError>;
|
|
1319
1381
|
/**
|
|
@@ -1445,7 +1507,7 @@ export declare const automationWorkflowsList: <ThrowOnError extends boolean = fa
|
|
|
1445
1507
|
/**
|
|
1446
1508
|
* Create a workflow
|
|
1447
1509
|
*
|
|
1448
|
-
* Save a YAML workflow as an editable draft; this does not validate, publish or run it, so check it with validate (kind=workflow) first. Minimal draft: document with dsl ("1.0.3"), namespace, name and version, plus a do list of steps, for example document: {dsl: "1.0.3", namespace: demo, name: add, version: "1.0.0"} and do: [{first: {call: demo/add-one, with: {n: "${ .n }"}}}]. call: <ns/name> calls an Action directly (bare name for built-ins such as ocr) and with is the Action input; the input contract is at current_revision.input_schema in the get-action response. run: starts a saved script or child workflow. The run input is . in the first step, and expressions are jq written as a whole ${ ... } string. Limits: Action
|
|
1510
|
+
* Workflow syntax reference: https://deepraxis.com/docs/developers/automation/reference/workflow-syntax. Save a YAML workflow as an editable draft; this does not validate, publish or run it, so check it with validate (kind=workflow) first. Minimal draft: document with dsl ("1.0.3"), namespace, name and version, plus a do list of steps, for example document: {dsl: "1.0.3", namespace: demo, name: add, version: "1.0.0"} and do: [{first: {call: demo/add-one, with: {n: "${ .n }"}}}]. call: <ns/name> calls an Action directly (bare name for built-ins such as ocr) and with is the Action input; the input contract is at current_revision.input_schema in the get-action response. run: starts a saved script or child workflow. The run input is . in the first step, and expressions are jq written as a whole ${ ... } string. Limits: Action 5 min (run-sandbox 6 h), workflow 24 h by default and 30 days at most, payload 1 MiB. Test the draft by sending its source and language=yaml to praxis.automation.runs.create. To pause for a person, call praxis/approval (it opens a human task; the step output is the decision); agents answer with praxis.automation.humanTasks.respond on behalf of their user. Guide: /docs/developers/automation/guides/approvals Guide: /docs/developers/automation/guides/write-workflow. Error details are in the errors[] of the response (pointer, detail, hint). Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. run.workflow accepts ns/name@range or {namespace, name, version, input}; run.script uses the same reference shape as a platform extension. Object namespace, name and version are required; version accepts an exact version, dist-tag or range, locked at publication. Object input defaults to {} and supports expressions; string references retain task-level with. run.await defaults to true and returns the child output. With false, the child uses detach and the task immediately returns {run_id}; parent cancellation does not cascade. Inline script.code returns DEFINITION_INVALID with a detail asking you to save a script and reference it first. raise.error retains its type URI, status, title and detail in the run error.
|
|
1449
1511
|
*/
|
|
1450
1512
|
export declare const automationWorkflowsCreate: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsCreateData, ThrowOnError>) => RequestResult<AutomationWorkflowsCreateResponses, AutomationWorkflowsCreateErrors, ThrowOnError>;
|
|
1451
1513
|
/**
|
|
@@ -1457,7 +1519,7 @@ export declare const automationWorkflowsGet: <ThrowOnError extends boolean = fal
|
|
|
1457
1519
|
/**
|
|
1458
1520
|
* Update a workflow draft
|
|
1459
1521
|
*
|
|
1460
|
-
* Update description, labels or draft with the current draft revision in If-Match, taken from draft.revision in the get-workflow response. Even metadata-only updates create a new draft revision. A mismatch returns 412 PRECONDITION_FAILED; read the draft again, merge and retry. The draft is not validated here, so check it with validate (kind=workflow) before publishing. Error details are in errors[].
|
|
1522
|
+
* Update description, labels or draft with the current draft revision in If-Match, taken from draft.revision in the get-workflow response. Even metadata-only updates create a new draft revision. A mismatch returns 412 PRECONDITION_FAILED; read the draft again, merge and retry. The draft is not validated here, so check it with validate (kind=workflow) before publishing. Error details are in errors[]. See the workflow syntax reference at https://deepraxis.com/docs/developers/automation/reference/workflow-syntax.
|
|
1461
1523
|
*/
|
|
1462
1524
|
export declare const automationWorkflowsPatch: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsPatchData, ThrowOnError>) => RequestResult<AutomationWorkflowsPatchResponses, AutomationWorkflowsPatchErrors, ThrowOnError>;
|
|
1463
1525
|
/**
|
|
@@ -1517,7 +1579,7 @@ export declare const automationWorkflowsSetDistTag: <ThrowOnError extends boolea
|
|
|
1517
1579
|
/**
|
|
1518
1580
|
* Validate a definition
|
|
1519
1581
|
*
|
|
1520
|
-
* Check source without executing it when you need diagnostics, inferred schemas or references. This is optional before praxis.automation.runs.create, which also validates source before execution. Actions, scripts and workflows are supported; results include validity without saving. Invalid source is reported with valid=false. Script/action output schemas are inferred from return types: Promise unwrapping, Record, intersections and Date. Unknown types yield an empty schema and a warning in warnings. Source diagnostics use /source or /implementation/source with 1-based line/column. For kind=action the same admission checks as action creation apply (no external imports, platform operations only as direct call(praxis/<api>.<op>, input) calls, no agent or automation calls), so source that validates is not rejected at creation. For kind=workflow the YAML needs document (dsl, namespace, name, version) and do; each problem is one entry in errors[] (pointer, detail, hint), so read the first one. A listen outside the supported subset (to.all, inside a fork) and emit are not reported here and fail with DEFINITION_INVALID only when a run is created.
|
|
1582
|
+
* Check source without executing it when you need diagnostics, inferred schemas or references. This is optional before praxis.automation.runs.create, which also validates source before execution. Actions, scripts and workflows are supported; results include validity without saving. Invalid source is reported with valid=false. Script/action output schemas are inferred from return types: Promise unwrapping, Record, intersections and Date. Unknown types yield an empty schema and a warning in warnings. Source diagnostics use /source or /implementation/source with 1-based line/column. For kind=action the same admission checks as action creation apply (no external imports, platform operations only as direct call(praxis/<api>.<op>, input) calls, no agent or automation calls), so source that validates is not rejected at creation. For kind=workflow the YAML needs document (dsl, namespace, name, version) and do; each problem is one entry in errors[] (pointer, detail, hint), so read the first one. A listen outside the supported subset (to.all, inside a fork) and emit are not reported here and fail with DEFINITION_INVALID only when a run is created. Workflow syntax reference: https://deepraxis.com/docs/developers/automation/reference/workflow-syntax.
|
|
1521
1583
|
*/
|
|
1522
1584
|
export declare const automationValidateValidate: <ThrowOnError extends boolean = false>(options: Options<AutomationValidateValidateData, ThrowOnError>) => RequestResult<AutomationValidateValidateResponses, AutomationValidateValidateErrors, ThrowOnError>;
|
|
1523
1585
|
/**
|
|
@@ -1541,7 +1603,7 @@ export declare const automationRunsList: <ThrowOnError extends boolean = false>(
|
|
|
1541
1603
|
/**
|
|
1542
1604
|
* Run a published target or execute draft source
|
|
1543
1605
|
*
|
|
1544
|
-
* Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call("ocr", { document: { type: "file", file_id } }); return result; }`; send it as source with language="ts", input={"file_id":"<uploaded file ID>"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: "glm-ocr", document: { type: "file", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke("namespace/name", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after
|
|
1606
|
+
* Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call("ocr", { document: { type: "file", file_id } }); return result; }`; send it as source with language="ts", input={"file_id":"<uploaded file ID>"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: "glm-ocr", document: { type: "file", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke("namespace/name", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 5 min (run-sandbox after 6 h); scripts have a 30 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 30 days. Each run can start at most 1,000 child runs, with at most 100 active at once; nesting depth is limited to 10. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. With language=yaml, source is a workflow YAML: the run input is . in the first step, and the shape is described in create workflow. Error details are in errors[] (pointer, detail, hint). New non-deterministic run IDs contain 78 characters, compared with 46 for legacy random IDs; treat IDs as opaque strings. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed.
|
|
1545
1607
|
*/
|
|
1546
1608
|
export declare const automationRunsCreate: <ThrowOnError extends boolean = false>(options: Options<AutomationRunsCreateData, ThrowOnError>) => RequestResult<AutomationRunsCreateResponses, AutomationRunsCreateErrors, ThrowOnError>;
|
|
1547
1609
|
/**
|
|
@@ -1725,457 +1787,1376 @@ export declare const automationHumanTasksCancel: <ThrowOnError extends boolean =
|
|
|
1725
1787
|
*/
|
|
1726
1788
|
export declare const automationHumanTasksDelegate: <ThrowOnError extends boolean = false>(options: Options<AutomationHumanTasksDelegateData, ThrowOnError>) => RequestResult<AutomationHumanTasksDelegateResponses, AutomationHumanTasksDelegateErrors, ThrowOnError>;
|
|
1727
1789
|
/**
|
|
1728
|
-
* List
|
|
1790
|
+
* List script vault bindings
|
|
1729
1791
|
*
|
|
1730
|
-
*
|
|
1792
|
+
* Inspect the whole vaults attached to a saved script, including archived definitions, without reading secret values. Obtain ns and name from automation.scripts.list. Bindings belong to the definition rather than a published version. When vault or secret metadata cannot be read, the binding remains visible with secrets: [] and secrets_unavailable: true.
|
|
1731
1793
|
*/
|
|
1732
|
-
export declare const
|
|
1794
|
+
export declare const automationScriptsVaultsList: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsVaultsListData, ThrowOnError>) => RequestResult<AutomationScriptsVaultsListResponses, AutomationScriptsVaultsListErrors, ThrowOnError>;
|
|
1733
1795
|
/**
|
|
1734
|
-
*
|
|
1796
|
+
* Delete a script vault binding
|
|
1735
1797
|
*
|
|
1736
|
-
*
|
|
1798
|
+
* Remove the vault assignment from this saved script without deleting the vault or its secrets. Obtain aliases from automation.scripts.vaults.list. Repeating deletion of an absent alias on an existing definition succeeds. Bindings also disappear when the definition is permanently deleted, while archival retains them.
|
|
1737
1799
|
*/
|
|
1738
|
-
export declare const
|
|
1800
|
+
export declare const automationScriptsVaultsDelete: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsVaultsDeleteData, ThrowOnError>) => RequestResult<AutomationScriptsVaultsDeleteResponses, AutomationScriptsVaultsDeleteErrors, ThrowOnError>;
|
|
1739
1801
|
/**
|
|
1740
|
-
*
|
|
1802
|
+
* Set a script vault binding
|
|
1741
1803
|
*
|
|
1742
|
-
*
|
|
1804
|
+
* Attach an entire active vault in your organization to a saved script, or replace the vault at an existing alias. Obtain the vault ID or display name from praxis.vault.vaults.list; ambiguous names require an ID. Bindings are independent of published versions and survive archival. The same vault cannot be assigned to two aliases on one definition. Repeating the same assignment is idempotent. Example body: {"vault":"Production"}.
|
|
1743
1805
|
*/
|
|
1744
|
-
export declare const
|
|
1806
|
+
export declare const automationScriptsVaultsSet: <ThrowOnError extends boolean = false>(options: Options<AutomationScriptsVaultsSetData, ThrowOnError>) => RequestResult<AutomationScriptsVaultsSetResponses, AutomationScriptsVaultsSetErrors, ThrowOnError>;
|
|
1745
1807
|
/**
|
|
1746
|
-
*
|
|
1808
|
+
* List workflow vault bindings
|
|
1747
1809
|
*
|
|
1748
|
-
*
|
|
1810
|
+
* Inspect the whole vaults attached to a saved workflow, including archived definitions, without reading secret values. Obtain ns and name from automation.workflows.list. Bindings belong to the definition rather than a published version. When vault or secret metadata cannot be read, the binding remains visible with secrets: [] and secrets_unavailable: true.
|
|
1749
1811
|
*/
|
|
1750
|
-
export declare const
|
|
1812
|
+
export declare const automationWorkflowsVaultsList: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsVaultsListData, ThrowOnError>) => RequestResult<AutomationWorkflowsVaultsListResponses, AutomationWorkflowsVaultsListErrors, ThrowOnError>;
|
|
1751
1813
|
/**
|
|
1752
|
-
*
|
|
1814
|
+
* Delete a workflow vault binding
|
|
1753
1815
|
*
|
|
1754
|
-
*
|
|
1816
|
+
* Remove the vault assignment from this saved workflow without deleting the vault or its secrets. Obtain aliases from automation.workflows.vaults.list. Repeating deletion of an absent alias on an existing definition succeeds. Bindings also disappear when the definition is permanently deleted, while archival retains them.
|
|
1755
1817
|
*/
|
|
1756
|
-
export declare const
|
|
1818
|
+
export declare const automationWorkflowsVaultsDelete: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsVaultsDeleteData, ThrowOnError>) => RequestResult<AutomationWorkflowsVaultsDeleteResponses, AutomationWorkflowsVaultsDeleteErrors, ThrowOnError>;
|
|
1757
1819
|
/**
|
|
1758
|
-
*
|
|
1820
|
+
* Set a workflow vault binding
|
|
1759
1821
|
*
|
|
1760
|
-
*
|
|
1822
|
+
* Attach an entire active vault in your organization to a saved workflow, or replace the vault at an existing alias. Obtain the vault ID or display name from praxis.vault.vaults.list; ambiguous names require an ID. Bindings are independent of published versions and survive archival. The same vault cannot be assigned to two aliases on one definition. Repeating the same assignment is idempotent. Example body: {"vault":"Production"}.
|
|
1761
1823
|
*/
|
|
1762
|
-
export declare const
|
|
1824
|
+
export declare const automationWorkflowsVaultsSet: <ThrowOnError extends boolean = false>(options: Options<AutomationWorkflowsVaultsSetData, ThrowOnError>) => RequestResult<AutomationWorkflowsVaultsSetResponses, AutomationWorkflowsVaultsSetErrors, ThrowOnError>;
|
|
1763
1825
|
/**
|
|
1764
|
-
*
|
|
1826
|
+
* List canvases
|
|
1765
1827
|
*
|
|
1766
|
-
*
|
|
1828
|
+
* Discover canvases in the API key's organization and obtain ids for retrieval or editing. Results are ordered by updated_at from newest to oldest. limit is 1–100 and defaults to 50; omit cursor for the first page, then copy next_cursor into the next request until it is null. Deleted canvases are unavailable.
|
|
1767
1829
|
*/
|
|
1768
|
-
export declare const
|
|
1830
|
+
export declare const canvasListCanvases: <ThrowOnError extends boolean = false>(options?: Options<CanvasListCanvasesData, ThrowOnError>) => RequestResult<CanvasListCanvasesResponses, CanvasListCanvasesErrors, ThrowOnError>;
|
|
1769
1831
|
/**
|
|
1770
|
-
*
|
|
1832
|
+
* Create canvas
|
|
1771
1833
|
*
|
|
1772
|
-
*
|
|
1834
|
+
* Create a blank design canvas in the API key's organization before drawing with praxis.canvas.canvases.execute. Send an optional name of at most 200 characters; omitting name uses Untitled. Each successful call creates a new canvas and returns its id and viewer_url with HTTP 201; save the id for subsequent reads, edits and deletion.
|
|
1773
1835
|
*/
|
|
1774
|
-
export declare const
|
|
1836
|
+
export declare const canvasCreateCanvas: <ThrowOnError extends boolean = false>(options?: Options<CanvasCreateCanvasData, ThrowOnError>) => RequestResult<CanvasCreateCanvasResponses, CanvasCreateCanvasErrors, ThrowOnError>;
|
|
1775
1837
|
/**
|
|
1776
|
-
*
|
|
1838
|
+
* Delete canvas
|
|
1777
1839
|
*
|
|
1778
|
-
*
|
|
1840
|
+
* Permanently delete a canvas and its design content when it is no longer needed. Obtain canvas_id from create or list and confirm the target before calling; deletion cannot be undone. HTTP 200 confirms deletion with deleted=true. Subsequent access returns CANVAS_NOT_FOUND, as it does for a missing canvas or one outside the API key's organization.
|
|
1779
1841
|
*/
|
|
1780
|
-
export declare const
|
|
1842
|
+
export declare const canvasDeleteCanvas: <ThrowOnError extends boolean = false>(options: Options<CanvasDeleteCanvasData, ThrowOnError>) => RequestResult<CanvasDeleteCanvasResponses, CanvasDeleteCanvasErrors, ThrowOnError>;
|
|
1781
1843
|
/**
|
|
1782
|
-
*
|
|
1844
|
+
* Retrieve canvas
|
|
1783
1845
|
*
|
|
1784
|
-
*
|
|
1846
|
+
* Inspect the current canvas before editing, like Pencil get_app_state. The response adds top-level node summaries in canvas order and reusable component ids to the canvas metadata. Use these ids in nodes.list, images.list or an execute script; use the returned version as expected_version to detect concurrent edits. Read full node content with nodes.list rather than guessing fields from these summaries.
|
|
1785
1847
|
*/
|
|
1786
|
-
export declare const
|
|
1848
|
+
export declare const canvasRetrieveCanvas: <ThrowOnError extends boolean = false>(options: Options<CanvasRetrieveCanvasData, ThrowOnError>) => RequestResult<CanvasRetrieveCanvasResponses, CanvasRetrieveCanvasErrors, ThrowOnError>;
|
|
1787
1849
|
/**
|
|
1788
|
-
*
|
|
1850
|
+
* Update canvas
|
|
1789
1851
|
*
|
|
1790
|
-
*
|
|
1852
|
+
* Rename a canvas or move it to a collection without editing its design content. Use a canvas id from canvases.list and a collection id from collections.list. Send collection_id=null to make it uncategorized; omit either field to preserve its current value. A canvas belongs to at most one collection. The destination must belong to your organization. Renaming keeps the canvas version unchanged.
|
|
1791
1853
|
*/
|
|
1792
|
-
export declare const
|
|
1854
|
+
export declare const canvasUpdateCanvas: <ThrowOnError extends boolean = false>(options: Options<CanvasUpdateCanvasData, ThrowOnError>) => RequestResult<CanvasUpdateCanvasResponses, CanvasUpdateCanvasErrors, ThrowOnError>;
|
|
1793
1855
|
/**
|
|
1794
|
-
*
|
|
1856
|
+
* Read canvas nodes
|
|
1795
1857
|
*
|
|
1796
|
-
*
|
|
1858
|
+
* Read node documents for inspection before changing individual nodes. Supply 1–100 comma-separated node ids from retrieve or execute, or instance paths such as a/b. depth is an integer at least 0; omit it for complete subtrees. Each requested id maps to a document wrapper or null if absent. Unlike Figma, document contains a Pencil .pen 2.21 node, not a Figma node. For top-level summaries use canvases.retrieve; for pixels use images.list.
|
|
1797
1859
|
*/
|
|
1798
|
-
export declare const
|
|
1860
|
+
export declare const canvasListNodes: <ThrowOnError extends boolean = false>(options: Options<CanvasListNodesData, ThrowOnError>) => RequestResult<CanvasListNodesResponses, CanvasListNodesErrors, ThrowOnError>;
|
|
1799
1861
|
/**
|
|
1800
|
-
*
|
|
1862
|
+
* Render canvas nodes
|
|
1801
1863
|
*
|
|
1802
|
-
*
|
|
1864
|
+
* Render 1–4 nodes to inspect the visual result of a design edit. Use ids from retrieve, execute.created or execute.screenshots; scale defaults to 1 and accepts 0.25–4, and png is the only supported format. Unlike Figma, images contains inline data:image/png;base64,... URLs, not hosted image URLs; a null entry means no image is available for that id. Use nodes.list for editable node content instead of pixels.
|
|
1803
1865
|
*/
|
|
1804
|
-
export declare const
|
|
1866
|
+
export declare const canvasListImages: <ThrowOnError extends boolean = false>(options: Options<CanvasListImagesData, ThrowOnError>) => RequestResult<CanvasListImagesResponses, CanvasListImagesErrors, ThrowOnError>;
|
|
1805
1867
|
/**
|
|
1806
|
-
*
|
|
1868
|
+
* Execute canvas script
|
|
1869
|
+
*
|
|
1870
|
+
* Draw or edit a canvas atomically with a synchronous Pencil execute script. First create a canvas with praxis.canvas.canvases.create and use its id as canvas_id; inspect an existing canvas with retrieve before modifying it. Send exactly one of script (new source) or edit_id (a failed script to patch using edits). Unlike Figma REST, :execute writes design content; nodes use Pencil .pen schema 2.21 (frame/group/rectangle/ellipse/polygon/path/text/icon/ref/note), not Figma node fields.
|
|
1871
|
+
*
|
|
1872
|
+
* The root variable is document. Synchronous functions are Insert / Copy / Update / Replace / Move / Delete / SetVariables / Get / GetVariables / FindEmptySpace / Print / TakeScreenshot; globals persist for the next call. A first frame needs only this body.script:
|
|
1873
|
+
*
|
|
1874
|
+
* ```js
|
|
1875
|
+
* const f = Insert(document, { type: "frame", name: "Hero", width: 1200, layout: "vertical", padding: 48, fill: "#FFFFFF" }); Insert(f, { type: "text", content: "Hello", fontSize: 32, fill: "#111111" }); Print(f)
|
|
1876
|
+
* ```
|
|
1877
|
+
*
|
|
1878
|
+
* Insert/Copy return the new node id; read the copy with Get(id) — copied descendants get new ids, so change them through Copy's third argument `descendants` keyed by the source node ids. To copy a page and change its title in the same script:
|
|
1879
|
+
*
|
|
1880
|
+
* ```js canvas-example="copy-page"
|
|
1881
|
+
* const page = Insert(document, {type:"frame",name:"Original",width:320,height:160,layout:"vertical",padding:16});
|
|
1882
|
+
* const title = Insert(page, {type:"text",name:"Title",content:"Original",fontSize:24});
|
|
1883
|
+
* const copy = Copy(page, document, {name:"Copy",x:360,descendants:{[title]:{content:"Updated"}}});
|
|
1884
|
+
* Print(copy); Print(Get(copy).children[0].content);
|
|
1885
|
+
* ```
|
|
1886
|
+
*
|
|
1887
|
+
* Use viewer_url to watch the result in Console. TakeScreenshot records node ids in screenshots; call images.list with those ids to fetch PNG data URLs. See the [Canvas execute reference](https://deepraxis.com/en/docs/api/native/canvas/execute) for request fields and results, and the [Canvas node reference](https://deepraxis.com/en/docs/developers/canvas/nodes) for node content.
|
|
1888
|
+
*
|
|
1889
|
+
* A successful write increments version by one. Optionally set expected_version to the version from retrieve or nodes.list; on 409 REVISION_CONFLICT read again, merge your intent and retry with the current version. Every script failure rolls back all writes. On 400 SCRIPT_ERROR, SCRIPT_LIMIT or OPS_REJECTED, use error.details.edit_id plus edits to repair and rerun the stored source without resending the entire script; details may include line, column and rejection. On 400 EDIT_EXPIRED the saved script is older than ten minutes: submit a corrected new script. On 429 CANVAS_BUSY, more than four calls are queued for this canvas: wait for pending calls before retrying.
|
|
1890
|
+
*
|
|
1891
|
+
* Execution errors include error.details.prints containing output printed before failure, with the same string-array shape and output limit as successful prints; rolled-back writes still create no version.
|
|
1807
1892
|
*
|
|
1808
|
-
* Deletes one field definition from a table and returns the updated table; the deletion is immediate and has no recovery window. Look the field up by id or name. The field's index, if any, is dropped with it, and the name can be reused afterwards. Unknown fields return 400 FIELD_NOT_FOUND.
|
|
1809
1893
|
*/
|
|
1810
|
-
export declare const
|
|
1894
|
+
export declare const canvasExecute: <ThrowOnError extends boolean = false>(options: Options<CanvasExecuteData, ThrowOnError>) => RequestResult<CanvasExecuteResponses, CanvasExecuteErrors, ThrowOnError>;
|
|
1811
1895
|
/**
|
|
1812
|
-
*
|
|
1896
|
+
* List collections
|
|
1813
1897
|
*
|
|
1814
|
-
*
|
|
1898
|
+
* Find collections and ids for filtering or moving canvases. All organization collections are returned in name order in one response; next_cursor is always null. canvas_count excludes deleted canvases. total_count counts all live canvases, rather than collections, and uncategorized_count counts live canvases without a collection. Use canvases.list with collection_id to read a collection or none to read uncategorized canvases.
|
|
1815
1899
|
*/
|
|
1816
|
-
export declare const
|
|
1900
|
+
export declare const canvasListCollections: <ThrowOnError extends boolean = false>(options?: Options<CanvasListCollectionsData, ThrowOnError>) => RequestResult<CanvasListCollectionsResponses, CanvasListCollectionsErrors, ThrowOnError>;
|
|
1817
1901
|
/**
|
|
1818
|
-
*
|
|
1902
|
+
* Create collection
|
|
1819
1903
|
*
|
|
1820
|
-
*
|
|
1904
|
+
* Organize canvases by creating a one-level collection in your organization. Send a name of 1–100 characters after trimming; duplicate names are allowed. Each call creates a new collection, initially containing no canvases. Use canvases.update with its id as collection_id to move existing canvases into it. Collections cannot be nested and an organization can have at most 200.
|
|
1821
1905
|
*/
|
|
1822
|
-
export declare const
|
|
1906
|
+
export declare const canvasCreateCollection: <ThrowOnError extends boolean = false>(options: Options<CanvasCreateCollectionData, ThrowOnError>) => RequestResult<CanvasCreateCollectionResponses, CanvasCreateCollectionErrors, ThrowOnError>;
|
|
1823
1907
|
/**
|
|
1824
|
-
* Delete
|
|
1908
|
+
* Delete collection
|
|
1825
1909
|
*
|
|
1826
|
-
*
|
|
1910
|
+
* Remove a collection using an id from collections.list. All its canvases are preserved and become uncategorized, with collection_id set to null; read them using canvases.list with collection_id=none. The removed collection cannot be retrieved again, and repeating deletion returns COLLECTION_NOT_FOUND.
|
|
1827
1911
|
*/
|
|
1828
|
-
export declare const
|
|
1912
|
+
export declare const canvasDeleteCollection: <ThrowOnError extends boolean = false>(options: Options<CanvasDeleteCollectionData, ThrowOnError>) => RequestResult<CanvasDeleteCollectionResponses, CanvasDeleteCollectionErrors, ThrowOnError>;
|
|
1829
1913
|
/**
|
|
1830
|
-
*
|
|
1914
|
+
* Retrieve collection
|
|
1831
1915
|
*
|
|
1832
|
-
*
|
|
1916
|
+
* Inspect one collection and its current live canvas count using an id from collections.list or collections.create. The collection must belong to the API key organization. To read its canvases, pass the same id as collection_id to canvases.list; this response contains collection metadata only.
|
|
1833
1917
|
*/
|
|
1834
|
-
export declare const
|
|
1918
|
+
export declare const canvasRetrieveCollection: <ThrowOnError extends boolean = false>(options: Options<CanvasRetrieveCollectionData, ThrowOnError>) => RequestResult<CanvasRetrieveCollectionResponses, CanvasRetrieveCollectionErrors, ThrowOnError>;
|
|
1835
1919
|
/**
|
|
1836
|
-
*
|
|
1920
|
+
* Rename collection
|
|
1837
1921
|
*
|
|
1838
|
-
*
|
|
1922
|
+
* Change the display name of a collection from collections.list without changing its id or canvas assignments. Names contain 1–100 characters after trimming and may match another collection name. This operation does not move canvases; use canvases.update with collection_id for that.
|
|
1839
1923
|
*/
|
|
1840
|
-
export declare const
|
|
1924
|
+
export declare const canvasUpdateCollection: <ThrowOnError extends boolean = false>(options: Options<CanvasUpdateCollectionData, ThrowOnError>) => RequestResult<CanvasUpdateCollectionResponses, CanvasUpdateCollectionErrors, ThrowOnError>;
|
|
1841
1925
|
/**
|
|
1842
|
-
*
|
|
1926
|
+
* List canvas versions
|
|
1843
1927
|
*
|
|
1844
|
-
*
|
|
1928
|
+
* Inspect retained edits before restoring a canvas or reading historical nodes and images. Supply a canvas_id from canvases.list or create. Results include successful execute, import and restore commits since history was enabled, newest first. limit is 1–100 and defaults to 30; pass next_cursor as cursor until it is null. All versions from the last 30 days are retained unless the 256 MiB history budget requires pruning; the newest 100 versions are always retained regardless of age or size. earliest_restorable_version is the oldest readable and restorable version, including the state immediately before the first retained commit; null means no history has been recorded. Listing does not change the canvas.
|
|
1845
1929
|
*/
|
|
1846
|
-
export declare const
|
|
1930
|
+
export declare const canvasListVersions: <ThrowOnError extends boolean = false>(options: Options<CanvasListVersionsData, ThrowOnError>) => RequestResult<CanvasListVersionsResponses, CanvasListVersionsErrors, ThrowOnError>;
|
|
1847
1931
|
/**
|
|
1848
|
-
*
|
|
1932
|
+
* Restore canvas version
|
|
1849
1933
|
*
|
|
1850
|
-
*
|
|
1851
|
-
* Rows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.
|
|
1852
|
-
* The default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.
|
|
1934
|
+
* Recover a canvas after an unwanted edit by restoring a retained version from versions.list or its earliest_restorable_version. This replaces current nodes, variables and themes with the target state and creates one new version; history remains available, so restoring can itself be undone with another restore. Restoring the current version succeeds without creating a version. Optionally guard the write with expected_version from retrieve or nodes.list; if it is stale, inspect current state and retry with the new value. Repeating an unguarded request after another edit can create another restore version. Versions from before history was enabled or outside retention cannot be recovered. Connected viewers resync after a successful restore.
|
|
1853
1935
|
*/
|
|
1854
|
-
export declare const
|
|
1936
|
+
export declare const canvasRestoreCanvas: <ThrowOnError extends boolean = false>(options: Options<CanvasRestoreCanvasData, ThrowOnError>) => RequestResult<CanvasRestoreCanvasResponses, CanvasRestoreCanvasErrors, ThrowOnError>;
|
|
1855
1937
|
/**
|
|
1856
|
-
* List
|
|
1938
|
+
* List records
|
|
1857
1939
|
*
|
|
1858
|
-
*
|
|
1940
|
+
* Browse records of one object type and obtain ids for retrieval or edits. Discover objectType with schemas.list; select properties by internal names from properties.list. Omit after for the first page, then copy paging.next.after until no next page is returned. archived defaults to false; use objects.search for property filters.
|
|
1859
1941
|
*/
|
|
1860
|
-
export declare const
|
|
1942
|
+
export declare const crmObjectsList: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsListData, ThrowOnError>) => RequestResult<CrmObjectsListResponses, CrmObjectsListErrors, ThrowOnError>;
|
|
1861
1943
|
/**
|
|
1862
|
-
* Create
|
|
1944
|
+
* Create record
|
|
1863
1945
|
*
|
|
1864
|
-
* Create a
|
|
1946
|
+
* Create a customer record with property values and optional initial associations. Discover objectType with schemas.list and allowed property names with properties.list; save the returned id for subsequent calls. Each call creates a record. Example for contacts: {"properties":{"email":"person@example.com"}}. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
1865
1947
|
*/
|
|
1866
|
-
export declare const
|
|
1948
|
+
export declare const crmObjectsCreate: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsCreateData, ThrowOnError>) => RequestResult<CrmObjectsCreateResponses, CrmObjectsCreateErrors, ThrowOnError>;
|
|
1867
1949
|
/**
|
|
1868
|
-
*
|
|
1950
|
+
* Archive record
|
|
1869
1951
|
*
|
|
1870
|
-
*
|
|
1952
|
+
* Archive a record selected from objects.list or objects.search when it should leave active results. This removes it from normal lists without deleting its history; archived=true can be used to read archived records. Confirm objectType and objectId before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.
|
|
1871
1953
|
*/
|
|
1872
|
-
export declare const
|
|
1954
|
+
export declare const crmObjectsArchive: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsArchiveData, ThrowOnError>) => RequestResult<CrmObjectsArchiveResponses, CrmObjectsArchiveErrors, ThrowOnError>;
|
|
1873
1955
|
/**
|
|
1874
|
-
* Retrieve
|
|
1956
|
+
* Retrieve record
|
|
1875
1957
|
*
|
|
1876
|
-
*
|
|
1958
|
+
* Read one record by id from objects.list, objects.search or objects.create. Select property names with properties and associated object types with associations; use idProperty only when objectId is a value of that unique property. Use archived=true to inspect an archived record.
|
|
1877
1959
|
*/
|
|
1878
|
-
export declare const
|
|
1960
|
+
export declare const crmObjectsRetrieve: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsRetrieveData, ThrowOnError>) => RequestResult<CrmObjectsRetrieveResponses, CrmObjectsRetrieveErrors, ThrowOnError>;
|
|
1879
1961
|
/**
|
|
1880
|
-
* Update
|
|
1962
|
+
* Update record
|
|
1881
1963
|
*
|
|
1882
|
-
*
|
|
1964
|
+
* Change only the supplied properties of a record selected from objects.list or objects.search. Omitted properties retain their values. Use property names from properties.list and valid stage ids from pipelines.retrieve. Stage-entry requirements must be satisfied by the resulting record; inspect 400 errors before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
1883
1965
|
*/
|
|
1884
|
-
export declare const
|
|
1966
|
+
export declare const crmObjectsUpdate: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsUpdateData, ThrowOnError>) => RequestResult<CrmObjectsUpdateResponses, CrmObjectsUpdateErrors, ThrowOnError>;
|
|
1885
1967
|
/**
|
|
1886
|
-
* Search
|
|
1968
|
+
* Search records
|
|
1887
1969
|
*
|
|
1888
|
-
*
|
|
1970
|
+
* Find records using text query, property filters and sort order rather than scanning a list. Obtain objectType from schemas.list and filter propertyName values from properties.list. Supply filterGroups, sorts, properties, limit and after; use empty arrays for no filters, sorts or property selection, and an empty after for the first page. Copy paging.next.after with the same query to continue. This operation reads records without changing them.
|
|
1889
1971
|
*/
|
|
1890
|
-
export declare const
|
|
1972
|
+
export declare const crmObjectsSearch: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsSearchData, ThrowOnError>) => RequestResult<CrmObjectsSearchResponses, CrmObjectsSearchErrors, ThrowOnError>;
|
|
1891
1973
|
/**
|
|
1892
|
-
*
|
|
1974
|
+
* Batch read records
|
|
1893
1975
|
*
|
|
1894
|
-
*
|
|
1976
|
+
* Read a set of known record ids in one call; use objects.search to discover ids first. Supply inputs with ids plus requested properties; set idProperty only when the inputs use unique-property values rather than record ids.
|
|
1895
1977
|
*/
|
|
1896
|
-
export declare const
|
|
1978
|
+
export declare const crmObjectsBatchRead: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsBatchReadData, ThrowOnError>) => RequestResult<CrmObjectsBatchReadResponses, CrmObjectsBatchReadErrors, ThrowOnError>;
|
|
1897
1979
|
/**
|
|
1898
|
-
*
|
|
1980
|
+
* Batch create records
|
|
1899
1981
|
*
|
|
1900
|
-
*
|
|
1982
|
+
* Create several records of one object type using inputs with properties and optional associations. Obtain property names from properties.list; each successful input creates a record, so inspect per-item errors before resubmitting failed inputs. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
1901
1983
|
*/
|
|
1902
|
-
export declare const
|
|
1984
|
+
export declare const crmObjectsBatchCreate: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsBatchCreateData, ThrowOnError>) => RequestResult<CrmObjectsBatchCreateResponses, CrmObjectsBatchCreateErrors, ThrowOnError>;
|
|
1903
1985
|
/**
|
|
1904
|
-
*
|
|
1986
|
+
* Batch update records
|
|
1905
1987
|
*
|
|
1906
|
-
*
|
|
1988
|
+
* Apply distinct property patches to existing records identified by inputs[].id. Obtain ids from objects.list or objects.search and property names from properties.list. Omitted properties retain their values; inspect results and errors for each input. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
1907
1989
|
*/
|
|
1908
|
-
export declare const
|
|
1990
|
+
export declare const crmObjectsBatchUpdate: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsBatchUpdateData, ThrowOnError>) => RequestResult<CrmObjectsBatchUpdateResponses, CrmObjectsBatchUpdateErrors, ThrowOnError>;
|
|
1909
1991
|
/**
|
|
1910
|
-
*
|
|
1992
|
+
* Batch upsert records
|
|
1911
1993
|
*
|
|
1912
|
-
*
|
|
1994
|
+
* Create records that do not yet exist or update matches using a unique property. Provide idProperty and its value in each input, plus properties; choose a property with hasUniqueValue from properties.list. Inspect each result to determine whether it was newly created. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
1913
1995
|
*/
|
|
1914
|
-
export declare const
|
|
1996
|
+
export declare const crmObjectsBatchUpsert: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsBatchUpsertData, ThrowOnError>) => RequestResult<CrmObjectsBatchUpsertResponses, CrmObjectsBatchUpsertErrors, ThrowOnError>;
|
|
1915
1997
|
/**
|
|
1916
|
-
*
|
|
1998
|
+
* Batch archive records
|
|
1917
1999
|
*
|
|
1918
|
-
*
|
|
2000
|
+
* Archive known records of one object type using inputs[].id from objects.list or objects.search. Archived records leave active lists but retain their history; confirm all ids before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.
|
|
1919
2001
|
*/
|
|
1920
|
-
export declare const
|
|
2002
|
+
export declare const crmObjectsBatchArchive: <ThrowOnError extends boolean = false>(options: Options<CrmObjectsBatchArchiveData, ThrowOnError>) => RequestResult<CrmObjectsBatchArchiveResponses, CrmObjectsBatchArchiveErrors, ThrowOnError>;
|
|
1921
2003
|
/**
|
|
1922
|
-
*
|
|
2004
|
+
* List properties
|
|
1923
2005
|
*
|
|
1924
|
-
*
|
|
2006
|
+
* Inspect the property definitions available for an object type before writing or filtering records. Obtain objectType from schemas.list; reuse each immutable name in record properties and filters. archived defaults to false.
|
|
1925
2007
|
*/
|
|
1926
|
-
export declare const
|
|
2008
|
+
export declare const crmPropertiesList: <ThrowOnError extends boolean = false>(options: Options<CrmPropertiesListData, ThrowOnError>) => RequestResult<CrmPropertiesListResponses, CrmPropertiesListErrors, ThrowOnError>;
|
|
1927
2009
|
/**
|
|
1928
|
-
* Create
|
|
2010
|
+
* Create property
|
|
1929
2011
|
*
|
|
1930
|
-
*
|
|
2012
|
+
* Define a property before setting its values on records. Choose objectType from schemas.list and groupName from properties.groups.list; provide an immutable internal name, display label, type and fieldType. Enumeration properties require their valid options. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
1931
2013
|
*/
|
|
1932
|
-
export declare const
|
|
2014
|
+
export declare const crmPropertiesCreate: <ThrowOnError extends boolean = false>(options: Options<CrmPropertiesCreateData, ThrowOnError>) => RequestResult<CrmPropertiesCreateResponses, CrmPropertiesCreateErrors, ThrowOnError>;
|
|
1933
2015
|
/**
|
|
1934
|
-
*
|
|
2016
|
+
* Archive property
|
|
1935
2017
|
*
|
|
1936
|
-
*
|
|
2018
|
+
* Archive a property definition selected by internal name from properties.list. Confirm that record entry and search flows no longer depend on it; archived definitions are excluded from normal property lists. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.
|
|
1937
2019
|
*/
|
|
1938
|
-
export declare const
|
|
2020
|
+
export declare const crmPropertiesArchive: <ThrowOnError extends boolean = false>(options: Options<CrmPropertiesArchiveData, ThrowOnError>) => RequestResult<CrmPropertiesArchiveResponses, CrmPropertiesArchiveErrors, ThrowOnError>;
|
|
1939
2021
|
/**
|
|
1940
|
-
*
|
|
2022
|
+
* Retrieve property
|
|
1941
2023
|
*
|
|
1942
|
-
*
|
|
2024
|
+
* Inspect the type, options and modification restrictions of a property before changing its definition or record values. Obtain propertyName from properties.list; it is the immutable internal name rather than the label.
|
|
1943
2025
|
*/
|
|
1944
|
-
export declare const
|
|
2026
|
+
export declare const crmPropertiesRetrieve: <ThrowOnError extends boolean = false>(options: Options<CrmPropertiesRetrieveData, ThrowOnError>) => RequestResult<CrmPropertiesRetrieveResponses, CrmPropertiesRetrieveErrors, ThrowOnError>;
|
|
1945
2027
|
/**
|
|
1946
|
-
*
|
|
2028
|
+
* Update property
|
|
1947
2029
|
*
|
|
1948
|
-
*
|
|
2030
|
+
* Change editable settings of a property selected from properties.list, such as its label, group or options. Preserve the immutable internal name; inspect modificationMetadata before editing system-managed definitions. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
1949
2031
|
*/
|
|
1950
|
-
export declare const
|
|
2032
|
+
export declare const crmPropertiesUpdate: <ThrowOnError extends boolean = false>(options: Options<CrmPropertiesUpdateData, ThrowOnError>) => RequestResult<CrmPropertiesUpdateResponses, CrmPropertiesUpdateErrors, ThrowOnError>;
|
|
1951
2033
|
/**
|
|
1952
|
-
*
|
|
2034
|
+
* List property groups
|
|
1953
2035
|
*
|
|
1954
|
-
*
|
|
2036
|
+
* Discover property groups for an object type before creating or organizing property definitions. Obtain objectType from schemas.list and reuse a group name as groupName in properties.create or properties.update.
|
|
1955
2037
|
*/
|
|
1956
|
-
export declare const
|
|
2038
|
+
export declare const crmPropertiesGroupsList: <ThrowOnError extends boolean = false>(options: Options<CrmPropertiesGroupsListData, ThrowOnError>) => RequestResult<CrmPropertiesGroupsListResponses, CrmPropertiesGroupsListErrors, ThrowOnError>;
|
|
1957
2039
|
/**
|
|
1958
|
-
*
|
|
2040
|
+
* Create property group
|
|
1959
2041
|
*
|
|
1960
|
-
*
|
|
2042
|
+
* Create a named group for related property definitions of one object type. Obtain objectType from schemas.list; choose a unique internal name and display label, then reuse the returned name as groupName when creating properties. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
1961
2043
|
*/
|
|
1962
|
-
export declare const
|
|
2044
|
+
export declare const crmPropertiesGroupsCreate: <ThrowOnError extends boolean = false>(options: Options<CrmPropertiesGroupsCreateData, ThrowOnError>) => RequestResult<CrmPropertiesGroupsCreateResponses, CrmPropertiesGroupsCreateErrors, ThrowOnError>;
|
|
1963
2045
|
/**
|
|
1964
|
-
*
|
|
2046
|
+
* List pipelines
|
|
1965
2047
|
*
|
|
1966
|
-
*
|
|
2048
|
+
* Discover pipelines and stage ids for records of one object type from schemas.list. Reuse pipeline and stage ids in record property updates or lead qualification. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is "true" (no further transition) or "false" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string "null" meaning unrestricted; praxis_required is a JSON-encoded array string of property names ("[]" means none) that must be non-empty on entry (boolean properties must be "true"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Example metadata: {"praxis_category":"open","praxis_terminal":"false","praxis_allowed_next":"[\"proposal\",\"lost\"]","praxis_required":"[\"budget\",\"decision_maker\"]"}.
|
|
1967
2049
|
*/
|
|
1968
|
-
export declare const
|
|
2050
|
+
export declare const crmPipelinesList: <ThrowOnError extends boolean = false>(options: Options<CrmPipelinesListData, ThrowOnError>) => RequestResult<CrmPipelinesListResponses, CrmPipelinesListErrors, ThrowOnError>;
|
|
1969
2051
|
/**
|
|
1970
|
-
*
|
|
2052
|
+
* Create pipeline
|
|
1971
2053
|
*
|
|
1972
|
-
*
|
|
2054
|
+
* Create a pipeline with its ordered stages for an object type from schemas.list. Provide a display label, displayOrder and initial stages, then use the returned ids when assigning records. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is "true" (no further transition) or "false" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string "null" meaning unrestricted; praxis_required is a JSON-encoded array string of property names ("[]" means none) that must be non-empty on entry (boolean properties must be "true"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {"praxis_category":"open","praxis_terminal":"false","praxis_allowed_next":"[\"proposal\",\"lost\"]","praxis_required":"[\"budget\",\"decision_maker\"]"}.
|
|
1973
2055
|
*/
|
|
1974
|
-
export declare const
|
|
2056
|
+
export declare const crmPipelinesCreate: <ThrowOnError extends boolean = false>(options: Options<CrmPipelinesCreateData, ThrowOnError>) => RequestResult<CrmPipelinesCreateResponses, CrmPipelinesCreateErrors, ThrowOnError>;
|
|
1975
2057
|
/**
|
|
1976
|
-
*
|
|
2058
|
+
* Archive pipeline
|
|
1977
2059
|
*
|
|
1978
|
-
*
|
|
2060
|
+
* Archive a pipeline selected from pipelines.list when records no longer depend on it. Check current records and stage usage first; resolve references reported by validation before retrying. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is "true" (no further transition) or "false" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string "null" meaning unrestricted; praxis_required is a JSON-encoded array string of property names ("[]" means none) that must be non-empty on entry (boolean properties must be "true"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204. Example metadata: {"praxis_category":"open","praxis_terminal":"false","praxis_allowed_next":"[\"proposal\",\"lost\"]","praxis_required":"[\"budget\",\"decision_maker\"]"}.
|
|
1979
2061
|
*/
|
|
1980
|
-
export declare const
|
|
2062
|
+
export declare const crmPipelinesArchive: <ThrowOnError extends boolean = false>(options: Options<CrmPipelinesArchiveData, ThrowOnError>) => RequestResult<CrmPipelinesArchiveResponses, CrmPipelinesArchiveErrors, ThrowOnError>;
|
|
1981
2063
|
/**
|
|
1982
|
-
*
|
|
2064
|
+
* Retrieve pipeline
|
|
1983
2065
|
*
|
|
1984
|
-
*
|
|
2066
|
+
* Inspect the stage ids and metadata of a pipeline before moving a record or editing its workflow. Obtain pipelineId from pipelines.list and use the returned stages array to select a destination. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is "true" (no further transition) or "false" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string "null" meaning unrestricted; praxis_required is a JSON-encoded array string of property names ("[]" means none) that must be non-empty on entry (boolean properties must be "true"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Example metadata: {"praxis_category":"open","praxis_terminal":"false","praxis_allowed_next":"[\"proposal\",\"lost\"]","praxis_required":"[\"budget\",\"decision_maker\"]"}.
|
|
1985
2067
|
*/
|
|
1986
|
-
export declare const
|
|
2068
|
+
export declare const crmPipelinesRetrieve: <ThrowOnError extends boolean = false>(options: Options<CrmPipelinesRetrieveData, ThrowOnError>) => RequestResult<CrmPipelinesRetrieveResponses, CrmPipelinesRetrieveErrors, ThrowOnError>;
|
|
1987
2069
|
/**
|
|
1988
|
-
*
|
|
2070
|
+
* Update pipeline
|
|
1989
2071
|
*
|
|
1990
|
-
*
|
|
2072
|
+
* Change editable pipeline settings selected by pipelineId from pipelines.list. Omit settings that should remain unchanged and inspect current stages with pipelines.retrieve before modifying the workflow. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is "true" (no further transition) or "false" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string "null" meaning unrestricted; praxis_required is a JSON-encoded array string of property names ("[]" means none) that must be non-empty on entry (boolean properties must be "true"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {"praxis_category":"open","praxis_terminal":"false","praxis_allowed_next":"[\"proposal\",\"lost\"]","praxis_required":"[\"budget\",\"decision_maker\"]"}.
|
|
1991
2073
|
*/
|
|
1992
|
-
export declare const
|
|
2074
|
+
export declare const crmPipelinesUpdate: <ThrowOnError extends boolean = false>(options: Options<CrmPipelinesUpdateData, ThrowOnError>) => RequestResult<CrmPipelinesUpdateResponses, CrmPipelinesUpdateErrors, ThrowOnError>;
|
|
1993
2075
|
/**
|
|
1994
|
-
* Create
|
|
2076
|
+
* Create pipeline stage
|
|
1995
2077
|
*
|
|
1996
|
-
*
|
|
2078
|
+
* Add an ordered stage to a pipeline from pipelines.list. Provide its display label, displayOrder and metadata; save the returned stage id for record updates. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is "true" (no further transition) or "false" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string "null" meaning unrestricted; praxis_required is a JSON-encoded array string of property names ("[]" means none) that must be non-empty on entry (boolean properties must be "true"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {"praxis_category":"open","praxis_terminal":"false","praxis_allowed_next":"[\"proposal\",\"lost\"]","praxis_required":"[\"budget\",\"decision_maker\"]"}.
|
|
1997
2079
|
*/
|
|
1998
|
-
export declare const
|
|
2080
|
+
export declare const crmPipelinesStagesCreate: <ThrowOnError extends boolean = false>(options: Options<CrmPipelinesStagesCreateData, ThrowOnError>) => RequestResult<CrmPipelinesStagesCreateResponses, CrmPipelinesStagesCreateErrors, ThrowOnError>;
|
|
1999
2081
|
/**
|
|
2000
|
-
*
|
|
2082
|
+
* Archive pipeline stage
|
|
2001
2083
|
*
|
|
2002
|
-
*
|
|
2084
|
+
* Archive a stage selected from pipelines.retrieve after checking record usage. A stage that still has records cannot be archived without resolving their assignment; move those records to an allowed stage first. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is "true" (no further transition) or "false" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string "null" meaning unrestricted; praxis_required is a JSON-encoded array string of property names ("[]" means none) that must be non-empty on entry (boolean properties must be "true"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204. Example metadata: {"praxis_category":"open","praxis_terminal":"false","praxis_allowed_next":"[\"proposal\",\"lost\"]","praxis_required":"[\"budget\",\"decision_maker\"]"}.
|
|
2003
2085
|
*/
|
|
2004
|
-
export declare const
|
|
2086
|
+
export declare const crmPipelinesStagesArchive: <ThrowOnError extends boolean = false>(options: Options<CrmPipelinesStagesArchiveData, ThrowOnError>) => RequestResult<CrmPipelinesStagesArchiveResponses, CrmPipelinesStagesArchiveErrors, ThrowOnError>;
|
|
2005
2087
|
/**
|
|
2006
|
-
*
|
|
2088
|
+
* Update pipeline stage
|
|
2007
2089
|
*
|
|
2008
|
-
*
|
|
2090
|
+
* Change the label, order or metadata of a stage selected from pipelines.retrieve. Existing records must satisfy entry rules when subsequently moved; omitted settings retain their values. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is "true" (no further transition) or "false" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string "null" meaning unrestricted; praxis_required is a JSON-encoded array string of property names ("[]" means none) that must be non-empty on entry (boolean properties must be "true"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {"praxis_category":"open","praxis_terminal":"false","praxis_allowed_next":"[\"proposal\",\"lost\"]","praxis_required":"[\"budget\",\"decision_maker\"]"}.
|
|
2009
2091
|
*/
|
|
2010
|
-
export declare const
|
|
2092
|
+
export declare const crmPipelinesStagesUpdate: <ThrowOnError extends boolean = false>(options: Options<CrmPipelinesStagesUpdateData, ThrowOnError>) => RequestResult<CrmPipelinesStagesUpdateResponses, CrmPipelinesStagesUpdateErrors, ThrowOnError>;
|
|
2011
2093
|
/**
|
|
2012
|
-
*
|
|
2094
|
+
* List record associations
|
|
2013
2095
|
*
|
|
2014
|
-
*
|
|
2096
|
+
* Read records linked to a source record, including association labels and type ids. Obtain source and destination object types from schemas.list and objectId from objects.list or objects.search. Follow paging.next.after to continue reading associated records.
|
|
2015
2097
|
*/
|
|
2016
|
-
export declare const
|
|
2098
|
+
export declare const crmAssociationsList: <ThrowOnError extends boolean = false>(options: Options<CrmAssociationsListData, ThrowOnError>) => RequestResult<CrmAssociationsListResponses, CrmAssociationsListErrors, ThrowOnError>;
|
|
2017
2099
|
/**
|
|
2018
|
-
*
|
|
2100
|
+
* Remove association
|
|
2019
2101
|
*
|
|
2020
|
-
*
|
|
2102
|
+
* Remove the association between two existing records without archiving either record. Obtain the linked destination id from associations.list and confirm the source and destination object types before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.
|
|
2021
2103
|
*/
|
|
2022
|
-
export declare const
|
|
2104
|
+
export declare const crmAssociationsRemove: <ThrowOnError extends boolean = false>(options: Options<CrmAssociationsRemoveData, ThrowOnError>) => RequestResult<CrmAssociationsRemoveResponses, CrmAssociationsRemoveErrors, ThrowOnError>;
|
|
2023
2105
|
/**
|
|
2024
|
-
*
|
|
2106
|
+
* Create labelled association
|
|
2025
2107
|
*
|
|
2026
|
-
*
|
|
2108
|
+
* Associate two existing records using the requested association category and type id. Obtain record ids from objects.list or objects.search; reuse known association type ids from associations.list. Send the association-spec array as the body; use associations.createDefault when no label is needed. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
2027
2109
|
*/
|
|
2028
|
-
export declare const
|
|
2110
|
+
export declare const crmAssociationsCreate: <ThrowOnError extends boolean = false>(options: Options<CrmAssociationsCreateData, ThrowOnError>) => RequestResult<CrmAssociationsCreateResponses, CrmAssociationsCreateErrors, ThrowOnError>;
|
|
2029
2111
|
/**
|
|
2030
|
-
*
|
|
2112
|
+
* Create default association
|
|
2031
2113
|
*
|
|
2032
|
-
*
|
|
2114
|
+
* Link two existing records with the default unlabelled association. Obtain each record id from objects.list or objects.search for its type. No request body is required; use associations.create to choose explicit association labels. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
2033
2115
|
*/
|
|
2034
|
-
export declare const
|
|
2116
|
+
export declare const crmAssociationsCreateDefault: <ThrowOnError extends boolean = false>(options: Options<CrmAssociationsCreateDefaultData, ThrowOnError>) => RequestResult<CrmAssociationsCreateDefaultResponses, CrmAssociationsCreateDefaultErrors, ThrowOnError>;
|
|
2035
2117
|
/**
|
|
2036
|
-
*
|
|
2118
|
+
* List object schemas
|
|
2037
2119
|
*
|
|
2038
|
-
*
|
|
2120
|
+
* Discover available object schemas, display labels, property definitions and association definitions. Reuse the object type identifier or name in record, property and pipeline operations. archived defaults to false; the include parameters control the definition and audit details returned.
|
|
2039
2121
|
*/
|
|
2040
|
-
export declare const
|
|
2122
|
+
export declare const crmSchemasList: <ThrowOnError extends boolean = false>(options?: Options<CrmSchemasListData, ThrowOnError>) => RequestResult<CrmSchemasListResponses, CrmSchemasListErrors, ThrowOnError>;
|
|
2041
2123
|
/**
|
|
2042
|
-
*
|
|
2124
|
+
* Create object schema
|
|
2043
2125
|
*
|
|
2044
|
-
*
|
|
2126
|
+
* Define a custom CRM object type before creating its records. Provide its immutable name, singular and plural labels, primaryDisplayProperty, properties and associated object types. Save the returned object type identifier for subsequent record and property operations. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
2045
2127
|
*/
|
|
2046
|
-
export declare const
|
|
2128
|
+
export declare const crmSchemasCreate: <ThrowOnError extends boolean = false>(options: Options<CrmSchemasCreateData, ThrowOnError>) => RequestResult<CrmSchemasCreateResponses, CrmSchemasCreateErrors, ThrowOnError>;
|
|
2047
2129
|
/**
|
|
2048
|
-
*
|
|
2130
|
+
* Qualify lead
|
|
2049
2131
|
*
|
|
2050
|
-
*
|
|
2132
|
+
* Qualify a lead with explicit contact, company and optional deal choices in one operation. Unlike HubSpot, CRM exposes these decisions as a single action because qualification coordinates several related record edits rather than editing only the lead stage. Obtain leadId from objects.list for leads and qualifiedStageId from its pipeline; choose a won stage and satisfy its required properties. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
2051
2133
|
*/
|
|
2052
|
-
export declare const
|
|
2134
|
+
export declare const crmLeadsQualify: <ThrowOnError extends boolean = false>(options: Options<CrmLeadsQualifyData, ThrowOnError>) => RequestResult<CrmLeadsQualifyResponses, CrmLeadsQualifyErrors, ThrowOnError>;
|
|
2053
2135
|
/**
|
|
2054
|
-
*
|
|
2136
|
+
* Revert change set
|
|
2055
2137
|
*
|
|
2056
|
-
*
|
|
2138
|
+
* Reverse property changes made by one earlier request. Unlike HubSpot, CRM exposes change-set reversal because agents need to undo a whole recorded action rather than manually reconstructing individual values. Supply the changeSetId recorded in property history. A later conflicting value prevents reversal with HTTP 409 CONFLICT; inspect current records before resolving the conflict. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
2057
2139
|
*/
|
|
2058
|
-
export declare const
|
|
2140
|
+
export declare const crmChangesRevert: <ThrowOnError extends boolean = false>(options: Options<CrmChangesRevertData, ThrowOnError>) => RequestResult<CrmChangesRevertResponses, CrmChangesRevertErrors, ThrowOnError>;
|
|
2059
2141
|
/**
|
|
2060
|
-
*
|
|
2142
|
+
* Retrieve record layout
|
|
2061
2143
|
*
|
|
2062
|
-
*
|
|
2144
|
+
* Read the shared record-page layout for an object type from schemas.list. Unlike HubSpot, CRM exposes this presentation as an API resource so people and agents can share the same record layout instead of relying on interface-only settings. The response orders summary tiles, sidebar properties and main-column sections.
|
|
2063
2145
|
*/
|
|
2064
|
-
export declare const
|
|
2146
|
+
export declare const crmLayoutsRetrieve: <ThrowOnError extends boolean = false>(options: Options<CrmLayoutsRetrieveData, ThrowOnError>) => RequestResult<CrmLayoutsRetrieveResponses, CrmLayoutsRetrieveErrors, ThrowOnError>;
|
|
2065
2147
|
/**
|
|
2066
|
-
*
|
|
2148
|
+
* Update record layout
|
|
2067
2149
|
*
|
|
2068
|
-
*
|
|
2150
|
+
* Replace the shared record-page layout for an object type from schemas.list. Unlike HubSpot, CRM exposes this presentation as an API resource so agents can configure the same record view used by people. Send the complete layout with at most three summary tiles and property names from properties.list; omitted prior sections are removed. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.
|
|
2069
2151
|
*/
|
|
2070
|
-
export declare const
|
|
2152
|
+
export declare const crmLayoutsUpdate: <ThrowOnError extends boolean = false>(options: Options<CrmLayoutsUpdateData, ThrowOnError>) => RequestResult<CrmLayoutsUpdateResponses, CrmLayoutsUpdateErrors, ThrowOnError>;
|
|
2071
2153
|
/**
|
|
2072
|
-
* List
|
|
2154
|
+
* List projects
|
|
2073
2155
|
*
|
|
2074
|
-
*
|
|
2156
|
+
* Discover projects owned by the API key organization and obtain project_id values. Results default to active projects ordered by updateTime descending; use filter state = "deleted" to find retained deleted projects for undelete. Continue with next_page_token as page_token until the token is absent.
|
|
2075
2157
|
*/
|
|
2076
|
-
export declare const
|
|
2158
|
+
export declare const cutListProjects: <ThrowOnError extends boolean = false>(options?: Options<CutListProjectsData, ThrowOnError>) => RequestResult<CutListProjectsResponses, CutListProjectsErrors, ThrowOnError>;
|
|
2077
2159
|
/**
|
|
2078
|
-
*
|
|
2160
|
+
* Create project
|
|
2079
2161
|
*
|
|
2080
|
-
*
|
|
2162
|
+
* Create a blank editing project in the API key organization before writing a script. First obtain accessible library ids from praxis.media; bindings must include exactly one read_write library with default_upload true. Each call creates a new project and returns HTTP 201; save its id for execute, state and timeline calls. All editing positions use seconds.
|
|
2081
2163
|
*/
|
|
2082
|
-
export declare const
|
|
2164
|
+
export declare const cutCreateProject: <ThrowOnError extends boolean = false>(options: Options<CutCreateProjectData, ThrowOnError>) => RequestResult<CutCreateProjectResponses, CutCreateProjectErrors, ThrowOnError>;
|
|
2083
2165
|
/**
|
|
2084
|
-
*
|
|
2166
|
+
* Delete project
|
|
2085
2167
|
*
|
|
2086
|
-
*
|
|
2168
|
+
* Soft-delete a project selected from projects.list. The project is retained for seven days until purge_time and can be restored with undelete before that deadline. Deleted projects cannot be edited; list with filter state = "deleted" to locate retained projects.
|
|
2087
2169
|
*/
|
|
2088
|
-
export declare const
|
|
2170
|
+
export declare const cutDeleteProject: <ThrowOnError extends boolean = false>(options: Options<CutDeleteProjectData, ThrowOnError>) => RequestResult<CutDeleteProjectResponses, CutDeleteProjectErrors, ThrowOnError>;
|
|
2089
2171
|
/**
|
|
2090
|
-
*
|
|
2172
|
+
* Retrieve project
|
|
2091
2173
|
*
|
|
2092
|
-
*
|
|
2174
|
+
* Inspect project metadata, settings and library bindings before editing. Copy id from projects.create or list; expand=timeline,exports,versions includes selected related resources. The expanded timeline uses seconds and the returned revision can guard a later execute call with expected_revision.
|
|
2093
2175
|
*/
|
|
2094
|
-
export declare const
|
|
2176
|
+
export declare const cutRetrieveProject: <ThrowOnError extends boolean = false>(options: Options<CutRetrieveProjectData, ThrowOnError>) => RequestResult<CutRetrieveProjectResponses, CutRetrieveProjectErrors, ThrowOnError>;
|
|
2095
2177
|
/**
|
|
2096
|
-
*
|
|
2178
|
+
* Update project metadata
|
|
2097
2179
|
*
|
|
2098
|
-
*
|
|
2180
|
+
* Change the project display name or replace its labels by naming those fields in update_mask. Use execute for clip or track edits. Each successful update commits a new revision; labels are replaced as a whole when selected, so read and merge existing labels before overwriting them.
|
|
2099
2181
|
*/
|
|
2100
|
-
export declare const
|
|
2182
|
+
export declare const cutUpdateProject: <ThrowOnError extends boolean = false>(options: Options<CutUpdateProjectData, ThrowOnError>) => RequestResult<CutUpdateProjectResponses, CutUpdateProjectErrors, ThrowOnError>;
|
|
2101
2183
|
/**
|
|
2102
|
-
*
|
|
2184
|
+
* Restore deleted project
|
|
2103
2185
|
*
|
|
2104
|
-
*
|
|
2186
|
+
* Return a retained deleted project to active state before its purge_time. Obtain project_id from projects.list filtered to deleted projects. This restores the project, not an older timeline revision; use versions.restore when reverting editing content.
|
|
2105
2187
|
*/
|
|
2106
|
-
export declare const
|
|
2188
|
+
export declare const cutUndeleteProject: <ThrowOnError extends boolean = false>(options: Options<CutUndeleteProjectData, ThrowOnError>) => RequestResult<CutUndeleteProjectResponses, CutUndeleteProjectErrors, ThrowOnError>;
|
|
2107
2189
|
/**
|
|
2108
|
-
*
|
|
2190
|
+
* Execute editing script
|
|
2191
|
+
*
|
|
2192
|
+
* Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`
|
|
2193
|
+
*
|
|
2194
|
+
* <!-- cut-reference:start -->
|
|
2195
|
+
* ### Script function, field and error reference
|
|
2196
|
+
*
|
|
2197
|
+
* Every script function, clip field and error code has its own section, read one at a time:
|
|
2198
|
+
*
|
|
2199
|
+
* ```
|
|
2200
|
+
* codemode.describe("praxis.cut.script.<Name>") // one function: signature, arguments, return, errors, example
|
|
2201
|
+
* codemode.describe("praxis.cut.fields.<name>") // one field: type, unit, range, default, where writable
|
|
2202
|
+
* codemode.describe("praxis.cut.errors.<CODE>") // one code: meaning, causes, fix
|
|
2203
|
+
* codemode.describe("praxis.cut.script") // names, one page at a time
|
|
2204
|
+
* ```
|
|
2205
|
+
*
|
|
2206
|
+
* Published at https://docs.deepraxis.com/docs/developers/cut/script-reference with one anchor per entry. Names below omit the `praxis.cut.<kind>.` prefix.
|
|
2207
|
+
*
|
|
2208
|
+
* #### Script functions (script)
|
|
2209
|
+
*
|
|
2210
|
+
* - `GetTimeline` — Duration, tracks, joins; clips are under `items`.
|
|
2211
|
+
* - `GetItem` — One clip's compact view, by id.
|
|
2212
|
+
* - `FindItems` — Visit every clip with its track; collect results.
|
|
2213
|
+
* - `GetMedia` — Media metadata; `duration` is seconds.
|
|
2214
|
+
* - `GetTranscript` — Transcript words in source microseconds.
|
|
2215
|
+
* - `GetAnalysis` — Silence, filler, scene or beat segments.
|
|
2216
|
+
* - `ListTransitions` — Join transition kinds and parameters.
|
|
2217
|
+
* - `ListEffects` — Visual-effect catalog and parameters.
|
|
2218
|
+
* - `ListAnimations` — Animation presets by phase and target.
|
|
2219
|
+
* - `ListFonts` — Font families, weights and scripts.
|
|
2220
|
+
* - `ListTextStyles` — Text style presets for `style.preset`.
|
|
2221
|
+
* - `ListTextTemplates` — Multi-layer templates and their slots.
|
|
2222
|
+
* - `Insert` — Add a clip; a track never overlaps itself.
|
|
2223
|
+
* - `Append` — Add a clip at the end of a track.
|
|
2224
|
+
* - `Update` — Change named fields; the rest stay.
|
|
2225
|
+
* - `SetSpeed` — Change rate, keeping source or duration.
|
|
2226
|
+
* - `Delete` — Remove a clip. There is no `Remove`.
|
|
2227
|
+
* - `Join` — Overlap clips; followers shift, track shortens.
|
|
2228
|
+
* - `UpdateJoin` — Change a join's length or effect.
|
|
2229
|
+
* - `DeleteJoin` — Remove a join; restore the butt cut.
|
|
2230
|
+
* - `Split` — Cut a clip in two at a time.
|
|
2231
|
+
* - `Trim` — Move one clip edge by seconds.
|
|
2232
|
+
* - `Move` — Set a clip's start or track.
|
|
2233
|
+
* - `RippleDeleteRange` — Cut a time range and close the gap.
|
|
2234
|
+
* - `AddTrack` — Add a video, audio or caption track.
|
|
2235
|
+
* - `UpdateTrack` — Change a track's name, lock, gain or role.
|
|
2236
|
+
* - `DeleteTrack` — Remove a track and its clips.
|
|
2237
|
+
* - `SetSettings` — Change canvas, frame rate or background.
|
|
2238
|
+
* - `AddCaptionsFromTranscript` — Captions from a clip's kept words.
|
|
2239
|
+
* - `InsertTemplate` — Insert a template and fill its slots.
|
|
2240
|
+
* - `AlignCaptions` — Rebuild captions from text punctuation.
|
|
2241
|
+
* - `ImportCaptions` — Import SRT or WebVTT onto captions.
|
|
2242
|
+
* - `ExportCaptions` — Export captions as SRT or WebVTT.
|
|
2243
|
+
* - `SetMarker` — Label a timeline position.
|
|
2244
|
+
* - `Print` — Append values to the result's `prints`.
|
|
2245
|
+
* - `Preview` — Up to 8 frames as inline PNG data URLs.
|
|
2246
|
+
*
|
|
2247
|
+
* #### Fields (fields)
|
|
2248
|
+
*
|
|
2249
|
+
* - `type` — Clip kind; decides which fields apply.
|
|
2250
|
+
* - `start` — Clip start in seconds; snaps to frames.
|
|
2251
|
+
* - `length` — Duration; video and audio may omit it or write "auto".
|
|
2252
|
+
* - `media` — Source `{ libraryId, assetId }`.
|
|
2253
|
+
* - `sourceIn` — First source second kept; default 0.
|
|
2254
|
+
* - `sourceOut` — Exclusive source end; read-only.
|
|
2255
|
+
* - `text` — Text of a text or caption clip.
|
|
2256
|
+
* - `color` — Solid colour of a color clip.
|
|
2257
|
+
* - `shape` — Shape clip kind: `rect` or `ellipse`.
|
|
2258
|
+
* - `width` — Shape width, a fraction of canvas width.
|
|
2259
|
+
* - `height` — Shape height, a fraction of canvas height.
|
|
2260
|
+
* - `radius` — Rect corner rounding, in 1080-height px.
|
|
2261
|
+
* - `fill` — Shape or text paint: colour or gradient.
|
|
2262
|
+
* - `stroke` — Shape outline: colour and width.
|
|
2263
|
+
* - `transform` — Position, scale, rotation, opacity, crop, blur.
|
|
2264
|
+
* - `fit` — contain, cover, fill or none.
|
|
2265
|
+
* - `blend` — Layer blend mode; null clears.
|
|
2266
|
+
* - `style` — Text styling: font, fill, strokes, glow, position.
|
|
2267
|
+
* - `style.position` — top, middle or bottom; omit it, never null.
|
|
2268
|
+
* - `playback` — Rate, direction, audio policy, or freeze.
|
|
2269
|
+
* - `volumeDb` — Audio level in dB; 0 is source level.
|
|
2270
|
+
* - `gain` — Keyframed audio level in dB.
|
|
2271
|
+
* - `fadeIn` — Fade-in seconds at the clip's start.
|
|
2272
|
+
* - `fadeOut` — Fade-out seconds at the clip's end.
|
|
2273
|
+
* - `duck` — Lower this clip while another track plays.
|
|
2274
|
+
* - `animate` — Transform keyframes; `at` is clip-relative seconds.
|
|
2275
|
+
* - `reveal` — Per-character, word or line reveal timing.
|
|
2276
|
+
* - `animation` — Preset slots `{ in, out, loop }`; null clears.
|
|
2277
|
+
* - `effects` — Effect stack, at most 8; null clears.
|
|
2278
|
+
* - `transitionIn` — Entrance effect: kind plus seconds.
|
|
2279
|
+
* - `transitionOut` — Exit effect: kind plus seconds.
|
|
2280
|
+
* - `mask` — Shape, path or track matte.
|
|
2281
|
+
* - `words` — Caption words with clip-local times.
|
|
2282
|
+
*
|
|
2283
|
+
* #### Error codes (errors)
|
|
2284
|
+
*
|
|
2285
|
+
* - `JOIN_CONFLICT` — A join is invalid or blocks this edit.
|
|
2286
|
+
* - `INVALID_TRANSITION` — Bad transition kind, parameter or length.
|
|
2287
|
+
* - `INVALID_STYLE` — A style value is out of range.
|
|
2288
|
+
* - `INVALID_MASK` — A mask definition is malformed.
|
|
2289
|
+
* - `MASK_IN_USE` — The edit would break a live mask.
|
|
2290
|
+
* - `TOO_MANY_MASKS` — At most 16 masks per project.
|
|
2291
|
+
* - `RATE_OUT_OF_RANGE` — A rate is outside 0.25-4.
|
|
2292
|
+
* - `UNSUPPORTED_PLAYBACK` — Reverse without an explicit mute.
|
|
2293
|
+
* - `INVALID_PLAYBACK` — A playback object is partial or malformed.
|
|
2294
|
+
* - `UNKNOWN_FONT` — The family is not in `ListFonts()`.
|
|
2295
|
+
* - `UNKNOWN_FIELD` — The field name is not accepted here.
|
|
2296
|
+
* - `UNKNOWN_TEXT_STYLE` — `style.preset` is not in the catalog.
|
|
2297
|
+
* - `TEXT_STYLE_TARGET_MISMATCH` — Preset on the wrong clip type.
|
|
2298
|
+
* - `CAPTION_ALIGN_LOW_CONFIDENCE` — Alignment confidence too low; nothing changed.
|
|
2299
|
+
* - `OVERLAP` — Two clips on one track would share time.
|
|
2300
|
+
* - `OUT_OF_SOURCE` — The clip would read past its source.
|
|
2301
|
+
* - `LOCKED_TRACK` — The edit targets a locked track.
|
|
2302
|
+
* - `UNBOUND_LIBRARY` — The library is not bound to the project.
|
|
2303
|
+
* - `TRACK_KIND_MISMATCH` — The clip type does not fit the track.
|
|
2304
|
+
* - `NOT_FOUND` — The named id is not in this project.
|
|
2305
|
+
* - `TOO_SHORT` — The result would be under one frame.
|
|
2306
|
+
* - `INVALID_DUCK` — Bad `duck` level or a missing track.
|
|
2307
|
+
* - `UNKNOWN_ANIMATION` — The preset is not in `ListAnimations()`.
|
|
2308
|
+
* - `INVALID_ANIMATION_PARAM` — Bad slot, parameter or keyframe limit.
|
|
2309
|
+
* - `ANIMATION_TOO_LONG` — In plus out exceed the clip length.
|
|
2310
|
+
* - `ANIMATION_TARGET_MISMATCH` — The preset does not match the clip type.
|
|
2311
|
+
* - `ANIMATION_PHASE_MISMATCH` — The preset is in the wrong slot.
|
|
2312
|
+
* - `UNKNOWN_EFFECT` — The effect is not in `ListEffects()`.
|
|
2313
|
+
* - `INVALID_EFFECT_PARAM` — Bad effect parameter or keyframe.
|
|
2314
|
+
* - `TOO_MANY_EFFECTS` — More than 8 effects on one clip.
|
|
2315
|
+
* - `PROJECT_NOT_FOUND` — No visible project has this id.
|
|
2316
|
+
* - `EXPORT_NOT_FOUND` — No such export in this project.
|
|
2317
|
+
* - `DRAFT_RENDER_NOT_FOUND` — No such draft render.
|
|
2318
|
+
* - `VERSION_NOT_FOUND` — No saved version has this revision.
|
|
2319
|
+
* - `LIBRARY_NOT_FOUND` — The library is missing or invisible.
|
|
2320
|
+
* - `BINDING_INVALID` — The binding request is malformed.
|
|
2321
|
+
* - `BINDING_IN_USE` — Clips still use this library's assets.
|
|
2322
|
+
* - `NOTHING_TO_UNDO` — No earlier revision to return to.
|
|
2323
|
+
* - `NOTHING_TO_REDO` — No undone revision is waiting.
|
|
2324
|
+
* - `UNDO_CONFLICT` — The revision to undo is no longer head.
|
|
2325
|
+
* - `REVISION_CONFLICT` — The project moved; your revision is stale.
|
|
2326
|
+
* - `CUT_BUSY` — The project is busy; retry.
|
|
2327
|
+
* - `INVALID_CAPTION_FILE` — The subtitle file is malformed or too big.
|
|
2328
|
+
* - `SCRIPT_ERROR` — The script threw or did not parse.
|
|
2329
|
+
* - `SCRIPT_LIMIT` — An execute budget was exceeded.
|
|
2330
|
+
* - `OPS_REJECTED` — An op failed; the whole edit rolled back.
|
|
2331
|
+
* - `EDIT_EXPIRED` — The saved edit id is over ten minutes old.
|
|
2332
|
+
* - `MEDIA_NOT_FOUND` — The asset id is not in that library.
|
|
2333
|
+
* - `MEDIA_OFFLINE` — The asset cannot be fetched right now.
|
|
2334
|
+
* - `MEDIA_UNAVAILABLE` — The asset is not usable for rendering.
|
|
2335
|
+
* - `MEDIA_IMPORT_FAILED` — Importing media failed.
|
|
2336
|
+
* - `FRAME_OUT_OF_RANGE` — The preview time is outside the project.
|
|
2337
|
+
* - `PROJECT_TOO_LARGE` — The project exceeds the size limit.
|
|
2338
|
+
* - `RESPONSE_TOO_LARGE` — The response would exceed its budget.
|
|
2339
|
+
* - `EXPORT_FAILED` — The render failed; read `error.cause`.
|
|
2340
|
+
* - `INVALID_PARAMS` — The request is malformed.
|
|
2341
|
+
* - `PERMISSION_DENIED` — This credential may not do that here.
|
|
2342
|
+
* - `NOT_IMPLEMENTED` — Not available on this platform yet.
|
|
2343
|
+
* - `INTERNAL` — Unexpected failure; retry with the request id.
|
|
2344
|
+
* <!-- cut-reference:end -->
|
|
2109
2345
|
*
|
|
2110
|
-
* Create an asynchronous batch for tagging, untagging, replacing context, moving or deleting assets. Select ids or an expression; selection is frozen at creation. Poll the returned job id for completion and per-item failures.
|
|
2111
2346
|
*/
|
|
2112
|
-
export declare const
|
|
2347
|
+
export declare const cutExecute: <ThrowOnError extends boolean = false>(options: Options<CutExecuteData, ThrowOnError>) => RequestResult<CutExecuteResponses, CutExecuteErrors, ThrowOnError>;
|
|
2113
2348
|
/**
|
|
2114
|
-
*
|
|
2349
|
+
* Read editing state
|
|
2115
2350
|
*
|
|
2116
|
-
* Read
|
|
2351
|
+
* Read lightweight project context before composing an execute script. Returns current revision, rendering settings, track counts, library bindings and offline media count without individual clips. For complete clip documents or a selected time range, read timeline instead.
|
|
2117
2352
|
*/
|
|
2118
|
-
export declare const
|
|
2353
|
+
export declare const cutRetrieveState: <ThrowOnError extends boolean = false>(options: Options<CutRetrieveStateData, ThrowOnError>) => RequestResult<CutRetrieveStateResponses, CutRetrieveStateErrors, ThrowOnError>;
|
|
2119
2354
|
/**
|
|
2120
|
-
*
|
|
2355
|
+
* Read project timeline
|
|
2121
2356
|
*
|
|
2122
|
-
*
|
|
2357
|
+
* Inspect clips and markers in a selected project range before editing. view=full returns structured tracks with all timeline positions in seconds; view=compact returns compact text for script context. from and to are seconds and tracks limits the selection to comma-separated track ids from state. Concurrent changes while preparing a full timeline return 409; retrieve the latest state and try the read again.
|
|
2123
2358
|
*/
|
|
2124
|
-
export declare const
|
|
2359
|
+
export declare const cutRetrieveTimeline: <ThrowOnError extends boolean = false>(options: Options<CutRetrieveTimelineData, ThrowOnError>) => RequestResult<CutRetrieveTimelineResponses, CutRetrieveTimelineErrors, ThrowOnError>;
|
|
2125
2360
|
/**
|
|
2126
|
-
*
|
|
2361
|
+
* Render preview frames
|
|
2127
2362
|
*
|
|
2128
|
-
*
|
|
2363
|
+
* Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.
|
|
2129
2364
|
*/
|
|
2130
|
-
export declare const
|
|
2365
|
+
export declare const cutListFrames: <ThrowOnError extends boolean = false>(options: Options<CutListFramesData, ThrowOnError>) => RequestResult<CutListFramesResponses, CutListFramesErrors, ThrowOnError>;
|
|
2131
2366
|
/**
|
|
2132
|
-
*
|
|
2367
|
+
* Analyze project media or measure the project mix
|
|
2133
2368
|
*
|
|
2134
|
-
*
|
|
2369
|
+
* Request silence, filler-word, scene or beat analysis for selected bound assets before editing, or measure the mix the timeline itself renders with kind mix. That kind is a render job, not a read: it answers pending with retry_after_sec and an id. Poll by calling this same method again with body { kinds: ["mix"], id } (there is no separate retrieve method); that call reads the measurement and renders nothing. The answer only exists once the audio has been rendered and measured. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed. kind mix is separate: it reports the project mix loudness, the loudness of each role and where music masks speech, so an editor can fix the mix rather than guess at it.
|
|
2135
2370
|
*/
|
|
2136
|
-
export declare const
|
|
2371
|
+
export declare const cutCreateAnalysis: <ThrowOnError extends boolean = false>(options: Options<CutCreateAnalysisData, ThrowOnError>) => RequestResult<CutCreateAnalysisResponses, CutCreateAnalysisErrors, ThrowOnError>;
|
|
2137
2372
|
/**
|
|
2138
|
-
* List
|
|
2373
|
+
* List library bindings
|
|
2139
2374
|
*
|
|
2140
|
-
*
|
|
2375
|
+
* Discover the named media libraries available to this project before selecting source assets or an import/export destination. read bindings supply source assets; read_write bindings also accept uploads. Exactly one writable binding supplies the default upload destination.
|
|
2141
2376
|
*/
|
|
2142
|
-
export declare const
|
|
2377
|
+
export declare const cutListBindings: <ThrowOnError extends boolean = false>(options: Options<CutListBindingsData, ThrowOnError>) => RequestResult<CutListBindingsResponses, CutListBindingsErrors, ThrowOnError>;
|
|
2143
2378
|
/**
|
|
2144
|
-
*
|
|
2379
|
+
* Bind media library
|
|
2145
2380
|
*
|
|
2146
|
-
*
|
|
2381
|
+
* Attach an accessible media library to an existing project under a unique name. Obtain library_id from praxis.media and choose read for source-only access or read_write for imports and exports. The project must retain exactly one read_write binding with default_upload true after the change.
|
|
2147
2382
|
*/
|
|
2148
|
-
export declare const
|
|
2383
|
+
export declare const cutCreateBinding: <ThrowOnError extends boolean = false>(options: Options<CutCreateBindingData, ThrowOnError>) => RequestResult<CutCreateBindingResponses, CutCreateBindingErrors, ThrowOnError>;
|
|
2149
2384
|
/**
|
|
2150
|
-
*
|
|
2385
|
+
* Remove library binding
|
|
2151
2386
|
*
|
|
2152
|
-
*
|
|
2387
|
+
* Detach a library alias obtained from bindings.list after removing all timeline clips that reference its library. BINDING_IN_USE returns 409 while references remain; inspect timeline and edit those clips first. Removal must preserve the one writable default upload binding.
|
|
2153
2388
|
*/
|
|
2154
|
-
export declare const
|
|
2389
|
+
export declare const cutDeleteBinding: <ThrowOnError extends boolean = false>(options: Options<CutDeleteBindingData, ThrowOnError>) => RequestResult<CutDeleteBindingResponses, CutDeleteBindingErrors, ThrowOnError>;
|
|
2155
2390
|
/**
|
|
2156
|
-
*
|
|
2391
|
+
* Import project media
|
|
2157
2392
|
*
|
|
2158
|
-
*
|
|
2393
|
+
* Import a URL, data URI or existing file into a writable project media library. Select binding from bindings.list or omit it to use default_upload. Save library_id and asset_id from the result and use them as libraryId and assetId inside execute script media references; overwrites follow the source asset latest version.
|
|
2159
2394
|
*/
|
|
2160
|
-
export declare const
|
|
2395
|
+
export declare const cutImportMedia: <ThrowOnError extends boolean = false>(options: Options<CutImportMediaData, ThrowOnError>) => RequestResult<CutImportMediaResponses, CutImportMediaErrors, ThrowOnError>;
|
|
2161
2396
|
/**
|
|
2162
|
-
*
|
|
2397
|
+
* List project exports
|
|
2163
2398
|
*
|
|
2164
|
-
*
|
|
2399
|
+
* Find export jobs associated with this project before polling or canceling a render. Copy an export id into praxis.cut.exports.retrieve or cancel. Continue with next_page_token as page_token when present; queued or in-progress jobs have not produced a final media asset.
|
|
2165
2400
|
*/
|
|
2166
|
-
export declare const
|
|
2401
|
+
export declare const cutListExports: <ThrowOnError extends boolean = false>(options: Options<CutListExportsData, ThrowOnError>) => RequestResult<CutListExportsResponses, CutListExportsErrors, ThrowOnError>;
|
|
2167
2402
|
/**
|
|
2168
|
-
*
|
|
2403
|
+
* Create video export
|
|
2169
2404
|
*
|
|
2170
|
-
*
|
|
2405
|
+
* Start an asynchronous video export from the project into a writable bound media library. Choose binding from bindings.list or omit it for default_upload, and optionally select revision and output settings. HTTP 202 only accepts the job; poll praxis.cut.exports.retrieve using the returned id until status is done, failed or canceled. On done, asset identifies the video written back to praxis.media. Each call starts a job, so retrieve a known job before retrying a submission.
|
|
2171
2406
|
*/
|
|
2172
|
-
export declare const
|
|
2407
|
+
export declare const cutCreateExport: <ThrowOnError extends boolean = false>(options: Options<CutCreateExportData, ThrowOnError>) => RequestResult<CutCreateExportResponses, CutCreateExportErrors, ThrowOnError>;
|
|
2408
|
+
/**
|
|
2409
|
+
* Create draft range render
|
|
2410
|
+
*
|
|
2411
|
+
* Render one interval of the timeline so you can hear or look at how that passage comes out, without publishing anything to a media library. Choose kind audio for the mixed soundtrack as an .m4a file, or kind video for a draft-quality .mp4 with picture and sound. from and to are seconds on the project clock and must satisfy 0 <= from < to, to <= the timeline duration (an end up to 0.05 s past it, a rounded duration, is read as the end), and to - from <= 120; a longer passage is requested in several 分段请求 ranges and joined by the caller. The result is a temporary file (purpose user_data) that expires 24 hours after it is stored and is never imported into a library, so it is not a deliverable and carries no cut-export tag. HTTP 202 only accepts the job; poll praxis.cut.renders.retrieve using the returned id until status is done or failed, then read url while it lasts. A draft also bills like a draft export, by rendered seconds. Each project runs at most 2 draft renders at a time, a budget separate from its exports; a third answers HTTP 429 CUT_BUSY and the same call succeeds once one finishes.
|
|
2412
|
+
*/
|
|
2413
|
+
export declare const cutCreateRender: <ThrowOnError extends boolean = false>(options: Options<CutCreateRenderData, ThrowOnError>) => RequestResult<CutCreateRenderResponses, CutCreateRenderErrors, ThrowOnError>;
|
|
2414
|
+
/**
|
|
2415
|
+
* Retrieve draft range render
|
|
2416
|
+
*
|
|
2417
|
+
* Poll a draft render id returned by projects.renders.create to see whether the interval is ready, then read url while it lasts. queued and rendering are in progress; done provides file_id and a short-lived url for the rendered .m4a or .mp4; failed provides error. Only done yields a url, and the file behind it disappears 24 hours after it was stored, so retrieve again when the link has expired.
|
|
2418
|
+
*/
|
|
2419
|
+
export declare const cutRetrieveRender: <ThrowOnError extends boolean = false>(options: Options<CutRetrieveRenderData, ThrowOnError>) => RequestResult<CutRetrieveRenderResponses, CutRetrieveRenderErrors, ThrowOnError>;
|
|
2420
|
+
/**
|
|
2421
|
+
* Retrieve video export
|
|
2422
|
+
*
|
|
2423
|
+
* Poll an export id returned by projects.exports.create or list to observe render progress. queued, fetching, rendering, stitching and saving are in progress; done provides asset in the target library, failed provides error, and canceled means the job stopped. Only done confirms a usable output asset.
|
|
2424
|
+
*/
|
|
2425
|
+
export declare const cutRetrieveExport: <ThrowOnError extends boolean = false>(options: Options<CutRetrieveExportData, ThrowOnError>) => RequestResult<CutRetrieveExportResponses, CutRetrieveExportErrors, ThrowOnError>;
|
|
2426
|
+
/**
|
|
2427
|
+
* Cancel video export
|
|
2428
|
+
*
|
|
2429
|
+
* Request cancellation of an export obtained from projects.exports.create or list when its output is no longer needed. Read the returned job status and retrieve it to confirm the terminal outcome; do not interpret a cancellation request as successful rendering.
|
|
2430
|
+
*/
|
|
2431
|
+
export declare const cutCancelExport: <ThrowOnError extends boolean = false>(options: Options<CutCancelExportData, ThrowOnError>) => RequestResult<CutCancelExportResponses, CutCancelExportErrors, ThrowOnError>;
|
|
2432
|
+
/**
|
|
2433
|
+
* List saved versions
|
|
2434
|
+
*
|
|
2435
|
+
* Find saved timeline snapshots for this project and obtain version_id values for restore. A saved version records its original revision; restoring it creates a new current revision rather than rewinding the revision counter. Continue with next_page_token as page_token until absent.
|
|
2436
|
+
*/
|
|
2437
|
+
export declare const cutListVersions: <ThrowOnError extends boolean = false>(options: Options<CutListVersionsData, ThrowOnError>) => RequestResult<CutListVersionsResponses, CutListVersionsErrors, ThrowOnError>;
|
|
2438
|
+
/**
|
|
2439
|
+
* Save project version
|
|
2440
|
+
*
|
|
2441
|
+
* Save the current project timeline as a named recovery point before a substantial edit. Supply an optional label or send an empty object; keep the returned version id for versions.restore. Saving a version does not publish a rendered asset; use projects.exports.create for video output.
|
|
2442
|
+
*/
|
|
2443
|
+
export declare const cutCreateVersion: <ThrowOnError extends boolean = false>(options: Options<CutCreateVersionData, ThrowOnError>) => RequestResult<CutCreateVersionResponses, CutCreateVersionErrors, ThrowOnError>;
|
|
2444
|
+
/**
|
|
2445
|
+
* Restore saved version
|
|
2446
|
+
*
|
|
2447
|
+
* Replace current editing content with a saved project snapshot selected from projects.versions.list. The restore commits a new transaction and revision while preserving the saved version for future use. Inspect the returned summary and timeline before further editing; a response revision conflict can follow a committed restore, so retrieve current state before retrying.
|
|
2448
|
+
*/
|
|
2449
|
+
export declare const cutRestoreVersion: <ThrowOnError extends boolean = false>(options: Options<CutRestoreVersionData, ThrowOnError>) => RequestResult<CutRestoreVersionResponses, CutRestoreVersionErrors, ThrowOnError>;
|
|
2450
|
+
/**
|
|
2451
|
+
* List databases
|
|
2452
|
+
*
|
|
2453
|
+
* Find databases owned by your tenant and obtain their ids for schema or row operations. Excludes deleting by default. status=active or status=deleting selects that state; invalid values return 400 INVALID_PARAMS.
|
|
2454
|
+
*/
|
|
2455
|
+
export declare const databaseListDatabases: <ThrowOnError extends boolean = false>(options?: Options<DatabaseListDatabasesData, ThrowOnError>) => RequestResult<DatabaseListDatabasesResponses, DatabaseListDatabasesErrors, ThrowOnError>;
|
|
2456
|
+
/**
|
|
2457
|
+
* Create database
|
|
2458
|
+
*
|
|
2459
|
+
* Creates an empty database for the caller and returns it with status active (HTTP 201); add tables next with praxis.database.databases.tables.create. name is required and is 1–64 visible characters after trimming. labels are optional string tags (at most 64; each key starts with a lowercase letter and uses up to 63 characters of a-z 0-9 _ -; each value is up to 63 characters of a-z 0-9 _ -) that databaseListDatabases can filter on. If initialization fails the call returns 503 CAPACITY and the half-created database is left with status failed; retry by calling create again, which makes a new database. Unlike Supabase, this creates a SQLite-backed database without a PostgreSQL connection or SQL execution endpoint. Use a Praxis credential; access is scoped to its tenant, not to Supabase Auth users or RLS policies.
|
|
2460
|
+
*/
|
|
2461
|
+
export declare const databaseCreateDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseCreateDatabaseData, ThrowOnError>) => RequestResult<DatabaseCreateDatabaseResponses, DatabaseCreateDatabaseErrors, ThrowOnError>;
|
|
2462
|
+
/**
|
|
2463
|
+
* Delete database
|
|
2464
|
+
*
|
|
2465
|
+
* Soft-delete a database when it should stop accepting schema and row operations. Idempotently enters deleting with a seven-day purge_at. GET remains available; child operations return 409 until restored.
|
|
2466
|
+
*/
|
|
2467
|
+
export declare const databaseDeleteDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseDeleteDatabaseData, ThrowOnError>) => RequestResult<DatabaseDeleteDatabaseResponses, DatabaseDeleteDatabaseErrors, ThrowOnError>;
|
|
2468
|
+
/**
|
|
2469
|
+
* Get database
|
|
2470
|
+
*
|
|
2471
|
+
* Returns one database by id, including a database in the deleting state (purge_at then shows when it will be permanently removed). Call it before table or row operations to confirm status is active: schema and row calls on a deleting database return 409 DATABASE_INVALID_STATE. size_bytes is refreshed from live storage at most once every five seconds. A purged or unknown id returns 404 DATABASE_NOT_FOUND.
|
|
2472
|
+
*/
|
|
2473
|
+
export declare const databaseGetDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseGetDatabaseData, ThrowOnError>) => RequestResult<DatabaseGetDatabaseResponses, DatabaseGetDatabaseErrors, ThrowOnError>;
|
|
2474
|
+
/**
|
|
2475
|
+
* Update database
|
|
2476
|
+
*
|
|
2477
|
+
* Renames an active database and/or replaces its labels; send only the keys you want to change. labels is replaced as a whole, not merged, so include every label you want to keep. A body without name or labels, or with values equal to the current ones, changes nothing and leaves updated_at as is. A database in the deleting state returns 409 DATABASE_INVALID_STATE; restore it first with databaseRestoreDatabase.
|
|
2478
|
+
*/
|
|
2479
|
+
export declare const databaseUpdateDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseUpdateDatabaseData, ThrowOnError>) => RequestResult<DatabaseUpdateDatabaseResponses, DatabaseUpdateDatabaseErrors, ThrowOnError>;
|
|
2480
|
+
/**
|
|
2481
|
+
* Restore database
|
|
2482
|
+
*
|
|
2483
|
+
* Recover a soft-deleted database within its seven-day recovery window. Restore before purge_at. An empty body is accepted. Active databases return 409; purged databases return 404.
|
|
2484
|
+
*/
|
|
2485
|
+
export declare const databaseRestoreDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabaseRestoreDatabaseData, ThrowOnError>) => RequestResult<DatabaseRestoreDatabaseResponses, DatabaseRestoreDatabaseErrors, ThrowOnError>;
|
|
2486
|
+
/**
|
|
2487
|
+
* Permanently purge database
|
|
2488
|
+
*
|
|
2489
|
+
* Immediately and irreversibly purges a deleting database. Active databases return 409; absent or already purged databases return 404.
|
|
2490
|
+
*/
|
|
2491
|
+
export declare const databasePurgeDatabase: <ThrowOnError extends boolean = false>(options: Options<DatabasePurgeDatabaseData, ThrowOnError>) => RequestResult<DatabasePurgeDatabaseResponses, DatabasePurgeDatabaseErrors, ThrowOnError>;
|
|
2492
|
+
/**
|
|
2493
|
+
* List tables
|
|
2494
|
+
*
|
|
2495
|
+
* Lists every table of an active database with its field definitions. A database holds at most 50 tables, so the single page contains all of them and next_cursor is always null. Use databaseGetTable instead when you also need row_count for one table.
|
|
2496
|
+
*/
|
|
2497
|
+
export declare const databaseListTables: <ThrowOnError extends boolean = false>(options: Options<DatabaseListTablesData, ThrowOnError>) => RequestResult<DatabaseListTablesResponses, DatabaseListTablesErrors, ThrowOnError>;
|
|
2498
|
+
/**
|
|
2499
|
+
* Create table
|
|
2500
|
+
*
|
|
2501
|
+
* Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {"name":"notes","type":"string","indexed":false}. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.
|
|
2502
|
+
*/
|
|
2503
|
+
export declare const databaseCreateTable: <ThrowOnError extends boolean = false>(options: Options<DatabaseCreateTableData, ThrowOnError>) => RequestResult<DatabaseCreateTableResponses, DatabaseCreateTableErrors, ThrowOnError>;
|
|
2504
|
+
/**
|
|
2505
|
+
* Delete table
|
|
2506
|
+
*
|
|
2507
|
+
* Permanently drops a table with all of its rows; the deletion is immediate and has no recovery window or undo. Refused with 409 REFERENCE_RESTRICT while a link field of another table points at this table, so delete or change those fields first. Returns {deleted: true}. A table name can be reused afterwards.
|
|
2508
|
+
*/
|
|
2509
|
+
export declare const databaseDeleteTable: <ThrowOnError extends boolean = false>(options: Options<DatabaseDeleteTableData, ThrowOnError>) => RequestResult<DatabaseDeleteTableResponses, DatabaseDeleteTableErrors, ThrowOnError>;
|
|
2510
|
+
/**
|
|
2511
|
+
* Get table
|
|
2512
|
+
*
|
|
2513
|
+
* Returns one table by id or name with its field definitions, schema_revision and row_count. row_count is only returned by this operation, not by list or create. Use field ids from this response for stable references because field names can be renamed; an unknown table returns 404 TABLE_NOT_FOUND.
|
|
2514
|
+
*/
|
|
2515
|
+
export declare const databaseGetTable: <ThrowOnError extends boolean = false>(options: Options<DatabaseGetTableData, ThrowOnError>) => RequestResult<DatabaseGetTableResponses, DatabaseGetTableErrors, ThrowOnError>;
|
|
2516
|
+
/**
|
|
2517
|
+
* Update table
|
|
2518
|
+
*
|
|
2519
|
+
* Renames a table and/or changes its description; send only the keys to change, and send description null to clear it. The new name must follow ^[a-z_][a-z0-9_]{0,62}$ and be unused (409 UNIQUE_VIOLATION); ids are stable, so renaming never rewrites row data. A body with no changes or values equal to the current ones does not bump schema_revision. Fields cannot be changed here; use databaseAddField, databaseUpdateField and databaseDeleteField.
|
|
2520
|
+
*/
|
|
2521
|
+
export declare const databaseUpdateTable: <ThrowOnError extends boolean = false>(options: Options<DatabaseUpdateTableData, ThrowOnError>) => RequestResult<DatabaseUpdateTableResponses, DatabaseUpdateTableErrors, ThrowOnError>;
|
|
2522
|
+
/**
|
|
2523
|
+
* Add field
|
|
2524
|
+
*
|
|
2525
|
+
* Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {"name":"notes","type":"string","indexed":false}. JSON and link fields cannot be indexed. Limits: 64 fields and 16 indexed or unique fields per table (400 LIMIT_EXCEEDED). Unlike Supabase, schema evolution uses field definitions rather than ALTER TABLE statements or SQL migrations.
|
|
2526
|
+
*/
|
|
2527
|
+
export declare const databaseAddField: <ThrowOnError extends boolean = false>(options: Options<DatabaseAddFieldData, ThrowOnError>) => RequestResult<DatabaseAddFieldResponses, DatabaseAddFieldErrors, ThrowOnError>;
|
|
2528
|
+
/**
|
|
2529
|
+
* Delete field
|
|
2530
|
+
*
|
|
2531
|
+
* Deletes one field definition from a table and returns the updated table; the deletion is immediate and has no recovery window. Look the field up by id or name. The field's index, if any, is dropped with it, and the name can be reused afterwards. Unknown fields return 400 FIELD_NOT_FOUND.
|
|
2532
|
+
*/
|
|
2533
|
+
export declare const databaseDeleteField: <ThrowOnError extends boolean = false>(options: Options<DatabaseDeleteFieldData, ThrowOnError>) => RequestResult<DatabaseDeleteFieldResponses, DatabaseDeleteFieldErrors, ThrowOnError>;
|
|
2534
|
+
/**
|
|
2535
|
+
* Update field
|
|
2536
|
+
*
|
|
2537
|
+
* Changes a field's name, description, required flag, indexed flag, default or json options.schema and returns the updated table. The field type, a link field's linked_table_id and the unique flag cannot be changed (400 FIELD_TYPE_IMMUTABLE or INVALID_PARAMS). Setting required to true fails with 400 VALIDATION_FAILED while existing rows hold null for the field. A new json schema constrains only later writes; existing rows are not revalidated. Renaming never rewrites row data, and a request that changes nothing does not bump schema_revision. Unlike Supabase, field types and uniqueness cannot be altered through SQL migrations; use the supported field settings described here.
|
|
2538
|
+
*/
|
|
2539
|
+
export declare const databaseUpdateField: <ThrowOnError extends boolean = false>(options: Options<DatabaseUpdateFieldData, ThrowOnError>) => RequestResult<DatabaseUpdateFieldResponses, DatabaseUpdateFieldErrors, ThrowOnError>;
|
|
2540
|
+
/**
|
|
2541
|
+
* List events
|
|
2542
|
+
*
|
|
2543
|
+
* Read lifecycle and schema events, including while the database is deleting. next_cursor is an opaque string cursor (do not do arithmetic on it): pass it as after_seq for asc or before_seq for desc. Supplying both cursors returns 400 INVALID_PARAMS. Unlike Supabase Realtime, this is paged lifecycle and schema history, not a subscription or a row-change feed; row inserts, updates and deletes do not appear here.
|
|
2544
|
+
*/
|
|
2545
|
+
export declare const databaseListEvents: <ThrowOnError extends boolean = false>(options: Options<DatabaseListEventsData, ThrowOnError>) => RequestResult<DatabaseListEventsResponses, DatabaseListEventsErrors, ThrowOnError>;
|
|
2546
|
+
/**
|
|
2547
|
+
* Delete rows
|
|
2548
|
+
*
|
|
2549
|
+
* Deletes the rows matched by the filter query parameters (the same filters as databaseSelect); with no filter every row of the table matches. Deletion is immediate and cannot be undone. A row that a link field of another table still references makes the whole call fail with 409 REFERENCE_RESTRICT and nothing is deleted. The default response is 204 with no body; send Prefer: return=representation to get HTTP 200 with the deleted rows.
|
|
2550
|
+
*/
|
|
2551
|
+
export declare const databaseDelete: <ThrowOnError extends boolean = false>(options: Options<DatabaseDeleteData, ThrowOnError>) => RequestResult<DatabaseDeleteResponses, DatabaseDeleteErrors, ThrowOnError>;
|
|
2552
|
+
/**
|
|
2553
|
+
* Select rows
|
|
2554
|
+
*
|
|
2555
|
+
* Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property. Use praxis.database.count in the SDK or codemode to return { count: number | null }; a page length is not a total unless you know all matches fit in that page.
|
|
2556
|
+
*/
|
|
2557
|
+
export declare const databaseSelect: <ThrowOnError extends boolean = false>(options: Options<DatabaseSelectData, ThrowOnError>) => RequestResult<DatabaseSelectResponses, DatabaseSelectErrors, ThrowOnError>;
|
|
2558
|
+
/**
|
|
2559
|
+
* Count rows
|
|
2560
|
+
*
|
|
2561
|
+
* Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is **. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Use praxis.database.count in the SDK or codemode to return { count: number | null } from this header without retrieving rows.
|
|
2562
|
+
*/
|
|
2563
|
+
export declare const databaseHead: <ThrowOnError extends boolean = false>(options: Options<DatabaseHeadData, ThrowOnError>) => RequestResult<DatabaseHeadResponses, DatabaseHeadErrors, ThrowOnError>;
|
|
2564
|
+
/**
|
|
2565
|
+
* Update rows
|
|
2566
|
+
*
|
|
2567
|
+
* Updates the rows matched by the filter query parameters (the same filters as databaseSelect); with no filter every row of the table matches. The JSON object body lists only the fields to change, other fields keep their values, and id cannot be changed. Values are validated against the field types and the required and unique settings (400 VALIDATION_FAILED, 409 UNIQUE_VIOLATION). The default response is 204 with no body; send Prefer: return=representation to get HTTP 200 with the updated rows. Each changed row's _version increases by one.
|
|
2568
|
+
*/
|
|
2569
|
+
export declare const databaseUpdate: <ThrowOnError extends boolean = false>(options: Options<DatabaseUpdateData, ThrowOnError>) => RequestResult<DatabaseUpdateResponses, DatabaseUpdateErrors, ThrowOnError>;
|
|
2570
|
+
/**
|
|
2571
|
+
* Insert rows
|
|
2572
|
+
*
|
|
2573
|
+
* Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.
|
|
2574
|
+
* Rows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.
|
|
2575
|
+
* The default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.
|
|
2576
|
+
*/
|
|
2577
|
+
export declare const databaseInsert: <ThrowOnError extends boolean = false>(options: Options<DatabaseInsertData, ThrowOnError>) => RequestResult<DatabaseInsertResponses, DatabaseInsertErrors, ThrowOnError>;
|
|
2578
|
+
/**
|
|
2579
|
+
* Read a commit's test catalog
|
|
2580
|
+
*
|
|
2581
|
+
* Read the catalog version discovered at one commit — how many suites and cases it holds, which frameworks they come from, and how the commit changed them. Call this first: it tells you which suites, cases and sizes exist before you list them or select them into a plan, and the reported diff explains why a case count moved. A commit whose discovery has not finished answers CATALOG_NOT_READY, which means "not yet", not "no tests"; wait and read again. Omit commit to read the newest catalog published for the project.
|
|
2582
|
+
*/
|
|
2583
|
+
export declare const devopsTestCatalogGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestCatalogGetData, ThrowOnError>) => RequestResult<DevopsTestCatalogGetResponses, DevopsTestCatalogGetErrors, ThrowOnError>;
|
|
2584
|
+
/**
|
|
2585
|
+
* List test suites
|
|
2586
|
+
*
|
|
2587
|
+
* List the suites the project's newest catalog discovered — one suite per test file and framework pair, with its size, purposes and question count. Use it to find the suite id a case belongs to, or to see which files make up an area before selecting cases from them. Suites come from the catalog, so a file added in code appears only after its commit's catalog is published. Archived suites are returned too; they carry archived true and no case is ever silently dropped from the list.
|
|
2588
|
+
*/
|
|
2589
|
+
export declare const devopsTestSuitesList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestSuitesListData, ThrowOnError>) => RequestResult<DevopsTestSuitesListResponses, DevopsTestSuitesListErrors, ThrowOnError>;
|
|
2590
|
+
/**
|
|
2591
|
+
* Retrieve a test suite
|
|
2592
|
+
*
|
|
2593
|
+
* Read one suite by the id a suite list returned, to learn its file, framework, size, purposes and how many cases it holds. Use it when a case's suite id needs a name for display, or to confirm which commit's catalog a suite came from. The id is opaque; it comes from the list, never from the file path.
|
|
2594
|
+
*/
|
|
2595
|
+
export declare const devopsTestSuitesGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestSuitesGetData, ThrowOnError>) => RequestResult<DevopsTestSuitesGetResponses, DevopsTestSuitesGetErrors, ThrowOnError>;
|
|
2596
|
+
/**
|
|
2597
|
+
* List test cases
|
|
2598
|
+
*
|
|
2599
|
+
* List a project's cases with their health, state and recent statistics, so you can decide which ones a plan must run and which are quarantined. This is the read a test dashboard is built on; filter it to narrow by state or health instead of paging through everything. A case's id is a fingerprint of its own title and path, so it survives a rename — read aliases when reconciling history recorded under an older title.
|
|
2600
|
+
*/
|
|
2601
|
+
export declare const devopsTestCasesList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestCasesListData, ThrowOnError>) => RequestResult<DevopsTestCasesListResponses, DevopsTestCasesListErrors, ThrowOnError>;
|
|
2602
|
+
/**
|
|
2603
|
+
* Retrieve a test case
|
|
2604
|
+
*
|
|
2605
|
+
* Read one case in full — its steps, tags, declared owners, current state with the policy and ticket behind it, and its rolling 7 or 30 day statistics. Use it before quarantining or fixing a case, to see what the state already is and why. A case that was renamed is reachable by both its current fingerprint id and the ids listed in aliases.
|
|
2606
|
+
*/
|
|
2607
|
+
export declare const devopsTestCasesGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestCasesGetData, ThrowOnError>) => RequestResult<DevopsTestCasesGetResponses, DevopsTestCasesGetErrors, ThrowOnError>;
|
|
2608
|
+
/**
|
|
2609
|
+
* List test plans
|
|
2610
|
+
*
|
|
2611
|
+
* List the project's plans — what each one selects, which stage and gate it belongs to, and when it runs next. Read this before creating a plan, so a new plan extends what exists instead of duplicating a selector an existing plan already covers.
|
|
2612
|
+
*/
|
|
2613
|
+
export declare const devopsTestPlansList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansListData, ThrowOnError>) => RequestResult<DevopsTestPlansListResponses, DevopsTestPlansListErrors, ThrowOnError>;
|
|
2614
|
+
/**
|
|
2615
|
+
* Create a test plan
|
|
2616
|
+
*
|
|
2617
|
+
* Create a plan that decides which cases a stage must run. The plan's key is unique inside the project and is what a later run names; the selector chooses cases by size, purpose, tag, package or explicit ids, and the trigger says when the plan fires by itself. A merge or promotion gate must name the environment it guards, and a plan with a gate but no environment is refused with PLAN_GATE_ENVIRONMENT_MISMATCH rather than created and silently ignored. A plan has no revision history: update it with a patch.
|
|
2618
|
+
*/
|
|
2619
|
+
export declare const devopsTestPlansCreate: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansCreateData, ThrowOnError>) => RequestResult<DevopsTestPlansCreateResponses, DevopsTestPlansCreateErrors, ThrowOnError>;
|
|
2620
|
+
/**
|
|
2621
|
+
* Delete a test plan
|
|
2622
|
+
*
|
|
2623
|
+
* Delete a plan so it schedules nothing further. The plan stops firing immediately; runs it already produced keep their own record and are not deleted with it. To stop a plan temporarily and keep it for later, pause it instead — deleting cannot be undone and the plan's key becomes free for another plan to take.
|
|
2624
|
+
*/
|
|
2625
|
+
export declare const devopsTestPlansDelete: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansDeleteData, ThrowOnError>) => RequestResult<DevopsTestPlansDeleteResponses, DevopsTestPlansDeleteErrors, ThrowOnError>;
|
|
2626
|
+
/**
|
|
2627
|
+
* Retrieve a test plan
|
|
2628
|
+
*
|
|
2629
|
+
* Read one plan by the id a plan list returned, to see its selector, gate, repeat count, timeout and pause state before updating or deleting it. A paused plan carries the reason, the actor and the time it resumes, so a pause you did not set is explained here rather than guessed at.
|
|
2630
|
+
*/
|
|
2631
|
+
export declare const devopsTestPlansGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansGetData, ThrowOnError>) => RequestResult<DevopsTestPlansGetResponses, DevopsTestPlansGetErrors, ThrowOnError>;
|
|
2632
|
+
/**
|
|
2633
|
+
* Update a test plan
|
|
2634
|
+
*
|
|
2635
|
+
* Change a plan's title, trigger, selector, gate, repeat count, timeout or enabled flag. Only the fields present in the body are changed, so a body naming one field leaves the rest exactly as they were. Changing a selector does not create a version — the plan is not a published artefact, and runs already started keep the selection they were created with. Read the plan first to know what you are leaving unchanged.
|
|
2636
|
+
*/
|
|
2637
|
+
export declare const devopsTestPlansUpdate: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansUpdateData, ThrowOnError>) => RequestResult<DevopsTestPlansUpdateResponses, DevopsTestPlansUpdateErrors, ThrowOnError>;
|
|
2638
|
+
/**
|
|
2639
|
+
* Pause a test plan
|
|
2640
|
+
*
|
|
2641
|
+
* Stop a plan from starting new runs while keeping it and its history. A reason is required and is recorded on the plan, so the next reader learns why it stopped. Give until to resume automatically at a time; omit it to stay paused until someone resumes it. Runs already in flight are not cancelled — cancel those individually.
|
|
2642
|
+
*/
|
|
2643
|
+
export declare const devopsTestPlansPause: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansPauseData, ThrowOnError>) => RequestResult<DevopsTestPlansPauseResponses, DevopsTestPlansPauseErrors, ThrowOnError>;
|
|
2644
|
+
/**
|
|
2645
|
+
* Resume a test plan
|
|
2646
|
+
*
|
|
2647
|
+
* Clear a plan's pause so it schedules runs again. Resuming an active plan changes nothing and is safe to repeat. The plan keeps its selector, gate and key; only the pause is removed.
|
|
2648
|
+
*/
|
|
2649
|
+
export declare const devopsTestPlansResume: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansResumeData, ThrowOnError>) => RequestResult<DevopsTestPlansResumeResponses, DevopsTestPlansResumeErrors, ThrowOnError>;
|
|
2650
|
+
/**
|
|
2651
|
+
* List test runs
|
|
2652
|
+
*
|
|
2653
|
+
* List the project's runs newest first, with each run's state, result and counts. Use it to find the run id whose executions you want to read, or to see whether a commit's tests have finished. A run whose result is pending has not reached a verdict yet — read it again rather than treating it as passed. Filter by state or result to watch only the runs still in flight.
|
|
2654
|
+
*/
|
|
2655
|
+
export declare const devopsTestRunsList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestRunsListData, ThrowOnError>) => RequestResult<DevopsTestRunsListResponses, DevopsTestRunsListErrors, ThrowOnError>;
|
|
2656
|
+
/**
|
|
2657
|
+
* Create a test run
|
|
2658
|
+
*
|
|
2659
|
+
* Start a run of the project's tests at one commit. Name a plan to use its selector, or pass a selector directly for this run alone; the ref says which commit to test and is required, because a run without a commit has nothing to report against. waitUntil decides how far the call waits before answering — queued, the default, returns as soon as the run exists; started waits until the run has begun, except for an external run, which is answered at once because it leaves queued only when your own CI uploads; finished waits for a verdict. The wait is bounded at about 25 seconds, and a wait that reaches that bound returns the run as it stands rather than failing — read state to see whether it finished. A retry of an earlier run is a new run: pass its commit and selector, and read the earlier run to compare.
|
|
2660
|
+
*/
|
|
2661
|
+
export declare const devopsTestRunsCreate: <ThrowOnError extends boolean = false>(options: Options<DevopsTestRunsCreateData, ThrowOnError>) => RequestResult<DevopsTestRunsCreateResponses, DevopsTestRunsCreateErrors, ThrowOnError>;
|
|
2662
|
+
/**
|
|
2663
|
+
* Retrieve a test run
|
|
2664
|
+
*
|
|
2665
|
+
* Read one run's current state, result and counts, and ask for its failed executions inline with expand. Poll this after creating a run whose result was pending. A result is monotonic once it reaches a verdict — a failed run never becomes passed by a later report, so read the run rather than the last report to know where it ended.
|
|
2666
|
+
*/
|
|
2667
|
+
export declare const devopsTestRunsGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestRunsGetData, ThrowOnError>) => RequestResult<DevopsTestRunsGetResponses, DevopsTestRunsGetErrors, ThrowOnError>;
|
|
2668
|
+
/**
|
|
2669
|
+
* Cancel a test run
|
|
2670
|
+
*
|
|
2671
|
+
* Stop a run that is still going. A reason is required and is recorded on the run, because a cancelled run is read later as evidence about why a commit was not verified. Cancelling a run that already reached a verdict is refused with RUN_ALREADY_FINISHED: its result is final and cancelling it would erase the verdict. Executions already recorded stay readable.
|
|
2672
|
+
*/
|
|
2673
|
+
export declare const devopsTestRunsCancel: <ThrowOnError extends boolean = false>(options: Options<DevopsTestRunsCancelData, ThrowOnError>) => RequestResult<DevopsTestRunsCancelResponses, DevopsTestRunsCancelErrors, ThrowOnError>;
|
|
2674
|
+
/**
|
|
2675
|
+
* List a run's executions
|
|
2676
|
+
*
|
|
2677
|
+
* List the executions recorded against one run — one entry per case the run selected, with its status, duration, attempts and evidence. Use it to find the case that failed, or to compare a repeat run against the previous one case by case. Reads happen while the run is still going, so a case may still be pending; filter by status to watch only the failures.
|
|
2678
|
+
*/
|
|
2679
|
+
export declare const devopsTestExecutionsList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestExecutionsListData, ThrowOnError>) => RequestResult<DevopsTestExecutionsListResponses, DevopsTestExecutionsListErrors, ThrowOnError>;
|
|
2680
|
+
/**
|
|
2681
|
+
* Retrieve one case's execution in a run
|
|
2682
|
+
*
|
|
2683
|
+
* Read one case's execution inside one run, including every attempt with its own duration and message. Use it after a run reports a failure to see whether the case failed once and passed on retry — that is what flaky true means — and to reach the evidence files a triage needs. Both ids come from the run and case reads; an execution that does not exist for that pair is NOT_FOUND rather than an empty answer.
|
|
2684
|
+
*/
|
|
2685
|
+
export declare const devopsTestExecutionsGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestExecutionsGetData, ThrowOnError>) => RequestResult<DevopsTestExecutionsGetResponses, DevopsTestExecutionsGetErrors, ThrowOnError>;
|
|
2686
|
+
/**
|
|
2687
|
+
* Upload an external test report
|
|
2688
|
+
*
|
|
2689
|
+
* Record the results of a run executed outside Praxis by uploading a CTRF or JUnit report. Nothing has to exist first: a first upload from CI creates the run it reports on (executor external) and catalogues the cases the report names, so there is no setup call before the first result. When the report already belongs to a run, pass ref and the upload joins it; the run's counts and verdict are recomputed from the report. Uploading the same reportId again is idempotent and counts once, so a retry after a timeout is safe — and a reported case is catalogued once, however many reports carry it. The report's bytes are kept as a file (the file field of the answer) rather than in the results database, so the original document stays retrievable.
|
|
2690
|
+
*/
|
|
2691
|
+
export declare const devopsTestReportsUpload: <ThrowOnError extends boolean = false>(options: Options<DevopsTestReportsUploadData, ThrowOnError>) => RequestResult<DevopsTestReportsUploadResponses, DevopsTestReportsUploadErrors, ThrowOnError>;
|
|
2692
|
+
/**
|
|
2693
|
+
* List knowledge bases
|
|
2694
|
+
*
|
|
2695
|
+
* Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.
|
|
2696
|
+
*/
|
|
2697
|
+
export declare const knowledgeListVectorStores: <ThrowOnError extends boolean = false>(options?: Options<KnowledgeListVectorStoresData, ThrowOnError>) => RequestResult<KnowledgeListVectorStoresResponses, KnowledgeListVectorStoresErrors, ThrowOnError>;
|
|
2698
|
+
/**
|
|
2699
|
+
* Create knowledge base
|
|
2700
|
+
*
|
|
2701
|
+
* Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {"name":"Refund policies"}.
|
|
2702
|
+
*/
|
|
2703
|
+
export declare const knowledgeCreateVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeCreateVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeCreateVectorStoreResponses, KnowledgeCreateVectorStoreErrors, ThrowOnError>;
|
|
2704
|
+
/**
|
|
2705
|
+
* Delete knowledge base
|
|
2706
|
+
*
|
|
2707
|
+
* Remove a knowledge base from active use while keeping a recovery window. Unlike OpenAI vector stores, native DELETE returns the store with status=deleting and ISO purge_at, retains it for 7 days and is idempotent on repeat. Retrieve remains 200; object operations return 409. Use restore before purge_at to recover it, or purge to remove it irreversibly.
|
|
2708
|
+
*/
|
|
2709
|
+
export declare const knowledgeDeleteVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeDeleteVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeDeleteVectorStoreResponses, KnowledgeDeleteVectorStoreErrors, ThrowOnError>;
|
|
2710
|
+
/**
|
|
2711
|
+
* Retrieve knowledge base
|
|
2712
|
+
*
|
|
2713
|
+
* Retrieves a knowledge base using an id returned by create or list. Add ?expand=files to include the first page of attached files. Soft-deleted stores remain readable with status=deleting until purged.
|
|
2714
|
+
*/
|
|
2715
|
+
export declare const knowledgeRetrieveVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeRetrieveVectorStoreResponses, KnowledgeRetrieveVectorStoreErrors, ThrowOnError>;
|
|
2716
|
+
/**
|
|
2717
|
+
* Update knowledge base
|
|
2718
|
+
*
|
|
2719
|
+
* Updates an active knowledge base using its returned id. Omitted fields stay unchanged; metadata replaces the whole map. Example body: {"name":"Refund policies"}.
|
|
2720
|
+
*/
|
|
2721
|
+
export declare const knowledgeUpdateVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeUpdateVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeUpdateVectorStoreResponses, KnowledgeUpdateVectorStoreErrors, ThrowOnError>;
|
|
2722
|
+
/**
|
|
2723
|
+
* Search knowledge base
|
|
2724
|
+
*
|
|
2725
|
+
* Search ingested text to answer a question or find supporting passages. Native results contain one chunk each, so file_id can repeat; max_num_results counts chunks (1–50, default 10), while the compatible URL groups results by file. Unlike OpenAI vector stores, next_page is always null even when has_more is true. Only completed attachments are searchable. For keyword-only retrieval set ranking_options.hybrid_search to {"embedding_weight":0,"text_weight":1}; omit rewrite_query or set it to false to avoid query rewriting. Unlike OpenAI, ranker auto does not rerank; only default-2024-11-15 requests reranking. Set praxis.explain=true to inspect scores and use returned content[].chunk_id to retrieve a segment.
|
|
2726
|
+
*/
|
|
2727
|
+
export declare const knowledgeSearchVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeSearchVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeSearchVectorStoreResponses, KnowledgeSearchVectorStoreErrors, ThrowOnError>;
|
|
2728
|
+
/**
|
|
2729
|
+
* List files
|
|
2730
|
+
*
|
|
2731
|
+
* Lists attached files and their ingestion status, newest attachment first by default. Use last_id as after to continue; ?filter=failed selects files that can be retried.
|
|
2732
|
+
*/
|
|
2733
|
+
export declare const knowledgeListFiles: <ThrowOnError extends boolean = false>(options: Options<KnowledgeListFilesData, ThrowOnError>) => RequestResult<KnowledgeListFilesResponses, KnowledgeListFilesErrors, ThrowOnError>;
|
|
2734
|
+
/**
|
|
2735
|
+
* Add file
|
|
2736
|
+
*
|
|
2737
|
+
* Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.
|
|
2738
|
+
*/
|
|
2739
|
+
export declare const knowledgeAttachFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeAttachFileData, ThrowOnError>) => RequestResult<KnowledgeAttachFileResponses, KnowledgeAttachFileErrors, ThrowOnError>;
|
|
2740
|
+
/**
|
|
2741
|
+
* Remove file
|
|
2742
|
+
*
|
|
2743
|
+
* Removes the file from search immediately; does not delete the original File.
|
|
2744
|
+
*/
|
|
2745
|
+
export declare const knowledgeRemoveFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRemoveFileData, ThrowOnError>) => RequestResult<KnowledgeRemoveFileResponses, KnowledgeRemoveFileErrors, ThrowOnError>;
|
|
2746
|
+
/**
|
|
2747
|
+
* Retrieve file
|
|
2748
|
+
*
|
|
2749
|
+
* Retrieves an attached file using the id returned by attachment or file listing. Poll this operation until status leaves in_progress to observe the ingestion outcome.
|
|
2750
|
+
*/
|
|
2751
|
+
export declare const knowledgeRetrieveFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveFileData, ThrowOnError>) => RequestResult<KnowledgeRetrieveFileResponses, KnowledgeRetrieveFileErrors, ThrowOnError>;
|
|
2752
|
+
/**
|
|
2753
|
+
* Update file attributes
|
|
2754
|
+
*
|
|
2755
|
+
* Replaces search-filter attributes of an existing attachment without reingesting its content. Use an attached file id. Example body: {"attributes":{"category":"refund"}}; null clears the attributes.
|
|
2756
|
+
*/
|
|
2757
|
+
export declare const knowledgeUpdateFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeUpdateFileData, ThrowOnError>) => RequestResult<KnowledgeUpdateFileResponses, KnowledgeUpdateFileErrors, ThrowOnError>;
|
|
2758
|
+
/**
|
|
2759
|
+
* Read extracted content
|
|
2760
|
+
*
|
|
2761
|
+
* Extracted text chunks may overlap. Image content can be a generated description rather than verbatim OCR.
|
|
2762
|
+
*/
|
|
2763
|
+
export declare const knowledgeRetrieveFileContent: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveFileContentData, ThrowOnError>) => RequestResult<KnowledgeRetrieveFileContentResponses, KnowledgeRetrieveFileContentErrors, ThrowOnError>;
|
|
2764
|
+
/**
|
|
2765
|
+
* Create file batch
|
|
2766
|
+
*
|
|
2767
|
+
* Attaches existing Files as a batch for asynchronous ingestion. Supply exactly one of file_ids or files; files allows per-file settings. Existing attachments are reused. Read the returned batch id to monitor status.
|
|
2768
|
+
*/
|
|
2769
|
+
export declare const knowledgeCreateFileBatch: <ThrowOnError extends boolean = false>(options: Options<KnowledgeCreateFileBatchData, ThrowOnError>) => RequestResult<KnowledgeCreateFileBatchResponses, KnowledgeCreateFileBatchErrors, ThrowOnError>;
|
|
2770
|
+
/**
|
|
2771
|
+
* Retrieve file batch
|
|
2772
|
+
*
|
|
2773
|
+
* Retrieves a batch created in this knowledge base, including current status and file counts. Use the batch id returned by batch creation to monitor ingestion.
|
|
2774
|
+
*/
|
|
2775
|
+
export declare const knowledgeRetrieveFileBatch: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveFileBatchData, ThrowOnError>) => RequestResult<KnowledgeRetrieveFileBatchResponses, KnowledgeRetrieveFileBatchErrors, ThrowOnError>;
|
|
2776
|
+
/**
|
|
2777
|
+
* Cancel file batch
|
|
2778
|
+
*
|
|
2779
|
+
* Cancels only in-progress batches and pending files. Completed, failed and cancelled batches return unchanged (200, idempotent).
|
|
2780
|
+
*/
|
|
2781
|
+
export declare const knowledgeCancelFileBatch: <ThrowOnError extends boolean = false>(options: Options<KnowledgeCancelFileBatchData, ThrowOnError>) => RequestResult<KnowledgeCancelFileBatchResponses, KnowledgeCancelFileBatchErrors, ThrowOnError>;
|
|
2782
|
+
/**
|
|
2783
|
+
* List batch files
|
|
2784
|
+
*
|
|
2785
|
+
* Lists files still attached from the identified batch, newest attachment first by default. Use the batch creation id and ?filter=failed to inspect failures; last_id is the next after cursor.
|
|
2786
|
+
*/
|
|
2787
|
+
export declare const knowledgeListBatchFiles: <ThrowOnError extends boolean = false>(options: Options<KnowledgeListBatchFilesData, ThrowOnError>) => RequestResult<KnowledgeListBatchFilesResponses, KnowledgeListBatchFilesErrors, ThrowOnError>;
|
|
2788
|
+
/**
|
|
2789
|
+
* Restore knowledge base
|
|
2790
|
+
*
|
|
2791
|
+
* Restores a deleting store within 7 days. Active stores return 409 VECTOR_STORE_INVALID_STATE; absent stores return 404. Empty body is allowed.
|
|
2792
|
+
*/
|
|
2793
|
+
export declare const knowledgeRestoreVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRestoreVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeRestoreVectorStoreResponses, KnowledgeRestoreVectorStoreErrors, ThrowOnError>;
|
|
2794
|
+
/**
|
|
2795
|
+
* Permanently purge knowledge base
|
|
2796
|
+
*
|
|
2797
|
+
* Immediately and irreversibly clears a deleting store using the retention cleanup path. Active stores return 409; absent stores return 404. Empty body is allowed.
|
|
2798
|
+
*/
|
|
2799
|
+
export declare const knowledgePurgeVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgePurgeVectorStoreData, ThrowOnError>) => RequestResult<KnowledgePurgeVectorStoreResponses, KnowledgePurgeVectorStoreErrors, ThrowOnError>;
|
|
2800
|
+
/**
|
|
2801
|
+
* Retry failed file
|
|
2802
|
+
*
|
|
2803
|
+
* Retries only failed files; other states return 409 FILE_INVALID_STATE. Retry after failure has not yet been observed in the documented run.
|
|
2804
|
+
*/
|
|
2805
|
+
export declare const knowledgeRetryFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetryFileData, ThrowOnError>) => RequestResult<KnowledgeRetryFileResponses, KnowledgeRetryFileErrors, ThrowOnError>;
|
|
2806
|
+
/**
|
|
2807
|
+
* List file segments
|
|
2808
|
+
*
|
|
2809
|
+
* Lists the stored chunks of an attached file, ordered by increasing segment index by default. Use the attachment id and last_id as after to continue; returned chunk ids can be retrieved individually.
|
|
2810
|
+
*/
|
|
2811
|
+
export declare const knowledgeListSegments: <ThrowOnError extends boolean = false>(options: Options<KnowledgeListSegmentsData, ThrowOnError>) => RequestResult<KnowledgeListSegmentsResponses, KnowledgeListSegmentsErrors, ThrowOnError>;
|
|
2812
|
+
/**
|
|
2813
|
+
* Retrieve segment
|
|
2814
|
+
*
|
|
2815
|
+
* Retrieves one chunk and its term statistics. Take chunk_id from segment listing or native search content; the chunk must belong to this knowledge base.
|
|
2816
|
+
*/
|
|
2817
|
+
export declare const knowledgeRetrieveSegment: <ThrowOnError extends boolean = false>(options: Options<KnowledgeRetrieveSegmentData, ThrowOnError>) => RequestResult<KnowledgeRetrieveSegmentResponses, KnowledgeRetrieveSegmentErrors, ThrowOnError>;
|
|
2818
|
+
/**
|
|
2819
|
+
* List events
|
|
2820
|
+
*
|
|
2821
|
+
* Reads events for this knowledge base in increasing sequence order, including while soft-deleted. Pass next_seq as after_seq to continue; null next_seq marks the current end. Example: ?after_seq=0&limit=20.
|
|
2822
|
+
*/
|
|
2823
|
+
export declare const knowledgeListEvents: <ThrowOnError extends boolean = false>(options: Options<KnowledgeListEventsData, ThrowOnError>) => RequestResult<KnowledgeListEventsResponses, KnowledgeListEventsErrors, ThrowOnError>;
|
|
2824
|
+
/**
|
|
2825
|
+
* List libraries
|
|
2826
|
+
*
|
|
2827
|
+
* Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.
|
|
2828
|
+
*/
|
|
2829
|
+
export declare const mediaListLibraries: <ThrowOnError extends boolean = false>(options?: Options<MediaListLibrariesData, ThrowOnError>) => RequestResult<MediaListLibrariesResponses, MediaListLibrariesErrors, ThrowOnError>;
|
|
2830
|
+
/**
|
|
2831
|
+
* Create library
|
|
2832
|
+
*
|
|
2833
|
+
* Create a library owned by the caller with a name, optional labels and understanding settings. Understanding is enabled by default; the returned id is used for subsequent asset operations.
|
|
2834
|
+
*/
|
|
2835
|
+
export declare const mediaCreateLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaCreateLibraryData, ThrowOnError>) => RequestResult<MediaCreateLibraryResponses, MediaCreateLibraryErrors, ThrowOnError>;
|
|
2836
|
+
/**
|
|
2837
|
+
* Create frame URLs
|
|
2838
|
+
*
|
|
2839
|
+
* Media creates JPEG frame URLs for inspecting one or more moments in a video without downloading the original. Obtain library_id from libraries and asset_id plus duration from assets. Send 1–20 integer microsecond timestamps strictly below duration, for example {"at_micros":[0,1000000],"width":640}. Only video assets are supported; audio and images return INVALID_PARAMS. Width defaults to 640 and accepts 160, 320 or 640. This read operation does not store a new asset or rerun understanding. Fetch each returned URL to obtain the frame; delivery usage follows media pricing. Authenticated links expire after 300 seconds; upload links remain public and permanent. Reissue expired links. Foreign libraries and assets return 404 without revealing their existence.
|
|
2840
|
+
*/
|
|
2841
|
+
export declare const mediaCreateFrameUrls: <ThrowOnError extends boolean = false>(options: Options<MediaCreateFrameUrlsData, ThrowOnError>) => RequestResult<MediaCreateFrameUrlsResponses, MediaCreateFrameUrlsErrors, ThrowOnError>;
|
|
2842
|
+
/**
|
|
2843
|
+
* Delete library
|
|
2844
|
+
*
|
|
2845
|
+
* Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.
|
|
2846
|
+
*/
|
|
2847
|
+
export declare const mediaDeleteLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaDeleteLibraryData, ThrowOnError>) => RequestResult<MediaDeleteLibraryResponses, MediaDeleteLibraryErrors, ThrowOnError>;
|
|
2848
|
+
/**
|
|
2849
|
+
* Get library
|
|
2850
|
+
*
|
|
2851
|
+
* Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.
|
|
2852
|
+
*/
|
|
2853
|
+
export declare const mediaGetLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaGetLibraryData, ThrowOnError>) => RequestResult<MediaGetLibraryResponses, MediaGetLibraryErrors, ThrowOnError>;
|
|
2854
|
+
/**
|
|
2855
|
+
* Update library
|
|
2856
|
+
*
|
|
2857
|
+
* Update an active library. Set hotwords for spelling evidence in subsequent transcripts; [] disables inferred vocabulary. Transcript understanding calls the timestamped ASR, optional reference ASR and correction model through the existing metered model path. Reprocess assets to apply new settings to existing transcripts.
|
|
2858
|
+
*/
|
|
2859
|
+
export declare const mediaUpdateLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaUpdateLibraryData, ThrowOnError>) => RequestResult<MediaUpdateLibraryResponses, MediaUpdateLibraryErrors, ThrowOnError>;
|
|
2860
|
+
/**
|
|
2861
|
+
* Restore library
|
|
2862
|
+
*
|
|
2863
|
+
* Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.
|
|
2864
|
+
*/
|
|
2865
|
+
export declare const mediaRestoreLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaRestoreLibraryData, ThrowOnError>) => RequestResult<MediaRestoreLibraryResponses, MediaRestoreLibraryErrors, ThrowOnError>;
|
|
2866
|
+
/**
|
|
2867
|
+
* Purge library
|
|
2868
|
+
*
|
|
2869
|
+
* List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.
|
|
2870
|
+
*/
|
|
2871
|
+
export declare const mediaPurgeLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaPurgeLibraryData, ThrowOnError>) => RequestResult<MediaPurgeLibraryResponses, MediaPurgeLibraryErrors, ThrowOnError>;
|
|
2872
|
+
/**
|
|
2873
|
+
* List assets
|
|
2874
|
+
*
|
|
2875
|
+
* Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.
|
|
2876
|
+
*/
|
|
2877
|
+
export declare const mediaListAssets: <ThrowOnError extends boolean = false>(options: Options<MediaListAssetsData, ThrowOnError>) => RequestResult<MediaListAssetsResponses, MediaListAssetsErrors, ThrowOnError>;
|
|
2878
|
+
/**
|
|
2879
|
+
* Upload asset
|
|
2880
|
+
*
|
|
2881
|
+
* For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.
|
|
2882
|
+
*/
|
|
2883
|
+
export declare const mediaUploadAsset: <ThrowOnError extends boolean = false>(options: Options<MediaUploadAssetData, ThrowOnError>) => RequestResult<MediaUploadAssetResponses, MediaUploadAssetErrors, ThrowOnError>;
|
|
2884
|
+
/**
|
|
2885
|
+
* Import file
|
|
2886
|
+
*
|
|
2887
|
+
* Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.
|
|
2888
|
+
*/
|
|
2889
|
+
export declare const mediaImportAsset: <ThrowOnError extends boolean = false>(options: Options<MediaImportAssetData, ThrowOnError>) => RequestResult<MediaImportAssetResponses, MediaImportAssetErrors, ThrowOnError>;
|
|
2890
|
+
/**
|
|
2891
|
+
* Delete asset
|
|
2892
|
+
*
|
|
2893
|
+
* Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable completed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Replaced understandings become superseded, and processing finishes asynchronously.
|
|
2894
|
+
*/
|
|
2895
|
+
export declare const mediaDeleteAsset: <ThrowOnError extends boolean = false>(options: Options<MediaDeleteAssetData, ThrowOnError>) => RequestResult<MediaDeleteAssetResponses, MediaDeleteAssetErrors, ThrowOnError>;
|
|
2896
|
+
/**
|
|
2897
|
+
* Get asset
|
|
2898
|
+
*
|
|
2899
|
+
* Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.
|
|
2900
|
+
*/
|
|
2901
|
+
export declare const mediaGetAsset: <ThrowOnError extends boolean = false>(options: Options<MediaGetAssetData, ThrowOnError>) => RequestResult<MediaGetAssetResponses, MediaGetAssetErrors, ThrowOnError>;
|
|
2902
|
+
/**
|
|
2903
|
+
* Update asset
|
|
2904
|
+
*
|
|
2905
|
+
* Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.
|
|
2906
|
+
*/
|
|
2907
|
+
export declare const mediaUpdateAsset: <ThrowOnError extends boolean = false>(options: Options<MediaUpdateAssetData, ThrowOnError>) => RequestResult<MediaUpdateAssetResponses, MediaUpdateAssetErrors, ThrowOnError>;
|
|
2908
|
+
/**
|
|
2909
|
+
* Reprocess asset
|
|
2910
|
+
*
|
|
2911
|
+
* For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.
|
|
2912
|
+
*/
|
|
2913
|
+
export declare const mediaReprocessAsset: <ThrowOnError extends boolean = false>(options: Options<MediaReprocessAssetData, ThrowOnError>) => RequestResult<MediaReprocessAssetResponses, MediaReprocessAssetErrors, ThrowOnError>;
|
|
2914
|
+
/**
|
|
2915
|
+
* List understandings
|
|
2916
|
+
*
|
|
2917
|
+
* List understanding results for an asset, ordered by creation time. Use the cursor to continue; include_superseded also returns replaced records. The optional shots array contains current-version shot boundaries and per-shot captions, scene, location guesses, visible text and confidence flags; it is absent on legacy records. Location guesses and folder mismatch are unverified hints. Correction-enabled transcripts expose text_original, corrected text and a correction audit. Their timed data array remains suitable for subtitles. Reference failure is marked missing; correction failure returns the original verbatim. Model inference uses the existing metered model path.
|
|
2918
|
+
*/
|
|
2919
|
+
export declare const mediaListUnderstandings: <ThrowOnError extends boolean = false>(options: Options<MediaListUnderstandingsData, ThrowOnError>) => RequestResult<MediaListUnderstandingsResponses, MediaListUnderstandingsErrors, ThrowOnError>;
|
|
2920
|
+
/**
|
|
2921
|
+
* Expression search
|
|
2922
|
+
*
|
|
2923
|
+
* Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.
|
|
2924
|
+
*/
|
|
2925
|
+
export declare const mediaExpressionSearch: <ThrowOnError extends boolean = false>(options: Options<MediaExpressionSearchData, ThrowOnError>) => RequestResult<MediaExpressionSearchResponses, MediaExpressionSearchErrors, ThrowOnError>;
|
|
2926
|
+
/**
|
|
2927
|
+
* Visual search
|
|
2928
|
+
*
|
|
2929
|
+
* Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.
|
|
2930
|
+
*/
|
|
2931
|
+
export declare const mediaVisualSearch: <ThrowOnError extends boolean = false>(options: Options<MediaVisualSearchData, ThrowOnError>) => RequestResult<MediaVisualSearchResponses, MediaVisualSearchErrors, ThrowOnError>;
|
|
2932
|
+
/**
|
|
2933
|
+
* Semantic search
|
|
2934
|
+
*
|
|
2935
|
+
* Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.
|
|
2936
|
+
*/
|
|
2937
|
+
export declare const mediaSemanticSearch: <ThrowOnError extends boolean = false>(options: Options<MediaSemanticSearchData, ThrowOnError>) => RequestResult<MediaSemanticSearchResponses, MediaSemanticSearchErrors, ThrowOnError>;
|
|
2938
|
+
/**
|
|
2939
|
+
* Semantic search alias
|
|
2940
|
+
*
|
|
2941
|
+
* List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.
|
|
2942
|
+
*/
|
|
2943
|
+
export declare const mediaSearch: <ThrowOnError extends boolean = false>(options: Options<MediaSearchData, ThrowOnError>) => RequestResult<MediaSearchResponses, MediaSearchErrors, ThrowOnError>;
|
|
2944
|
+
/**
|
|
2945
|
+
* List folders
|
|
2946
|
+
*
|
|
2947
|
+
* undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.
|
|
2948
|
+
*/
|
|
2949
|
+
export declare const mediaListFolders: <ThrowOnError extends boolean = false>(options: Options<MediaListFoldersData, ThrowOnError>) => RequestResult<MediaListFoldersResponses, MediaListFoldersErrors, ThrowOnError>;
|
|
2950
|
+
/**
|
|
2951
|
+
* Create batch
|
|
2952
|
+
*
|
|
2953
|
+
* Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.
|
|
2954
|
+
*/
|
|
2955
|
+
export declare const mediaCreateBatch: <ThrowOnError extends boolean = false>(options: Options<MediaCreateBatchData, ThrowOnError>) => RequestResult<MediaCreateBatchResponses, MediaCreateBatchErrors, ThrowOnError>;
|
|
2956
|
+
/**
|
|
2957
|
+
* Get batch
|
|
2958
|
+
*
|
|
2959
|
+
* Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.
|
|
2960
|
+
*/
|
|
2961
|
+
export declare const mediaGetBatch: <ThrowOnError extends boolean = false>(options: Options<MediaGetBatchData, ThrowOnError>) => RequestResult<MediaGetBatchResponses, MediaGetBatchErrors, ThrowOnError>;
|
|
2962
|
+
/**
|
|
2963
|
+
* Batch assets alias
|
|
2964
|
+
*
|
|
2965
|
+
* Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.
|
|
2966
|
+
*/
|
|
2967
|
+
export declare const mediaBatchAssets: <ThrowOnError extends boolean = false>(options: Options<MediaBatchAssetsData, ThrowOnError>) => RequestResult<MediaBatchAssetsResponses, MediaBatchAssetsErrors, ThrowOnError>;
|
|
2968
|
+
/**
|
|
2969
|
+
* Get job
|
|
2970
|
+
*
|
|
2971
|
+
* Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.
|
|
2972
|
+
*/
|
|
2973
|
+
export declare const mediaGetJob: <ThrowOnError extends boolean = false>(options: Options<MediaGetJobData, ThrowOnError>) => RequestResult<MediaGetJobResponses, MediaGetJobErrors, ThrowOnError>;
|
|
2974
|
+
/**
|
|
2975
|
+
* List events
|
|
2976
|
+
*
|
|
2977
|
+
* Read library events in sequence order for observing asset writes and understanding progress. Obtain library_id from creation or listing; continue with after_seq for asc or before_seq for desc, without combining both. Use next_cursor when supplied. Reads do not start or retry understanding.
|
|
2978
|
+
*/
|
|
2979
|
+
export declare const mediaListEvents: <ThrowOnError extends boolean = false>(options: Options<MediaListEventsData, ThrowOnError>) => RequestResult<MediaListEventsResponses, MediaListEventsErrors, ThrowOnError>;
|
|
2980
|
+
/**
|
|
2981
|
+
* Create delivery token
|
|
2982
|
+
*
|
|
2983
|
+
* Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 900 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.
|
|
2984
|
+
*/
|
|
2985
|
+
export declare const mediaCreateDeliveryToken: <ThrowOnError extends boolean = false>(options: Options<MediaCreateDeliveryTokenData, ThrowOnError>) => RequestResult<MediaCreateDeliveryTokenResponses, MediaCreateDeliveryTokenErrors, ThrowOnError>;
|
|
2986
|
+
/**
|
|
2987
|
+
* Summarize understanding failures
|
|
2988
|
+
*
|
|
2989
|
+
* Inspect current understanding failures before retrying. Use library_id from library creation or listing. Groups include code, output kind, actual producer model, retryability and up to five sample asset IDs. At most 1024 detailed groups plus two overflow groups are returned; overflow groups separate retryable and unrecoverable entries and mark overflow=true. Unknown failure codes remain retryable. Historical counts are provisional while counts_complete is false. Example: GET /media/v1/libraries/lib_example/understandings/failure_summary.
|
|
2990
|
+
*/
|
|
2991
|
+
export declare const mediaUnderstandingFailureSummary: <ThrowOnError extends boolean = false>(options: Options<MediaUnderstandingFailureSummaryData, ThrowOnError>) => RequestResult<MediaUnderstandingFailureSummaryResponses, MediaUnderstandingFailureSummaryErrors, ThrowOnError>;
|
|
2992
|
+
/**
|
|
2993
|
+
* List understanding results across a library
|
|
2994
|
+
*
|
|
2995
|
+
* Read current understanding entries across one library without fetching every asset separately. Use library_id from creation or listing. folder includes descendants; kinds is a comma-separated list of output kinds. Entries are ordered by asset_id and then understanding id. Continue with next_cursor and the same folder and kinds; limit defaults to 100 and cannot exceed 100. Superseded, deleted and old-version entries are excluded. During historical backfill, this method returns 503 CAPACITY rather than incomplete pages; poll failureSummary until counts_complete is true, then start pagination. Example: GET /media/v1/libraries/lib_example/understandings?folder=travel&kinds=caption,transcript&limit=100.
|
|
2996
|
+
*/
|
|
2997
|
+
export declare const mediaListUnderstandingsByLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaListUnderstandingsByLibraryData, ThrowOnError>) => RequestResult<MediaListUnderstandingsByLibraryResponses, MediaListUnderstandingsByLibraryErrors, ThrowOnError>;
|
|
2998
|
+
/**
|
|
2999
|
+
* Create video generation
|
|
3000
|
+
*
|
|
3001
|
+
* Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.
|
|
3002
|
+
*/
|
|
3003
|
+
export declare const mediaCreateGeneration: <ThrowOnError extends boolean = false>(options: Options<MediaCreateGenerationData, ThrowOnError>) => RequestResult<MediaCreateGenerationResponses, MediaCreateGenerationErrors, ThrowOnError>;
|
|
3004
|
+
/**
|
|
3005
|
+
* List jobs
|
|
3006
|
+
*
|
|
3007
|
+
* List batch and video-generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal, then save successful candidate outputs before they expire after 7 days.
|
|
3008
|
+
*/
|
|
3009
|
+
export declare const mediaListJobs: <ThrowOnError extends boolean = false>(options: Options<MediaListJobsData, ThrowOnError>) => RequestResult<MediaListJobsResponses, MediaListJobsErrors, ThrowOnError>;
|
|
3010
|
+
/**
|
|
3011
|
+
* Cancel job
|
|
3012
|
+
*
|
|
3013
|
+
* Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.
|
|
3014
|
+
*/
|
|
3015
|
+
export declare const mediaCancelJob: <ThrowOnError extends boolean = false>(options: Options<MediaCancelJobData, ThrowOnError>) => RequestResult<MediaCancelJobResponses, MediaCancelJobErrors, ThrowOnError>;
|
|
3016
|
+
/**
|
|
3017
|
+
* Save generation output
|
|
3018
|
+
*
|
|
3019
|
+
* Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.
|
|
3020
|
+
*/
|
|
3021
|
+
export declare const mediaSaveGenerationOutput: <ThrowOnError extends boolean = false>(options: Options<MediaSaveGenerationOutputData, ThrowOnError>) => RequestResult<MediaSaveGenerationOutputResponses, MediaSaveGenerationOutputErrors, ThrowOnError>;
|
|
3022
|
+
/**
|
|
3023
|
+
* Get generation capabilities
|
|
3024
|
+
*
|
|
3025
|
+
* Read supported text-to-video intent, default model, duration and aspect-ratio limits, per-library concurrency and candidate retention. Generation is charged per second; unsaved candidates expire after 7 days.
|
|
3026
|
+
*/
|
|
3027
|
+
export declare const mediaGetGenerationCapabilities: <ThrowOnError extends boolean = false>(options?: Options<MediaGetGenerationCapabilitiesData, ThrowOnError>) => RequestResult<MediaGetGenerationCapabilitiesResponses, MediaGetGenerationCapabilitiesErrors, ThrowOnError>;
|
|
3028
|
+
/**
|
|
3029
|
+
* List types
|
|
3030
|
+
*
|
|
3031
|
+
* Read the node and relation types registered for this organization before writing, so a create names a type the graph accepts. Each entry is one registrant's registration with its owner, version and definitions. Types cannot be created at runtime; they are registered by the owning service at deploy time, so a type missing here is not available to write.
|
|
3032
|
+
*/
|
|
3033
|
+
export declare const ontologyListTypes: <ThrowOnError extends boolean = false>(options?: Options<OntologyListTypesData, ThrowOnError>) => RequestResult<OntologyListTypesResponses, OntologyListTypesErrors, ThrowOnError>;
|
|
3034
|
+
/**
|
|
3035
|
+
* Register type
|
|
3036
|
+
*
|
|
3037
|
+
* Register a node or relation type for this organization. Not open yet — this call currently answers 501 NOT_IMPLEMENTED and writes nothing, because a registration is checked and stored by the deploy gate that ships the registering service, not by a runtime call. Until it opens, read the types already in force with praxis.ontology.types.list and create records only of those types.
|
|
3038
|
+
*/
|
|
3039
|
+
export declare const ontologyRegisterType: <ThrowOnError extends boolean = false>(options: Options<OntologyRegisterTypeData, ThrowOnError>) => RequestResult<unknown, OntologyRegisterTypeErrors, ThrowOnError>;
|
|
3040
|
+
/**
|
|
3041
|
+
* Retrieve type
|
|
3042
|
+
*
|
|
3043
|
+
* Read one registered type's definition before writing a record of it, to learn whether it is a node or an edge, which endpoints an edge type admits, and which origins it accepts. The name comes from types.list; a name that is not registered answers ONTOLOGY_TYPE_UNKNOWN, and writes of that type are refused.
|
|
3044
|
+
*/
|
|
3045
|
+
export declare const ontologyRetrieveType: <ThrowOnError extends boolean = false>(options: Options<OntologyRetrieveTypeData, ThrowOnError>) => RequestResult<OntologyRetrieveTypeResponses, OntologyRetrieveTypeErrors, ThrowOnError>;
|
|
3046
|
+
/**
|
|
3047
|
+
* List nodes
|
|
3048
|
+
*
|
|
3049
|
+
* Discover the entities in this organization's graph and obtain node ids for retrieval, updates and relations. Filter by type, by free text over names, aliases, descriptions and facts, or by owner; limit is 1–100 and defaults to 50. Omit cursor for the first page, then copy next_cursor into the next request until it is null. A node whose content belongs to somebody else comes back as a restricted entry carrying only its id, type and name.
|
|
3050
|
+
*/
|
|
3051
|
+
export declare const ontologyListNodes: <ThrowOnError extends boolean = false>(options?: Options<OntologyListNodesData, ThrowOnError>) => RequestResult<OntologyListNodesResponses, OntologyListNodesErrors, ThrowOnError>;
|
|
3052
|
+
/**
|
|
3053
|
+
* Create node
|
|
3054
|
+
*
|
|
3055
|
+
* Record one entity in the graph, for a system mirroring a record it owns. type must already be registered and ref, when given, must match that type's ref_prefix. Send an Idempotency-Key header; repeating the same key with the same content returns the first result instead of creating a second node. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.
|
|
3056
|
+
*/
|
|
3057
|
+
export declare const ontologyCreateNode: <ThrowOnError extends boolean = false>(options: Options<OntologyCreateNodeData, ThrowOnError>) => RequestResult<OntologyCreateNodeResponses, OntologyCreateNodeErrors, ThrowOnError>;
|
|
3058
|
+
/**
|
|
3059
|
+
* Retrieve node
|
|
3060
|
+
*
|
|
3061
|
+
* Read one node's content and, with expand=relations, every relation on and around it. as_of reads the node as it was at that time. A node id from another organization, or one that never existed, answers ONTOLOGY_NODE_NOT_FOUND; a node you may reach but not read returns restricted true with its name only.
|
|
3062
|
+
*/
|
|
3063
|
+
export declare const ontologyRetrieveNode: <ThrowOnError extends boolean = false>(options: Options<OntologyRetrieveNodeData, ThrowOnError>) => RequestResult<OntologyRetrieveNodeResponses, OntologyRetrieveNodeErrors, ThrowOnError>;
|
|
3064
|
+
/**
|
|
3065
|
+
* Update node
|
|
3066
|
+
*
|
|
3067
|
+
* Change a node's name, aliases or description when the mirrored record was renamed, without touching its type or identity. Send only the fields to change; omitted fields keep their current values and an explicitly null description clears it. Repeating the same edit converges on the same node, so this needs no Idempotency-Key.
|
|
3068
|
+
*/
|
|
3069
|
+
export declare const ontologyUpdateNode: <ThrowOnError extends boolean = false>(options: Options<OntologyUpdateNodeData, ThrowOnError>) => RequestResult<OntologyUpdateNodeResponses, OntologyUpdateNodeErrors, ThrowOnError>;
|
|
3070
|
+
/**
|
|
3071
|
+
* Merge node
|
|
3072
|
+
*
|
|
3073
|
+
* Fold a duplicate node into the node that should survive, when two records are discovered to be the same entity. The merged node's relations and aliases move to the survivor and later reads of the duplicate resolve to it. Send an Idempotency-Key header; repeating the same key replays the first result. Reversal is a staff operation, not available here.
|
|
3074
|
+
*/
|
|
3075
|
+
export declare const ontologyMergeNode: <ThrowOnError extends boolean = false>(options: Options<OntologyMergeNodeData, ThrowOnError>) => RequestResult<OntologyMergeNodeResponses, OntologyMergeNodeErrors, ThrowOnError>;
|
|
3076
|
+
/**
|
|
3077
|
+
* List relations
|
|
3078
|
+
*
|
|
3079
|
+
* Read the facts in the graph and obtain relation ids for retrieval, invalidation or spreading. Filter by endpoint node, by type and by direction; as_of reads the relations as they were then. Invalidated relations are omitted unless include_invalid is true. limit is 1–100 and defaults to 50; follow next_cursor until it is null.
|
|
3080
|
+
*/
|
|
3081
|
+
export declare const ontologyListRelations: <ThrowOnError extends boolean = false>(options?: Options<OntologyListRelationsData, ThrowOnError>) => RequestResult<OntologyListRelationsResponses, OntologyListRelationsErrors, ThrowOnError>;
|
|
3082
|
+
/**
|
|
3083
|
+
* Create relation
|
|
3084
|
+
*
|
|
3085
|
+
* Record one fact between two existing nodes, for a system mirroring a relationship it owns. type must be registered and must admit these endpoints; fact states the relationship in one sentence. Send an Idempotency-Key header; repeating the same key returns the first result instead of writing a second relation. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.
|
|
3086
|
+
*/
|
|
3087
|
+
export declare const ontologyCreateRelation: <ThrowOnError extends boolean = false>(options: Options<OntologyCreateRelationData, ThrowOnError>) => RequestResult<OntologyCreateRelationResponses, OntologyCreateRelationErrors, ThrowOnError>;
|
|
3088
|
+
/**
|
|
3089
|
+
* Retrieve relation
|
|
3090
|
+
*
|
|
3091
|
+
* Read one relation's fact and both of its clocks — valid_at and invalid_at for when it was true in the world, created_at and expired_at for when it was recorded and retired. An id from another organization, or one that never existed, answers ONTOLOGY_EDGE_NOT_FOUND.
|
|
3092
|
+
*/
|
|
3093
|
+
export declare const ontologyRetrieveRelation: <ThrowOnError extends boolean = false>(options: Options<OntologyRetrieveRelationData, ThrowOnError>) => RequestResult<OntologyRetrieveRelationResponses, OntologyRetrieveRelationErrors, ThrowOnError>;
|
|
3094
|
+
/**
|
|
3095
|
+
* Invalidate relation
|
|
3096
|
+
*
|
|
3097
|
+
* Mark a relation as no longer true from a world time, when the mirrored record changed. The relation is kept — invalid_at moves and the relation still reads at an earlier as_of, so history stays answerable. Send an Idempotency-Key header; repeating the same key replays the first result. There is no delete.
|
|
3098
|
+
*/
|
|
3099
|
+
export declare const ontologyInvalidateRelation: <ThrowOnError extends boolean = false>(options: Options<OntologyInvalidateRelationData, ThrowOnError>) => RequestResult<OntologyInvalidateRelationResponses, OntologyInvalidateRelationErrors, ThrowOnError>;
|
|
3100
|
+
/**
|
|
3101
|
+
* Apply changeset
|
|
3102
|
+
*
|
|
3103
|
+
* Apply a batch of node, relation and invalidation operations as one transaction, when a mirror has several records to write together and a partial write would leave the graph inconsistent. Every operation succeeds or none is applied. Send an Idempotency-Key header; the same key with the same content replays the first result, and the same key with different content is ONTOLOGY_CONFLICT.
|
|
3104
|
+
*/
|
|
3105
|
+
export declare const ontologyApplyChangeset: <ThrowOnError extends boolean = false>(options: Options<OntologyApplyChangesetData, ThrowOnError>) => RequestResult<OntologyApplyChangesetResponses, OntologyApplyChangesetErrors, ThrowOnError>;
|
|
3106
|
+
/**
|
|
3107
|
+
* Search nodes
|
|
3108
|
+
*
|
|
3109
|
+
* Resolve text to the nodes it most likely names, when a mirror holds a name and needs the node id it corresponds to. Results are ranked candidates, not an answer, each reporting whether the match came from the node's name, an alias, its description or a relation's fact. Narrow with types, and cap the result count with limit (1–50, default 20). This reads structure; it is not an agent recall — agents recall through POST /agent/v1/agents/{agent_id}/consolidations.
|
|
3110
|
+
*/
|
|
3111
|
+
export declare const ontologySearch: <ThrowOnError extends boolean = false>(options: Options<OntologySearchData, ThrowOnError>) => RequestResult<OntologySearchResponses, OntologySearchErrors, ThrowOnError>;
|
|
3112
|
+
/**
|
|
3113
|
+
* List sandboxes (v2)
|
|
3114
|
+
*
|
|
3115
|
+
* List your running and paused sandboxes with paging and filters. Use it to find a sandboxID before connecting to, pausing or killing a sandbox. Filter by state, template (id or alias), name, metadata (key=value pairs joined with &) and startedAfter; order sorts by start time (default newest first); limit is 1 to 100 (default 100). When more results exist the response carries an x-next-token header; send it back as nextToken for the next page. To read one sandbox use getSandbox.
|
|
3116
|
+
*/
|
|
3117
|
+
export declare const getSandboxV1Sandboxes: <ThrowOnError extends boolean = false>(options?: Options<GetSandboxV1SandboxesData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesResponses, GetSandboxV1SandboxesErrors, ThrowOnError>;
|
|
3118
|
+
/**
|
|
3119
|
+
* Create sandbox (v2)
|
|
3120
|
+
*
|
|
3121
|
+
* Create a sandbox from the template. All system communication with the sandbox is secured.
|
|
3122
|
+
*/
|
|
3123
|
+
export declare const postSandboxV1Sandboxes: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesResponses, PostSandboxV1SandboxesErrors, ThrowOnError>;
|
|
3124
|
+
/**
|
|
3125
|
+
* Sandbox metrics
|
|
3126
|
+
*
|
|
3127
|
+
* Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.
|
|
3128
|
+
*/
|
|
3129
|
+
export declare const getSandboxV1SandboxesBySandboxIdMetrics: <ThrowOnError extends boolean = false>(options: Options<GetSandboxV1SandboxesBySandboxIdMetricsData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesBySandboxIdMetricsResponses, GetSandboxV1SandboxesBySandboxIdMetricsErrors, ThrowOnError>;
|
|
3130
|
+
/**
|
|
3131
|
+
* Pause sandbox
|
|
3132
|
+
*
|
|
3133
|
+
* Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.
|
|
3134
|
+
*/
|
|
3135
|
+
export declare const postSandboxV1SandboxesBySandboxIdPause: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdPauseData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdPauseResponses, PostSandboxV1SandboxesBySandboxIdPauseErrors, ThrowOnError>;
|
|
3136
|
+
/**
|
|
3137
|
+
* Set sandbox timeout
|
|
3138
|
+
*
|
|
3139
|
+
* Set the timeout for the sandbox. The sandbox will expire x seconds from the time of the request. Calling this method multiple times overwrites the TTL, each time using the current timestamp as the starting point to measure the timeout duration.
|
|
3140
|
+
*/
|
|
3141
|
+
export declare const postSandboxV1SandboxesBySandboxIdTimeout: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdTimeoutData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdTimeoutResponses, PostSandboxV1SandboxesBySandboxIdTimeoutErrors, ThrowOnError>;
|
|
3142
|
+
/**
|
|
3143
|
+
* Connect sandbox (v2)
|
|
3144
|
+
*
|
|
3145
|
+
* Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.
|
|
3146
|
+
*/
|
|
3147
|
+
export declare const postSandboxV1SandboxesBySandboxIdConnect: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdConnectData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdConnectResponses, PostSandboxV1SandboxesBySandboxIdConnectErrors, ThrowOnError>;
|
|
2173
3148
|
/**
|
|
2174
3149
|
* List templates (v2)
|
|
2175
3150
|
*
|
|
2176
|
-
* List
|
|
3151
|
+
* List official templates and all your custom templates, including waiting, building, ready and error builds. Custom templates appear first; each custom row describes its latest build, not necessarily the current ready build. Use templateID for build management and a ready template name when creating a sandbox. Own-face official distinguishes public catalog entries; sourceKind is omitted until a source is submitted and on official templates. Other organizations' templates are invisible.
|
|
3152
|
+
*/
|
|
3153
|
+
export declare const listSandboxTemplates: <ThrowOnError extends boolean = false>(options?: Options<ListSandboxTemplatesData, ThrowOnError>) => RequestResult<ListSandboxTemplatesResponses, ListSandboxTemplatesErrors, ThrowOnError>;
|
|
3154
|
+
/**
|
|
3155
|
+
* Create template (v3)
|
|
3156
|
+
*
|
|
3157
|
+
* Reserve a waiting build before submitting its source. Reusing a name in your organization allocates a new build on the same template. Returns templateID and buildID; start it with templates.builds.update, then poll templates.builds.status.list. A name:tag suffix and tags are assigned after successful publication. Example: {"name":"my-template","cpuCount":2,"memoryMB":2048}. The own face also accepts diskGb, a positive integer defaulting to 10 GiB.
|
|
2177
3158
|
*/
|
|
2178
|
-
export declare const
|
|
3159
|
+
export declare const requestTemplateBuild: <ThrowOnError extends boolean = false>(options: Options<RequestTemplateBuildData, ThrowOnError>) => RequestResult<RequestTemplateBuildResponses, RequestTemplateBuildErrors, ThrowOnError>;
|
|
2179
3160
|
/**
|
|
2180
3161
|
* List team volumes
|
|
2181
3162
|
*
|
|
@@ -2236,6 +3217,54 @@ export declare const putSandboxV1SandboxesBySandboxIdNetwork: <ThrowOnError exte
|
|
|
2236
3217
|
* Read the log lines of a sandbox. Use it to debug what ran inside a sandbox. cursor is a start timestamp in milliseconds, direction chooses forward or backward from it, level sets the lowest level to return, search is a case-sensitive substring filter (at most 256 characters) and limit caps the count (at most 1000, default 1000). To continue, pass the timestamp of the last entry as the next cursor.
|
|
2237
3218
|
*/
|
|
2238
3219
|
export declare const getSandboxV1SandboxesBySandboxIdLogs: <ThrowOnError extends boolean = false>(options: Options<GetSandboxV1SandboxesBySandboxIdLogsData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesBySandboxIdLogsResponses, GetSandboxV1SandboxesBySandboxIdLogsErrors, ThrowOnError>;
|
|
3220
|
+
/**
|
|
3221
|
+
* Start template build (v2)
|
|
3222
|
+
*
|
|
3223
|
+
* Submit source for a waiting build returned by templates.create; returns 202 after queueing, not after successful publication. Unlike E2B, COPY is rejected (use RUN curl or git clone), fromTemplate accepts official catalog names only, and plaintext registry credentials are rejected. The own face also accepts dockerfile, mutually exclusive with fromImage/fromTemplate/steps, and fromImageRegistry vault references for nonofficial images. Poll templates.builds.status.list until ready or error. Example: {"fromImage":"node:22","steps":[{"type":"RUN","args":["echo hello"]}]}.
|
|
3224
|
+
*/
|
|
3225
|
+
export declare const startTemplateBuild: <ThrowOnError extends boolean = false>(options: Options<StartTemplateBuildData, ThrowOnError>) => RequestResult<StartTemplateBuildResponses, StartTemplateBuildErrors, ThrowOnError>;
|
|
3226
|
+
/**
|
|
3227
|
+
* Template build status
|
|
3228
|
+
*
|
|
3229
|
+
* Poll a build using templateID and buildID from templates.create. waiting means source has not been submitted; building includes queued work; ready permits sandbox creation; error is terminal, with reason when available. logsOffset counts previously read log entries, starting at zero; add logEntries.length after each response. limit is 0–100, default 100. level selects one log level; offsets then count entries at that level. Drain logs until an empty page, including after a terminal status.
|
|
3230
|
+
*/
|
|
3231
|
+
export declare const getTemplateBuildStatus: <ThrowOnError extends boolean = false>(options: Options<GetTemplateBuildStatusData, ThrowOnError>) => RequestResult<GetTemplateBuildStatusResponses, GetTemplateBuildStatusErrors, ThrowOnError>;
|
|
3232
|
+
/**
|
|
3233
|
+
* Delete template
|
|
3234
|
+
*
|
|
3235
|
+
* Permanently remove your template, its builds and tag assignments using templateID from templates.create. Active instances prevent deletion with 409; terminate them first. Unknown or other-organization IDs return 404. Snapshot IDs use snapshots.delete instead.
|
|
3236
|
+
*/
|
|
3237
|
+
export declare const deleteUserTemplate: <ThrowOnError extends boolean = false>(options: Options<DeleteUserTemplateData, ThrowOnError>) => RequestResult<DeleteUserTemplateResponses, DeleteUserTemplateErrors, ThrowOnError>;
|
|
3238
|
+
/**
|
|
3239
|
+
* List template builds
|
|
3240
|
+
*
|
|
3241
|
+
* Inspect your template and its newest builds using templateID from templates.create. Build states are waiting, building, ready or error. Use limit and the returned x-next-token header to page builds. Unknown or other-organization templates return 404.
|
|
3242
|
+
*/
|
|
3243
|
+
export declare const getTemplateWithBuilds: <ThrowOnError extends boolean = false>(options: Options<GetTemplateWithBuildsData, ThrowOnError>) => RequestResult<GetTemplateWithBuildsResponses, GetTemplateWithBuildsErrors, ThrowOnError>;
|
|
3244
|
+
/**
|
|
3245
|
+
* Delete template tags
|
|
3246
|
+
*
|
|
3247
|
+
* Remove the specified tag labels from your template by name, for example {"name":"my-template","tags":["stable"]}. Builds remain available. Removing default means untagged sandbox creation no longer resolves this template. Unknown or other-organization names return 404. b<number> names are reserved read-only build aliases and cannot be assigned or deleted as tags.
|
|
3248
|
+
*/
|
|
3249
|
+
export declare const deleteTemplateTags: <ThrowOnError extends boolean = false>(options: Options<DeleteTemplateTagsData, ThrowOnError>) => RequestResult<DeleteTemplateTagsResponses, DeleteTemplateTagsErrors, ThrowOnError>;
|
|
3250
|
+
/**
|
|
3251
|
+
* Assign template tags
|
|
3252
|
+
*
|
|
3253
|
+
* Assign tags to the ready build selected by target in name:tag format, for example {"target":"my-template:default","tags":["stable"]}. Names belong to your organization. Tags move an existing label to this build without rebuilding. Obtain available names from templates.list and tags from templates.tags.list. b<number> names are reserved read-only build aliases and cannot be assigned or deleted as tags. target also accepts name:b<number> to select a ready build by number, for example my-template:b1.
|
|
3254
|
+
*/
|
|
3255
|
+
export declare const assignTemplateTags: <ThrowOnError extends boolean = false>(options: Options<AssignTemplateTagsData, ThrowOnError>) => RequestResult<AssignTemplateTagsResponses, AssignTemplateTagsErrors, ThrowOnError>;
|
|
3256
|
+
/**
|
|
3257
|
+
* List template tags
|
|
3258
|
+
*
|
|
3259
|
+
* Read the tag-to-build assignments for your template using templateID from templates.create. Only ready builds acquire tags. Use a returned tag with the template name as name:tag when creating a sandbox or assigning additional tags. Foreign IDs return 404.
|
|
3260
|
+
*/
|
|
3261
|
+
export declare const listTemplateTags: <ThrowOnError extends boolean = false>(options: Options<ListTemplateTagsData, ThrowOnError>) => RequestResult<ListTemplateTagsResponses, ListTemplateTagsErrors, ThrowOnError>;
|
|
3262
|
+
/**
|
|
3263
|
+
* Check template alias
|
|
3264
|
+
*
|
|
3265
|
+
* Resolve a name within your organization to its templateID before reading or managing builds. Use the bare template name, without a :tag suffix. Unknown and other-organization names return 404. The response public field is false for your private templates.
|
|
3266
|
+
*/
|
|
3267
|
+
export declare const resolveTemplateAlias: <ThrowOnError extends boolean = false>(options: Options<ResolveTemplateAliasData, ThrowOnError>) => RequestResult<ResolveTemplateAliasResponses, ResolveTemplateAliasErrors, ThrowOnError>;
|
|
2239
3268
|
/**
|
|
2240
3269
|
* Search for data based on a query
|
|
2241
3270
|
*
|
|
@@ -2260,6 +3289,312 @@ export declare const searchCrawl: <ThrowOnError extends boolean = false>(options
|
|
|
2260
3289
|
* Tavily Map traverses websites like a graph and can explore hundreds of paths in parallel with intelligent discovery to generate comprehensive site maps.
|
|
2261
3290
|
*/
|
|
2262
3291
|
export declare const searchMap: <ThrowOnError extends boolean = false>(options: Options<SearchMapData, ThrowOnError>) => RequestResult<SearchMapResponses, SearchMapErrors, ThrowOnError>;
|
|
3292
|
+
/**
|
|
3293
|
+
* List the genres Studio can write
|
|
3294
|
+
*
|
|
3295
|
+
* List the genre catalog so you can choose how a piece is structured before creating a draft. Each genre names its unit kinds, draft properties, deterministic checks and writing rules, and by default only the genres open today are returned. Read the chosen genre in full with studioGenresGet before the first write, because its kinds and limits decide what that draft accepts.
|
|
3296
|
+
*/
|
|
3297
|
+
export declare const studioGenresList: <ThrowOnError extends boolean = false>(options?: Options<StudioGenresListData, ThrowOnError>) => RequestResult<StudioGenresListResponses, StudioGenresListErrors, ThrowOnError>;
|
|
3298
|
+
/**
|
|
3299
|
+
* Read one genre with its built-in templates
|
|
3300
|
+
*
|
|
3301
|
+
* Read the full rules of one genre: its unit kinds and what each may contain, the draft properties with their limits, the deterministic checks the software runs, the semantic review list, and the built-in templates that can seed a draft. Ask for this before creating a draft of that genre, and again when a write is refused for an unknown kind, a property limit or a block type the genre does not allow.
|
|
3302
|
+
*/
|
|
3303
|
+
export declare const studioGenresGet: <ThrowOnError extends boolean = false>(options: Options<StudioGenresGetData, ThrowOnError>) => RequestResult<StudioGenresGetResponses, StudioGenresGetErrors, ThrowOnError>;
|
|
3304
|
+
/**
|
|
3305
|
+
* List the platforms a work can be produced for
|
|
3306
|
+
*
|
|
3307
|
+
* List rendition targets with the format each needs, whether it receives a finished piece through an API, a draft box or an export, and the hard limits a piece must respect. Pass a genre to see only the platforms that genre produces by default. Read one platform in full before rendering, because its limits decide whether the rendition validates.
|
|
3308
|
+
*/
|
|
3309
|
+
export declare const studioPlatformsList: <ThrowOnError extends boolean = false>(options?: Options<StudioPlatformsListData, ThrowOnError>) => RequestResult<StudioPlatformsListResponses, StudioPlatformsListErrors, ThrowOnError>;
|
|
3310
|
+
/**
|
|
3311
|
+
* Read the rules of one platform
|
|
3312
|
+
*
|
|
3313
|
+
* Read one platform in full: the format it consumes, how it receives a finished piece, the preview fidelity the Console can offer, the limits on title, body, image count and aspect, and whether a connected channel is required. Read this before creating a rendition, and again when validation reports that the piece breaks a platform limit.
|
|
3314
|
+
*/
|
|
3315
|
+
export declare const studioPlatformsGet: <ThrowOnError extends boolean = false>(options: Options<StudioPlatformsGetData, ThrowOnError>) => RequestResult<StudioPlatformsGetResponses, StudioPlatformsGetErrors, ThrowOnError>;
|
|
3316
|
+
/**
|
|
3317
|
+
* List the works of this organization
|
|
3318
|
+
*
|
|
3319
|
+
* List works owned by the API key organization so you can find the one being discussed, with its drafts and how long ago each moved. Archived works are left out unless you ask for them. Continue with next_page_token until the answer stops carrying one; the summaries carry no unit bodies, so read a work before writing in it.
|
|
3320
|
+
*/
|
|
3321
|
+
export declare const studioWorksList: <ThrowOnError extends boolean = false>(options?: Options<StudioWorksListData, ThrowOnError>) => RequestResult<StudioWorksListResponses, StudioWorksListErrors, ThrowOnError>;
|
|
3322
|
+
/**
|
|
3323
|
+
* Create a work with its goal
|
|
3324
|
+
*
|
|
3325
|
+
* Create a work: one deliverable piece plus everything around it. Pass the goal the writing serves — the reader, what that reader should get or do, the one-sentence message and the constraints — and the original brief the person gave in their own words. A slug is derived from the title unless you pass one. The work starts with no drafts; create the first one with the drafts create call, because the genre decides the structure.
|
|
3326
|
+
*/
|
|
3327
|
+
export declare const studioWorksCreate: <ThrowOnError extends boolean = false>(options: Options<StudioWorksCreateData, ThrowOnError>) => RequestResult<StudioWorksCreateResponses, StudioWorksCreateErrors, ThrowOnError>;
|
|
3328
|
+
/**
|
|
3329
|
+
* Resolve a loose reference to a work, draft or unit
|
|
3330
|
+
*
|
|
3331
|
+
* Turn a loose reference into the address the other calls take: a slug, a work title, a draft key or a unit number, as a person or another tool would say it. A hit answers the work slug and, when the reference pointed deeper, the draft key and unit number; a miss answers an empty resolved value with up to three near matches instead of failing. Use it when a person names something instead of an id.
|
|
3332
|
+
*/
|
|
3333
|
+
export declare const studioWorksResolve: <ThrowOnError extends boolean = false>(options: Options<StudioWorksResolveData, ThrowOnError>) => RequestResult<StudioWorksResolveResponses, StudioWorksResolveErrors, ThrowOnError>;
|
|
3334
|
+
/**
|
|
3335
|
+
* Read a work, optionally with one draft and unit
|
|
3336
|
+
*
|
|
3337
|
+
* Read a work and, in the same answer, whatever part of it the page needs: pass draft to get that draft with its todos, its unit outline and its properties, and unit to get one unit with its blocks and Markdown body. This is the call that opens an editing session, because it answers the goal, the brief, the current revisions and the unit to write in one round trip.
|
|
3338
|
+
*/
|
|
3339
|
+
export declare const studioWorksGet: <ThrowOnError extends boolean = false>(options: Options<StudioWorksGetData, ThrowOnError>) => RequestResult<StudioWorksGetResponses, StudioWorksGetErrors, ThrowOnError>;
|
|
3340
|
+
/**
|
|
3341
|
+
* Change the title, goal or attached libraries
|
|
3342
|
+
*
|
|
3343
|
+
* Change work-level settings: the title, the slug, the goal, the attached reference libraries, the style or the archived flag. Send update_mask naming exactly the fields you change; a field left out keeps its value. Pass expected_revision to have the write refused when someone else changed the work first, and note that changing the message makes every draft derived from it stale.
|
|
3344
|
+
*/
|
|
3345
|
+
export declare const studioWorksUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioWorksUpdateData, ThrowOnError>) => RequestResult<StudioWorksUpdateResponses, StudioWorksUpdateErrors, ThrowOnError>;
|
|
3346
|
+
/**
|
|
3347
|
+
* Add to or correct the original brief
|
|
3348
|
+
*
|
|
3349
|
+
* Extend the original brief: append text, attach files, add points taken from an outline, edit one point, or drop a point. Points are how the software checks that every requirement landed in a written unit, so split the person's outline into points here rather than burying them in prose. The brief carries its own revision, separate from the work and from each draft.
|
|
3350
|
+
*/
|
|
3351
|
+
export declare const studioWorksUpdateBrief: <ThrowOnError extends boolean = false>(options: Options<StudioWorksUpdateBriefData, ThrowOnError>) => RequestResult<StudioWorksUpdateBriefResponses, StudioWorksUpdateBriefErrors, ThrowOnError>;
|
|
3352
|
+
/**
|
|
3353
|
+
* List the drafts a work carries
|
|
3354
|
+
*
|
|
3355
|
+
* List every draft of one work, each with its genre, its size and whether it is out of date against what it was derived from. Use it to choose the draft a later call works in: the key beside each draft is what the draft path segment takes. This list is not paged, because a work carries a handful of drafts rather than thousands.
|
|
3356
|
+
*/
|
|
3357
|
+
export declare const studioDraftsList: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsListData, ThrowOnError>) => RequestResult<StudioDraftsListResponses, StudioDraftsListErrors, ThrowOnError>;
|
|
3358
|
+
/**
|
|
3359
|
+
* Create a draft of a genre inside a work
|
|
3360
|
+
*
|
|
3361
|
+
* Create a draft: one way of delivering the work, written in one genre. The genre decides the unit kinds, the properties and the checks, so read it first with the genre call and pass its key. A template may seed the unit tree, an outline may be given instead, and derived_from records that this draft is built from the goal message or from another draft of the work. The work may hold several drafts, one per platform or per length.
|
|
3362
|
+
*/
|
|
3363
|
+
export declare const studioDraftsCreate: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsCreateData, ThrowOnError>) => RequestResult<StudioDraftsCreateResponses, StudioDraftsCreateErrors, ThrowOnError>;
|
|
3364
|
+
/**
|
|
3365
|
+
* Read one draft with optional units and todos
|
|
3366
|
+
*
|
|
3367
|
+
* Read one draft: its genre, its properties, its revisions, whether it is stale, and optionally its unit tree and its todo list. Pass expand to add the parts you need in this one call instead of reading them separately. Read this before writing to the draft, because the revision it returns is the precondition the next write has to carry.
|
|
3368
|
+
*/
|
|
3369
|
+
export declare const studioDraftsGet: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsGetData, ThrowOnError>) => RequestResult<StudioDraftsGetResponses, StudioDraftsGetErrors, ThrowOnError>;
|
|
3370
|
+
/**
|
|
3371
|
+
* Change a draft title, key, properties or style
|
|
3372
|
+
*
|
|
3373
|
+
* Change the draft itself rather than its units: its page title, its in-work key, its generic properties, the style that overrides the work style, or its mode. Send update_mask naming exactly the fields you change. Changing the key keeps the previous one resolving, so old links and old references still work; a key another draft of the work already uses answers DRAFT_KEY_TAKEN.
|
|
3374
|
+
*/
|
|
3375
|
+
export declare const studioDraftsUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsUpdateData, ThrowOnError>) => RequestResult<StudioDraftsUpdateResponses, StudioDraftsUpdateErrors, ThrowOnError>;
|
|
3376
|
+
/**
|
|
3377
|
+
* Read the whole unit outline as Markdown
|
|
3378
|
+
*
|
|
3379
|
+
* Read the draft structure as one Markdown page: one line per unit carrying its number, structure name, intent, status, length and revision, followed by the unit list itself. Use it to plan a sequence of writes without reading every unit, since it carries no body text. Read one unit in full with the unit call once you know which one to write.
|
|
3380
|
+
*/
|
|
3381
|
+
export declare const studioDraftsOutline: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsOutlineData, ThrowOnError>) => RequestResult<StudioDraftsOutlineResponses, StudioDraftsOutlineErrors, ThrowOnError>;
|
|
3382
|
+
/**
|
|
3383
|
+
* Read the computed todo list of a draft
|
|
3384
|
+
*
|
|
3385
|
+
* Read what is outstanding in one draft, computed from the data rather than from a plan: a unit without an intent, a body behind its intent, an unclaimed brief point, a failed check, a stale rendition. Each item names the layer it belongs to and suggests the call that resolves it. Follow the list instead of inventing an order, and re-read it after a batch of writes.
|
|
3386
|
+
*/
|
|
3387
|
+
export declare const studioDraftsStatus: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsStatusData, ThrowOnError>) => RequestResult<StudioDraftsStatusResponses, StudioDraftsStatusErrors, ThrowOnError>;
|
|
3388
|
+
/**
|
|
3389
|
+
* Read a review pass over the whole draft
|
|
3390
|
+
*
|
|
3391
|
+
* Read everything a reviewer needs in one answer: the deterministic check results, the semantic review list the genre asks a reader to judge, the brief coverage showing which unit claims each requirement point, and the body text. When the draft is long the body is a synopsis with an excerpt around each unit and next_page_token carries the full text. This is the call an agent makes before writing review comments.
|
|
3392
|
+
*/
|
|
3393
|
+
export declare const studioDraftsReview: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsReviewData, ThrowOnError>) => RequestResult<StudioDraftsReviewResponses, StudioDraftsReviewErrors, ThrowOnError>;
|
|
3394
|
+
/**
|
|
3395
|
+
* Confirm a draft already follows its source
|
|
3396
|
+
*
|
|
3397
|
+
* Clear the stale flag after checking that the draft still matches what it was derived from: the recorded source revision moves to the source current revision without touching any unit. Call it after the source moved and you have brought this draft up to date, not to make the flag disappear while the text is still behind. It answers the same shape as a draft write, and the draft revision does not move.
|
|
3398
|
+
*/
|
|
3399
|
+
export declare const studioDraftsRebase: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsRebaseData, ThrowOnError>) => RequestResult<StudioDraftsRebaseResponses, StudioDraftsRebaseErrors, ThrowOnError>;
|
|
3400
|
+
/**
|
|
3401
|
+
* Export the draft as Markdown or plain text
|
|
3402
|
+
*
|
|
3403
|
+
* Read the whole draft as one document in Markdown or plain text, returned synchronously in the answer. This is the quick path for a person who wants the text now; a file in a platform format, a card image or a docx comes from creating a rendition instead. Ask for text rather than markdown when the reader should not see block anchors or heading syntax.
|
|
3404
|
+
*/
|
|
3405
|
+
export declare const studioDraftsExport: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsExportData, ThrowOnError>) => RequestResult<StudioDraftsExportResponses, StudioDraftsExportErrors, ThrowOnError>;
|
|
3406
|
+
/**
|
|
3407
|
+
* Add one unit to the draft tree
|
|
3408
|
+
*
|
|
3409
|
+
* Add a unit to the structure: a chapter, a scene, a section, an argument or a product depending on the genre. Say where it goes with parent and after, give it the structure name people will use to manage it, and write the intent that says what it has to accomplish. Adding a unit changes the draft revision, so pass expected_revision, and the new unit itself starts with no body.
|
|
3410
|
+
*/
|
|
3411
|
+
export declare const studioUnitsCreate: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsCreateData, ThrowOnError>) => RequestResult<StudioUnitsCreateResponses, StudioUnitsCreateErrors, ThrowOnError>;
|
|
3412
|
+
/**
|
|
3413
|
+
* Add a whole outline of units at once
|
|
3414
|
+
*
|
|
3415
|
+
* Create many units in one write from a nested outline, which is how a structure is built after the person approved a plan. Nesting in the outline becomes the parent chain, numbers are assigned in order, and the draft gets one revision for the whole batch rather than one per unit. Sending the same outline twice would duplicate it, so pass the draft revision you read and repeat the call only after a refusal.
|
|
3416
|
+
*/
|
|
3417
|
+
export declare const studioUnitsBatchCreate: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsBatchCreateData, ThrowOnError>) => RequestResult<StudioUnitsBatchCreateResponses, StudioUnitsBatchCreateErrors, ThrowOnError>;
|
|
3418
|
+
/**
|
|
3419
|
+
* Write intents for many units in one call
|
|
3420
|
+
*
|
|
3421
|
+
* Change the intent of several units in one write: the synopsis, the points and the brief points each of them claims. Bodies are not part of this call, because a body is written one unit at a time with its own revision; here the whole batch shares the draft revision you read. Use it to lay out a plan across the tree, then write bodies one by one.
|
|
3422
|
+
*/
|
|
3423
|
+
export declare const studioUnitsBatchUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsBatchUpdateData, ThrowOnError>) => RequestResult<StudioUnitsBatchUpdateResponses, StudioUnitsBatchUpdateErrors, ThrowOnError>;
|
|
3424
|
+
/**
|
|
3425
|
+
* Read one unit with its blocks and Markdown
|
|
3426
|
+
*
|
|
3427
|
+
* Read one unit: its intent, its status, its revision, its links to reference entries, and its body as both blocks and Markdown. The Markdown carries each block identifier inline as an anchor comment, so a rewrite can keep the identifiers of the blocks it keeps. Read this before writing the body, because the revision it returns is the precondition that write has to carry.
|
|
3428
|
+
*/
|
|
3429
|
+
export declare const studioUnitsGet: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsGetData, ThrowOnError>) => RequestResult<StudioUnitsGetResponses, StudioUnitsGetErrors, ThrowOnError>;
|
|
3430
|
+
/**
|
|
3431
|
+
* Change a unit intent, body or status
|
|
3432
|
+
*
|
|
3433
|
+
* Change one unit: its name, its heading, its synopsis and points, the brief points it claims, its status, its links to reference entries, or its body as a whole Markdown text. A body write requires expected_revision, because replacing the whole text would drop blocks someone else inserted. The answer carries the unit as it now stands, so read the next field of the answer instead of re-reading the unit.
|
|
3434
|
+
*/
|
|
3435
|
+
export declare const studioUnitsUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsUpdateData, ThrowOnError>) => RequestResult<StudioUnitsUpdateResponses, StudioUnitsUpdateErrors, ThrowOnError>;
|
|
3436
|
+
/**
|
|
3437
|
+
* Move a unit to another place in the tree
|
|
3438
|
+
*
|
|
3439
|
+
* Move a unit under another parent or after another sibling, without changing its number, its identifier, its intent or its body. A move that would put a unit inside its own descendant, or that would cross into another draft, is refused. Only the moved unit changes, so the revision to pass is its own.
|
|
3440
|
+
*/
|
|
3441
|
+
export declare const studioUnitsMove: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsMoveData, ThrowOnError>) => RequestResult<StudioUnitsMoveResponses, StudioUnitsMoveErrors, ThrowOnError>;
|
|
3442
|
+
/**
|
|
3443
|
+
* Edit a unit body block by block
|
|
3444
|
+
*
|
|
3445
|
+
* Change a body by naming the blocks to insert, replace or delete instead of resending the whole text. This is the safe way for a writer that only touches part of a unit, because a block another writer changed after your revision is refused rather than overwritten. The revision is required, and the answer carries the unit with its blocks so the next edit can address them.
|
|
3446
|
+
*/
|
|
3447
|
+
export declare const studioUnitsPatchBlocks: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsPatchBlocksData, ThrowOnError>) => RequestResult<StudioUnitsPatchBlocksResponses, StudioUnitsPatchBlocksErrors, ThrowOnError>;
|
|
3448
|
+
/**
|
|
3449
|
+
* Read the context pack for writing one unit
|
|
3450
|
+
*
|
|
3451
|
+
* Read everything a writer needs before touching one unit: the genre rules, the goal, the brief, the style, the upstream source, the reference entries this unit draws on, the synopses of the units before it, and the intent of this unit, assembled in a fixed order and measured against a token budget. Entries left out say why, so a missing detail is visible rather than silent. Same input gives the same pack, which is what makes a written result reproducible.
|
|
3452
|
+
*/
|
|
3453
|
+
export declare const studioUnitsContext: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsContextData, ThrowOnError>) => RequestResult<StudioUnitsContextResponses, StudioUnitsContextErrors, ThrowOnError>;
|
|
3454
|
+
/**
|
|
3455
|
+
* List the reference libraries of this organization
|
|
3456
|
+
*
|
|
3457
|
+
* List the reference libraries this API key organization owns, each with how many entries it holds, so you can choose the one a work draws on. Continue with next_page_token until the answer stops carrying one. A library is shared across works, so the list is the whole organization's rather than one work's.
|
|
3458
|
+
*/
|
|
3459
|
+
export declare const studioCodexesList: <ThrowOnError extends boolean = false>(options?: Options<StudioCodexesListData, ThrowOnError>) => RequestResult<StudioCodexesListResponses, StudioCodexesListErrors, ThrowOnError>;
|
|
3460
|
+
/**
|
|
3461
|
+
* Create a reference library
|
|
3462
|
+
*
|
|
3463
|
+
* Create a reference library: a shared store of the people, places, products and facts a piece draws on, reusable across works. Attach it to a work with the work update call, and the entries it holds then reach the context packs of that work's units. A library is not private to one work, so the same brand facts can serve every piece that mentions them.
|
|
3464
|
+
*/
|
|
3465
|
+
export declare const studioCodexesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioCodexesCreateData, ThrowOnError>) => RequestResult<StudioCodexesCreateResponses, StudioCodexesCreateErrors, ThrowOnError>;
|
|
3466
|
+
/**
|
|
3467
|
+
* Delete a reference library
|
|
3468
|
+
*
|
|
3469
|
+
* Delete a library and every entry inside it. A library attached to any work is refused with CODEX_IN_USE, because deleting it would silently strip the reference material those units draw on; detach it from the work first. This cannot be undone, so confirm which library the identifier names.
|
|
3470
|
+
*/
|
|
3471
|
+
export declare const studioCodexesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioCodexesDeleteData, ThrowOnError>) => RequestResult<StudioCodexesDeleteResponses, StudioCodexesDeleteErrors, ThrowOnError>;
|
|
3472
|
+
/**
|
|
3473
|
+
* Read one reference library
|
|
3474
|
+
*
|
|
3475
|
+
* Read one reference library: its name, its description, its labels and how many entries it holds. Read this to confirm a library exists before attaching it to a work; the entries themselves are listed with the entry list call, because a library may hold more of them than fit in one answer.
|
|
3476
|
+
*/
|
|
3477
|
+
export declare const studioCodexesGet: <ThrowOnError extends boolean = false>(options: Options<StudioCodexesGetData, ThrowOnError>) => RequestResult<StudioCodexesGetResponses, StudioCodexesGetErrors, ThrowOnError>;
|
|
3478
|
+
/**
|
|
3479
|
+
* Rename a reference library or change its description
|
|
3480
|
+
*
|
|
3481
|
+
* Change the library itself: its name, its description or its labels. Send update_mask naming exactly the fields you change; a field left out keeps its value. The entries inside are untouched, and a work that has the library attached keeps it attached under the new name.
|
|
3482
|
+
*/
|
|
3483
|
+
export declare const studioCodexesUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioCodexesUpdateData, ThrowOnError>) => RequestResult<StudioCodexesUpdateResponses, StudioCodexesUpdateErrors, ThrowOnError>;
|
|
3484
|
+
/**
|
|
3485
|
+
* List the entries of a reference library
|
|
3486
|
+
*
|
|
3487
|
+
* List the entries of one library in pages, each with its type, its name, its aliases and whether it is always present in context. Use it to see what a work already knows before adding an entry, since a duplicate name is refused rather than merged. Continue with next_page_token until the answer stops carrying one.
|
|
3488
|
+
*/
|
|
3489
|
+
export declare const studioEntriesList: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesListData, ThrowOnError>) => RequestResult<StudioEntriesListResponses, StudioEntriesListErrors, ThrowOnError>;
|
|
3490
|
+
/**
|
|
3491
|
+
* Add an entry to a reference library
|
|
3492
|
+
*
|
|
3493
|
+
* Add one entry: a character, a place, a product, a source of facts. Give it the type the genre uses, the name the text will mention, and the description and facts that should reach a writer when it is mentioned. Aliases and excluded phrases keep detection honest, so a common word inside an idiom is not mistaken for the entry. A name already used in the library is refused.
|
|
3494
|
+
*/
|
|
3495
|
+
export declare const studioEntriesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesCreateData, ThrowOnError>) => RequestResult<StudioEntriesCreateResponses, StudioEntriesCreateErrors, ThrowOnError>;
|
|
3496
|
+
/**
|
|
3497
|
+
* Delete a reference entry
|
|
3498
|
+
*
|
|
3499
|
+
* Delete one entry from a library, which also removes the mentions and the links that pointed at it. Units that claimed it keep their text; only the reference goes away. This cannot be undone, so confirm the name of the entry before deleting it, and prefer changing its tracking setting to never when it should stop reaching writers but stay recorded.
|
|
3500
|
+
*/
|
|
3501
|
+
export declare const studioEntriesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesDeleteData, ThrowOnError>) => RequestResult<StudioEntriesDeleteResponses, StudioEntriesDeleteErrors, ThrowOnError>;
|
|
3502
|
+
/**
|
|
3503
|
+
* Read one reference entry
|
|
3504
|
+
*
|
|
3505
|
+
* Read one entry in full: its description, its fact ledger, its relations to other entries, its detection settings and its images. Read it before changing it, because an update replaces the fields it names rather than merging them. The entry is addressed by its name in this library, or by its ent_ identifier.
|
|
3506
|
+
*/
|
|
3507
|
+
export declare const studioEntriesGet: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesGetData, ThrowOnError>) => RequestResult<StudioEntriesGetResponses, StudioEntriesGetErrors, ThrowOnError>;
|
|
3508
|
+
/**
|
|
3509
|
+
* Change what a reference entry says
|
|
3510
|
+
*
|
|
3511
|
+
* Change one entry: its type, its name, its aliases, its description, its facts, its notes, its tracking setting, its images or its relations. Send update_mask naming exactly the fields you change, because a field the mask leaves out keeps its value while a list field the mask names is replaced whole. Renaming an entry changes what the text has to mention for detection to find it.
|
|
3512
|
+
*/
|
|
3513
|
+
export declare const studioEntriesUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesUpdateData, ThrowOnError>) => RequestResult<StudioEntriesUpdateResponses, StudioEntriesUpdateErrors, ThrowOnError>;
|
|
3514
|
+
/**
|
|
3515
|
+
* List the writing styles of this organization
|
|
3516
|
+
*
|
|
3517
|
+
* List the styles this API key organization owns, each with its name and description, so you can choose the voice a work should be written in. Continue with next_page_token until the answer stops carrying one. Read one style in full before attaching it, because its samples are what actually shape the writing.
|
|
3518
|
+
*/
|
|
3519
|
+
export declare const studioStylesList: <ThrowOnError extends boolean = false>(options?: Options<StudioStylesListData, ThrowOnError>) => RequestResult<StudioStylesListResponses, StudioStylesListErrors, ThrowOnError>;
|
|
3520
|
+
/**
|
|
3521
|
+
* Create a writing style
|
|
3522
|
+
*
|
|
3523
|
+
* Create a style: the voice a piece is written in, held as samples rather than as adjectives. Samples matter more than a description, so paste one to five paragraphs of writing the piece should sound like, and put the words to avoid into avoid so the banned-word check uses them. Attach a style to a work, or to one draft of it, and its samples then reach every context pack.
|
|
3524
|
+
*/
|
|
3525
|
+
export declare const studioStylesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioStylesCreateData, ThrowOnError>) => RequestResult<StudioStylesCreateResponses, StudioStylesCreateErrors, ThrowOnError>;
|
|
3526
|
+
/**
|
|
3527
|
+
* Delete a writing style
|
|
3528
|
+
*
|
|
3529
|
+
* Delete a style, which detaches it from every work and draft that used it; those units then stop receiving its samples and glossary in their context packs. This cannot be undone, so confirm the style identifier before deleting it, and read the work first when it is not certain which style it uses.
|
|
3530
|
+
*/
|
|
3531
|
+
export declare const studioStylesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioStylesDeleteData, ThrowOnError>) => RequestResult<StudioStylesDeleteResponses, StudioStylesDeleteErrors, ThrowOnError>;
|
|
3532
|
+
/**
|
|
3533
|
+
* Read one writing style
|
|
3534
|
+
*
|
|
3535
|
+
* Read one style in full: its samples, the wording to use and to avoid, and its glossary of wrong-to-right terms. Read it before attaching it to a work, since samples decide the sound of the writing far more than the description does, and a glossary term also becomes a deterministic check against the text.
|
|
3536
|
+
*/
|
|
3537
|
+
export declare const studioStylesGet: <ThrowOnError extends boolean = false>(options: Options<StudioStylesGetData, ThrowOnError>) => RequestResult<StudioStylesGetResponses, StudioStylesGetErrors, ThrowOnError>;
|
|
3538
|
+
/**
|
|
3539
|
+
* Change a writing style
|
|
3540
|
+
*
|
|
3541
|
+
* Change a style: its name, its description, its samples, its use and avoid lists, or its glossary. Send update_mask naming exactly the fields you change; a list the mask names is replaced whole. Adding a term to the glossary or to avoid also changes what the deterministic checks flag, so a work that uses this style sees new findings on its next check.
|
|
3542
|
+
*/
|
|
3543
|
+
export declare const studioStylesUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioStylesUpdateData, ThrowOnError>) => RequestResult<StudioStylesUpdateResponses, StudioStylesUpdateErrors, ThrowOnError>;
|
|
3544
|
+
/**
|
|
3545
|
+
* List the templates a genre can start from
|
|
3546
|
+
*
|
|
3547
|
+
* List templates: the built-in starting structures of each genre, followed by the ones this organization saved. Pass a genre to see only the templates that genre can use. A template is used once when a draft is created and is then detached, so changing a template never rewrites a draft that already started from it.
|
|
3548
|
+
*/
|
|
3549
|
+
export declare const studioTemplatesList: <ThrowOnError extends boolean = false>(options?: Options<StudioTemplatesListData, ThrowOnError>) => RequestResult<StudioTemplatesListResponses, StudioTemplatesListErrors, ThrowOnError>;
|
|
3550
|
+
/**
|
|
3551
|
+
* Save a starting structure as a template
|
|
3552
|
+
*
|
|
3553
|
+
* Save a unit tree as a reusable template for one genre, so the same structure can seed later drafts. Give the genre, a name, the outline of units with their intents, and optionally the writing guidance a writer should follow. Creating a template from an existing draft is a separate milestone and answers NOT_IMPLEMENTED, so build the outline here instead.
|
|
3554
|
+
*/
|
|
3555
|
+
export declare const studioTemplatesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioTemplatesCreateData, ThrowOnError>) => RequestResult<StudioTemplatesCreateResponses, StudioTemplatesCreateErrors, ThrowOnError>;
|
|
3556
|
+
/**
|
|
3557
|
+
* Delete a saved template
|
|
3558
|
+
*
|
|
3559
|
+
* Delete a template this organization saved. A built-in template belongs to the catalog and cannot be deleted, so this answers TEMPLATE_NOT_FOUND for one. Drafts that already started from the template are unaffected, because the template was detached when they were created. This cannot be undone.
|
|
3560
|
+
*/
|
|
3561
|
+
export declare const studioTemplatesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioTemplatesDeleteData, ThrowOnError>) => RequestResult<StudioTemplatesDeleteResponses, StudioTemplatesDeleteErrors, ThrowOnError>;
|
|
3562
|
+
/**
|
|
3563
|
+
* Read one template
|
|
3564
|
+
*
|
|
3565
|
+
* Read one template: its genre, the writing guidance it carries and the unit outline it seeds, with each unit's intent. Address a saved template by its identifier and a built-in one by its key, alone or with its genre prefix such as novel_long:three_act when two genres share a key. Read it before creating a draft from it, because the template decides the structure the draft starts with.
|
|
3566
|
+
*/
|
|
3567
|
+
export declare const studioTemplatesGet: <ThrowOnError extends boolean = false>(options: Options<StudioTemplatesGetData, ThrowOnError>) => RequestResult<StudioTemplatesGetResponses, StudioTemplatesGetErrors, ThrowOnError>;
|
|
3568
|
+
/**
|
|
3569
|
+
* List the rendition themes of a platform
|
|
3570
|
+
*
|
|
3571
|
+
* List themes: the layouts a rendition is produced with, for one platform or for all of them. Pass a platform to see only the themes that platform can use. A theme decides the page or card a rendition is built into, so read the chosen theme before creating a rendition rather than after the output looks wrong.
|
|
3572
|
+
*/
|
|
3573
|
+
export declare const studioThemesList: <ThrowOnError extends boolean = false>(options?: Options<StudioThemesListData, ThrowOnError>) => RequestResult<StudioThemesListResponses, StudioThemesListErrors, ThrowOnError>;
|
|
3574
|
+
/**
|
|
3575
|
+
* Create a rendition theme
|
|
3576
|
+
*
|
|
3577
|
+
* Create a theme for one platform: the HTML and CSS a written piece is rendered into, plus the fixed header and footer every rendition carries. A DOCX platform takes a reference document instead of markup, and a card theme takes its aspect, width and fonts. An agent may write a theme here, which is how a new layout appears without a release.
|
|
3578
|
+
*/
|
|
3579
|
+
export declare const studioThemesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioThemesCreateData, ThrowOnError>) => RequestResult<StudioThemesCreateResponses, StudioThemesCreateErrors, ThrowOnError>;
|
|
3580
|
+
/**
|
|
3581
|
+
* Delete a rendition theme
|
|
3582
|
+
*
|
|
3583
|
+
* Delete a theme this organization created. A built-in theme belongs to the platform and cannot be deleted, so this answers THEME_NOT_FOUND for one. Renditions already produced with the theme keep their output, because the produced file no longer depends on the theme. This cannot be undone.
|
|
3584
|
+
*/
|
|
3585
|
+
export declare const studioThemesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioThemesDeleteData, ThrowOnError>) => RequestResult<StudioThemesDeleteResponses, StudioThemesDeleteErrors, ThrowOnError>;
|
|
3586
|
+
/**
|
|
3587
|
+
* Read one rendition theme
|
|
3588
|
+
*
|
|
3589
|
+
* Read one theme in full: the HTML template and stylesheet it renders with, the header and footer it always carries, the reference document a DOCX rendition uses, or the card proportions a card rendition uses. Read it before creating a rendition with it, because a theme decides what the output looks like and a DOCX theme is a file rather than markup.
|
|
3590
|
+
*/
|
|
3591
|
+
export declare const studioThemesGet: <ThrowOnError extends boolean = false>(options: Options<StudioThemesGetData, ThrowOnError>) => RequestResult<StudioThemesGetResponses, StudioThemesGetErrors, ThrowOnError>;
|
|
3592
|
+
/**
|
|
3593
|
+
* Change a rendition theme
|
|
3594
|
+
*
|
|
3595
|
+
* Change a theme: its name, its markup, its stylesheet, or the fixed fragments around every rendition. Send update_mask naming exactly the fields you change. Changing a theme does not rewrite renditions already produced with an earlier version, because each rendition records the theme version it was built from.
|
|
3596
|
+
*/
|
|
3597
|
+
export declare const studioThemesUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioThemesUpdateData, ThrowOnError>) => RequestResult<StudioThemesUpdateResponses, StudioThemesUpdateErrors, ThrowOnError>;
|
|
2263
3598
|
/**
|
|
2264
3599
|
* List vaults
|
|
2265
3600
|
*
|
|
@@ -2269,7 +3604,7 @@ export declare const vaultListVaults: <ThrowOnError extends boolean = false>(opt
|
|
|
2269
3604
|
/**
|
|
2270
3605
|
* Create vault
|
|
2271
3606
|
*
|
|
2272
|
-
* Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations.
|
|
3607
|
+
* Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations. Agent sessions and deployments accept up to 50 vault_ids and match their credentials against the session's MCP servers, so a stored static or oauth credential does serve as vault-backed MCP authentication; only environment_variable credentials are not yet placed, because the egress proxy ADR-058 §6 gives them is not built. Application vault references are also unavailable; praxis_vault_ref version bindings and secret writes with a vault source return 501, so creating a vault does not yet enable either consumer.
|
|
2273
3608
|
*/
|
|
2274
3609
|
export declare const vaultCreateVault: <ThrowOnError extends boolean = false>(options: Options<VaultCreateVaultData, ThrowOnError>) => RequestResult<VaultCreateVaultResponses, VaultCreateVaultErrors, ThrowOnError>;
|
|
2275
3610
|
/**
|
|
@@ -2317,13 +3652,13 @@ export declare const vaultListSecrets: <ThrowOnError extends boolean = false>(op
|
|
|
2317
3652
|
/**
|
|
2318
3653
|
* Create secret
|
|
2319
3654
|
*
|
|
2320
|
-
* Store a manually supplied token in an active vault for
|
|
3655
|
+
* Store a manually supplied token in an active vault. Omit allowed_hosts for name-based resolution only; host-based redemption never matches an empty host list. Unlike Anthropic credentials, this native operation takes name and value directly, with optional allowed_hosts and creates only static secrets; use praxis.vault.authorizations.create for OAuth. Its name must be unused by any non-archived secret in that vault; the response contains metadata but never the supplied value. Application praxis_vault_ref bindings declare vault_id and secret (the secret name), but currently return 501; do not copy the value into a plain-text binding or metadata as a substitute.
|
|
2321
3656
|
*/
|
|
2322
3657
|
export declare const vaultCreateSecret: <ThrowOnError extends boolean = false>(options: Options<VaultCreateSecretData, ThrowOnError>) => RequestResult<VaultCreateSecretResponses, VaultCreateSecretErrors, ThrowOnError>;
|
|
2323
3658
|
/**
|
|
2324
3659
|
* Import secrets
|
|
2325
3660
|
*
|
|
2326
|
-
* Import lines or dotenv text into an active vault, reporting success or failure for each entry. Existing names have their values replaced; their hosts change only when that line supplies allowed_hosts. Shared hosts apply only to newly created secrets.
|
|
3661
|
+
* Import lines or dotenv text into an active vault, reporting success or failure for each entry. Existing names have their values replaced; their hosts change only when that line supplies allowed_hosts. Shared hosts apply only to newly created secrets; if neither shared nor per-line hosts are supplied, new secrets use an empty host list for name-based resolution only.
|
|
2327
3662
|
*/
|
|
2328
3663
|
export declare const vaultImportSecrets: <ThrowOnError extends boolean = false>(options: Options<VaultImportSecretsData, ThrowOnError>) => RequestResult<VaultImportSecretsResponses, VaultImportSecretsErrors, ThrowOnError>;
|
|
2329
3664
|
/**
|
|
@@ -2497,19 +3832,19 @@ export declare const ticketGetLabels: <ThrowOnError extends boolean = false>(opt
|
|
|
2497
3832
|
/**
|
|
2498
3833
|
* Create or add labels
|
|
2499
3834
|
*
|
|
2500
|
-
* Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
3835
|
+
* Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.
|
|
2501
3836
|
*/
|
|
2502
3837
|
export declare const ticketPostLabels: <ThrowOnError extends boolean = false>(options: Options<TicketPostLabelsData, ThrowOnError>) => RequestResult<TicketPostLabelsResponses, TicketPostLabelsErrors, ThrowOnError>;
|
|
2503
3838
|
/**
|
|
2504
3839
|
* Remove labels
|
|
2505
3840
|
*
|
|
2506
|
-
* Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
3841
|
+
* Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.
|
|
2507
3842
|
*/
|
|
2508
3843
|
export declare const ticketDeleteLabelsName: <ThrowOnError extends boolean = false>(options: Options<TicketDeleteLabelsNameData, ThrowOnError>) => RequestResult<TicketDeleteLabelsNameResponses, TicketDeleteLabelsNameErrors, ThrowOnError>;
|
|
2509
3844
|
/**
|
|
2510
3845
|
* Update labels
|
|
2511
3846
|
*
|
|
2512
|
-
* Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
3847
|
+
* Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.
|
|
2513
3848
|
*/
|
|
2514
3849
|
export declare const ticketPatchLabelsName: <ThrowOnError extends boolean = false>(options: Options<TicketPatchLabelsNameData, ThrowOnError>) => RequestResult<TicketPatchLabelsNameResponses, TicketPatchLabelsNameErrors, ThrowOnError>;
|
|
2515
3850
|
/**
|
|
@@ -2527,13 +3862,13 @@ export declare const ticketGetMilestones: <ThrowOnError extends boolean = false>
|
|
|
2527
3862
|
/**
|
|
2528
3863
|
* Create or add milestones
|
|
2529
3864
|
*
|
|
2530
|
-
* Create or add milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
3865
|
+
* Create or add milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.
|
|
2531
3866
|
*/
|
|
2532
3867
|
export declare const ticketPostMilestones: <ThrowOnError extends boolean = false>(options: Options<TicketPostMilestonesData, ThrowOnError>) => RequestResult<TicketPostMilestonesResponses, TicketPostMilestonesErrors, ThrowOnError>;
|
|
2533
3868
|
/**
|
|
2534
3869
|
* Remove milestones
|
|
2535
3870
|
*
|
|
2536
|
-
* Remove milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
3871
|
+
* Remove milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.
|
|
2537
3872
|
*/
|
|
2538
3873
|
export declare const ticketDeleteMilestonesNumber: <ThrowOnError extends boolean = false>(options: Options<TicketDeleteMilestonesNumberData, ThrowOnError>) => RequestResult<TicketDeleteMilestonesNumberResponses, TicketDeleteMilestonesNumberErrors, ThrowOnError>;
|
|
2539
3874
|
/**
|
|
@@ -2545,7 +3880,7 @@ export declare const ticketGetMilestonesNumber: <ThrowOnError extends boolean =
|
|
|
2545
3880
|
/**
|
|
2546
3881
|
* Update milestones
|
|
2547
3882
|
*
|
|
2548
|
-
* Update milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
3883
|
+
* Update milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.
|
|
2549
3884
|
*/
|
|
2550
3885
|
export declare const ticketPatchMilestonesNumber: <ThrowOnError extends boolean = false>(options: Options<TicketPatchMilestonesNumberData, ThrowOnError>) => RequestResult<TicketPatchMilestonesNumberResponses, TicketPatchMilestonesNumberErrors, ThrowOnError>;
|
|
2551
3886
|
/**
|