@deepraxis/sdk 0.1.1-dev.cc34a92 → 0.1.1-dev.cc84163
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 +533 -1
- package/README.md +4 -4
- package/dist/core/credentials.d.ts +12 -3
- package/dist/core/credentials.js +22 -2
- package/dist/core/errors.d.ts +6 -0
- package/dist/core/errors.js +8 -0
- package/dist/core/transport.d.ts +1 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +1253 -66
- package/dist/generated/sdk.gen.js +4254 -1052
- package/dist/generated/types.gen.d.ts +61770 -42020
- 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/operations.generated.d.ts +35 -16413
- package/dist/operations.generated.js +11342 -4540
- package/dist/resources.generated.d.ts +396 -9
- package/dist/resources.generated.js +332 -0
- 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, 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, 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, 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, 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, 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, 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, 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, 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, MediaCreateBatchData, MediaCreateBatchErrors, MediaCreateBatchResponses, MediaCreateDeliveryTokenData, MediaCreateDeliveryTokenErrors, MediaCreateDeliveryTokenResponses, 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, MetaDocsRetrieveData, MetaDocsRetrieveErrors, MetaDocsRetrieveResponses, MetaDocsSearchData, MetaDocsSearchErrors, MetaDocsSearchResponses, 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, 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, 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, BrowserGetSessionFrameData, BrowserGetSessionFrameErrors, BrowserGetSessionFrameResponses, BrowserGetSessionResponses, BrowserListContextsData, BrowserListContextsErrors, BrowserListContextsResponses, BrowserListEventsData, BrowserListEventsErrors, BrowserListEventsResponses, BrowserListSessionsData, BrowserListSessionsErrors, BrowserListSessionsResponses, BrowserLiveViewData, BrowserLiveViewErrors, BrowserRequestHandoffData, BrowserRequestHandoffErrors, BrowserRequestHandoffResponses, BrowserRunPageActionData, BrowserRunPageActionErrors, BrowserRunPageActionResponses, BrowserSeleniumUnsupportedData, BrowserSeleniumUnsupportedErrors, BrowserStreamSessionData, BrowserStreamSessionFramesData, BrowserStreamSessionFramesResponse, BrowserStreamSessionFramesResponses, 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, DevopsChangesAbandonData, DevopsChangesAbandonErrors, DevopsChangesAbandonResponses, DevopsChangesCreateData, DevopsChangesCreateErrors, DevopsChangesCreateResponses, DevopsChangesGetData, DevopsChangesGetErrors, DevopsChangesGetResponses, DevopsChangesListData, DevopsChangesListErrors, DevopsChangesListResponses, DevopsChangesMarkLastSliceData, DevopsChangesMarkLastSliceErrors, DevopsChangesMarkLastSliceResponses, DevopsEnvironmentsCheckpointsListData, DevopsEnvironmentsCheckpointsListErrors, DevopsEnvironmentsCheckpointsListResponses, DevopsEnvironmentsListData, DevopsEnvironmentsListErrors, DevopsEnvironmentsListResponses, DevopsFlagsArchiveData, DevopsFlagsArchiveErrors, DevopsFlagsArchiveResponses, DevopsFlagsConcludeData, DevopsFlagsConcludeErrors, DevopsFlagsConcludeResponses, DevopsFlagsCreateData, DevopsFlagsCreateErrors, DevopsFlagsCreateResponses, DevopsFlagsGetData, DevopsFlagsGetErrors, DevopsFlagsGetResponses, DevopsFlagsListData, DevopsFlagsListErrors, DevopsFlagsListResponses, DevopsFlagsUpdateData, DevopsFlagsUpdateEnvironmentData, DevopsFlagsUpdateEnvironmentErrors, DevopsFlagsUpdateEnvironmentResponses, DevopsFlagsUpdateErrors, DevopsFlagsUpdateResponses, DevopsProgressiveRolloutsCreateData, DevopsProgressiveRolloutsCreateErrors, DevopsProgressiveRolloutsCreateResponses, DevopsProgressiveRolloutsGetData, DevopsProgressiveRolloutsGetErrors, DevopsProgressiveRolloutsGetResponses, DevopsProgressiveRolloutsPauseData, DevopsProgressiveRolloutsPauseErrors, DevopsProgressiveRolloutsPauseResponses, DevopsProgressiveRolloutsResumeData, DevopsProgressiveRolloutsResumeErrors, DevopsProgressiveRolloutsResumeResponses, DevopsProgressiveRolloutsRollbackData, DevopsProgressiveRolloutsRollbackErrors, DevopsProgressiveRolloutsRollbackResponses, DevopsProjectsGetData, DevopsProjectsGetErrors, DevopsProjectsGetResponses, DevopsProjectsListData, DevopsProjectsListErrors, DevopsProjectsListResponses, DevopsPromotionsApproveData, DevopsPromotionsApproveErrors, DevopsPromotionsApproveResponses, DevopsPromotionsCancelData, DevopsPromotionsCancelErrors, DevopsPromotionsCancelResponses, DevopsPromotionsConcludeData, DevopsPromotionsConcludeErrors, DevopsPromotionsConcludeResponses, DevopsPromotionsCreateData, DevopsPromotionsCreateErrors, DevopsPromotionsCreateResponses, DevopsPromotionsGetData, DevopsPromotionsGetErrors, DevopsPromotionsGetResponses, DevopsPromotionsListData, DevopsPromotionsListErrors, DevopsPromotionsListResponses, DevopsPromotionsRetryData, DevopsPromotionsRetryErrors, DevopsPromotionsRetryResponses, DevopsReleasesAbandonData, DevopsReleasesAbandonErrors, DevopsReleasesAbandonResponses, DevopsReleasesCreateData, DevopsReleasesCreateErrors, DevopsReleasesCreateResponses, DevopsReleasesGetData, DevopsReleasesGetErrors, DevopsReleasesGetResponses, DevopsReleasesListData, DevopsReleasesListErrors, DevopsReleasesListResponses, DevopsRolloutsGetData, DevopsRolloutsGetErrors, DevopsRolloutsGetResponses, DevopsRolloutsListData, DevopsRolloutsListErrors, DevopsRolloutsListResponses, DevopsTargetsListData, DevopsTargetsListErrors, DevopsTargetsListResponses, DevopsTargetsRefreshData, DevopsTargetsRefreshErrors, DevopsTargetsRefreshResponses, 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, DevopsTofuStateDeleteData, DevopsTofuStateDeleteErrors, DevopsTofuStateDeleteResponses, DevopsTofuStateGetData, DevopsTofuStateGetErrors, DevopsTofuStateGetResponses, DevopsTofuStateLockData, DevopsTofuStateLockErrors, DevopsTofuStateLockResponses, DevopsTofuStateUnlockData, DevopsTofuStateUnlockErrors, DevopsTofuStateUnlockResponses, DevopsTofuStateWriteData, DevopsTofuStateWriteErrors, DevopsTofuStateWriteResponses, 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, GetSandboxEventsData, GetSandboxEventsErrors, GetSandboxEventsResponses, 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, MediaCreateLibraryData, MediaCreateLibraryErrors, MediaCreateLibraryResponses, MediaCreateSpeechData, MediaCreateSpeechErrors, MediaCreateSpeechResponses, MediaDeleteAssetData, MediaDeleteAssetErrors, MediaDeleteAssetResponses, MediaDeleteLibraryData, MediaDeleteLibraryErrors, MediaDeleteLibraryResponses, MediaEditAssetData, MediaEditAssetErrors, MediaEditAssetResponses, MediaExpressionSearchData, MediaExpressionSearchErrors, MediaExpressionSearchResponses, MediaGenerateImageData, MediaGenerateImageErrors, MediaGenerateImageResponses, MediaGenerateVideoData, MediaGenerateVideoErrors, MediaGenerateVideoResponses, MediaGetAssetData, MediaGetAssetErrors, MediaGetAssetLineageData, MediaGetAssetLineageErrors, MediaGetAssetLineageResponses, MediaGetAssetResponses, MediaGetBatchData, MediaGetBatchErrors, MediaGetBatchResponses, MediaGetDefaultLibraryData, MediaGetDefaultLibraryErrors, MediaGetDefaultLibraryResponses, 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, MediaSearchData, MediaSearchErrors, MediaSearchResponses, MediaSemanticSearchData, MediaSemanticSearchErrors, MediaSemanticSearchResponses, MediaSetDefaultLibraryData, MediaSetDefaultLibraryErrors, MediaSetDefaultLibraryResponses, 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, OntologyNeighborhoodData, OntologyNeighborhoodErrors, OntologyNeighborhoodResponses, 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, StudioDraftsUpdateBriefData, StudioDraftsUpdateBriefErrors, StudioDraftsUpdateBriefResponses, StudioDraftsUpdateData, StudioDraftsUpdateErrors, StudioDraftsUpdateResponses, StudioEntriesCreateData, StudioEntriesCreateErrors, StudioEntriesCreateResponses, StudioEntriesDeleteData, StudioEntriesDeleteErrors, StudioEntriesDeleteResponses, StudioEntriesGetData, StudioEntriesGetErrors, StudioEntriesGetResponses, StudioEntriesListData, StudioEntriesListErrors, StudioEntriesListResponses, StudioEntriesUpdateData, StudioEntriesUpdateErrors, StudioEntriesUpdateResponses, StudioForeshadowsDeleteData, StudioForeshadowsDeleteErrors, StudioForeshadowsDeleteResponses, StudioForeshadowsListData, StudioForeshadowsListErrors, StudioForeshadowsListResponses, StudioForeshadowsUpsertData, StudioForeshadowsUpsertErrors, StudioForeshadowsUpsertResponses, StudioGenresGetData, StudioGenresGetErrors, StudioGenresGetResponses, StudioGenresListData, StudioGenresListErrors, StudioGenresListResponses, StudioPlatformsGetData, StudioPlatformsGetErrors, StudioPlatformsGetResponses, StudioPlatformsListData, StudioPlatformsListErrors, StudioPlatformsListResponses, StudioProgressionsCreateData, StudioProgressionsCreateErrors, StudioProgressionsCreateResponses, StudioProgressionsDeleteData, StudioProgressionsDeleteErrors, StudioProgressionsDeleteResponses, StudioProgressionsListData, StudioProgressionsListErrors, StudioProgressionsListResponses, StudioRenditionsContentUrlData, StudioRenditionsContentUrlErrors, StudioRenditionsContentUrlResponses, StudioRenditionsCreateData, StudioRenditionsCreateErrors, StudioRenditionsCreateResponses, StudioRenditionsDeleteData, StudioRenditionsDeleteErrors, StudioRenditionsDeleteResponses, StudioRenditionsGetData, StudioRenditionsGetErrors, StudioRenditionsGetResponses, StudioRenditionsListData, StudioRenditionsListErrors, StudioRenditionsListResponses, StudioRenditionsPublishData, StudioRenditionsPublishErrors, StudioRenditionsPublishResponses, StudioRenditionsRenderData, StudioRenditionsRenderErrors, StudioRenditionsRenderResponses, StudioRenditionsUpdateData, StudioRenditionsUpdateErrors, StudioRenditionsUpdateResponses, 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, StudioWorksReviewersCreateData, StudioWorksReviewersCreateErrors, StudioWorksReviewersCreateResponses, StudioWorksReviewersDeleteData, StudioWorksReviewersDeleteErrors, StudioWorksReviewersDeleteResponses, StudioWorksReviewersListData, StudioWorksReviewersListErrors, StudioWorksReviewersListResponses, StudioWorksReviewersUpdateData, StudioWorksReviewersUpdateErrors, StudioWorksReviewersUpdateResponses, StudioWorksReviewsCancelData, StudioWorksReviewsCancelErrors, StudioWorksReviewsCancelResponses, StudioWorksReviewsCreateData, StudioWorksReviewsCreateErrors, StudioWorksReviewsCreateResponses, StudioWorksReviewSettingsRetrieveData, StudioWorksReviewSettingsRetrieveErrors, StudioWorksReviewSettingsRetrieveResponses, StudioWorksReviewSettingsUpdateData, StudioWorksReviewSettingsUpdateErrors, StudioWorksReviewSettingsUpdateResponses, StudioWorksReviewsListData, StudioWorksReviewsListErrors, StudioWorksReviewsListResponses, StudioWorksReviewsRetrieveData, StudioWorksReviewsRetrieveErrors, StudioWorksReviewsRetrieveResponses, 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, TicketPatchRepositoriesIdData, TicketPatchRepositoriesIdErrors, TicketPatchRepositoriesIdResponses, 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
|
|
@@ -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
|
*
|
|
@@ -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
|
*
|
|
@@ -365,10 +379,16 @@ export declare const browserCompleteHandoff: <ThrowOnError extends boolean = fal
|
|
|
365
379
|
* 登记运行中会话的观看者仍在线,以免无人连接时因空闲被释放。观看页面可见期间为同一观看者重复发送相同 viewerId;停止观看后停止发送,过期心跳不再计为在线。
|
|
366
380
|
*/
|
|
367
381
|
export declare const browserViewerHeartbeat: <ThrowOnError extends boolean = false>(options: Options<BrowserViewerHeartbeatData, ThrowOnError>) => RequestResult<BrowserViewerHeartbeatResponses, BrowserViewerHeartbeatErrors, ThrowOnError>;
|
|
382
|
+
/**
|
|
383
|
+
* 读取会话只读画面帧
|
|
384
|
+
*
|
|
385
|
+
* 读取会话的一张只读画面帧(JPEG 字节)。创建者可读,同组织其他成员只在该会话声明为组织可见时可读;其余情况一律返回 404 SESSION_NOT_FOUND,不提示会话是否存在。响应体没有任何可控制浏览器的凭据,且不接受任何动作参数。
|
|
386
|
+
*/
|
|
387
|
+
export declare const browserGetSessionFrame: <ThrowOnError extends boolean = false>(options: Options<BrowserGetSessionFrameData, ThrowOnError>) => RequestResult<BrowserGetSessionFrameResponses, BrowserGetSessionFrameErrors, ThrowOnError>;
|
|
368
388
|
/**
|
|
369
389
|
* 列出浏览器上下文
|
|
370
390
|
*
|
|
371
|
-
* 分页列出当前账户保存的登录态,按登录态 ID 升序排列。每项返回名称、标签及保存内容的统计信息;将 nextCursor 原样传入读取下一页,直到其为 null
|
|
391
|
+
* 分页列出当前账户保存的登录态,按登录态 ID 升序排列。每项返回名称、标签及保存内容的统计信息;将 nextCursor 原样传入读取下一页,直到其为 null。传 name 时只返回该名称的登录态;名称在当前账户内唯一,所以最多一条。
|
|
372
392
|
*/
|
|
373
393
|
export declare const browserListContexts: <ThrowOnError extends boolean = false>(options?: Options<BrowserListContextsData, ThrowOnError>) => RequestResult<BrowserListContextsResponses, BrowserListContextsErrors, ThrowOnError>;
|
|
374
394
|
/**
|
|
@@ -413,6 +433,12 @@ export declare const browserLiveView: <ThrowOnError extends boolean = false>(opt
|
|
|
413
433
|
* SSE:event 为 snapshot、session、pages、action、event 或 end,data 为对应 JSON。先发送 snapshot 快照,再推送实时变化和 ping 注释;end 后关闭。不支持按 Last-Event-ID 历史重放。
|
|
414
434
|
*/
|
|
415
435
|
export declare const browserStreamSession: <ThrowOnError extends boolean = false>(options: Options<BrowserStreamSessionData, ThrowOnError, BrowserStreamSessionResponse>) => Promise<ServerSentEventsResult<BrowserStreamSessionResponses>>;
|
|
436
|
+
/**
|
|
437
|
+
* 订阅会话只读画面
|
|
438
|
+
*
|
|
439
|
+
* SSE:只推送只读画面帧,event 为 frame 或 end,data 为帧的 JSON 或 null;帧 data 是 JPEG 的 base64 编码,ts 是浏览器产生该帧的时刻(epoch 毫秒),约每秒最多 5 帧。评论 ping 每 15 秒一次,end 后关闭。这条通道与 /sessions/{sessionId}/stream 相互独立:它的消息只含画面,绝不含 wsUrl、signingKey、connectUrl、debuggerUrl、debuggerFullscreenUrl。创建者可订阅,同组织其他成员只在该会话声明为组织可见时可订阅;其余情况一律返回 404 SESSION_NOT_FOUND。
|
|
440
|
+
*/
|
|
441
|
+
export declare const browserStreamSessionFrames: <ThrowOnError extends boolean = false>(options: Options<BrowserStreamSessionFramesData, ThrowOnError, BrowserStreamSessionFramesResponse>) => Promise<ServerSentEventsResult<BrowserStreamSessionFramesResponses>>;
|
|
416
442
|
/**
|
|
417
443
|
* 读取 Selenium 不支持提示
|
|
418
444
|
*
|
|
@@ -428,7 +454,7 @@ export declare const fileListFiles: <ThrowOnError extends boolean = false>(optio
|
|
|
428
454
|
/**
|
|
429
455
|
* Upload file
|
|
430
456
|
*
|
|
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.
|
|
457
|
+
* 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
458
|
*/
|
|
433
459
|
export declare const fileCreateFile: <ThrowOnError extends boolean = false>(options: Options<FileCreateFileData, ThrowOnError>) => RequestResult<FileCreateFileResponses, FileCreateFileErrors, ThrowOnError>;
|
|
434
460
|
/**
|
|
@@ -452,19 +478,19 @@ export declare const fileRetrieveFileContent: <ThrowOnError extends boolean = fa
|
|
|
452
478
|
/**
|
|
453
479
|
* Create an upload
|
|
454
480
|
*
|
|
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
|
|
481
|
+
* 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
482
|
*/
|
|
457
483
|
export declare const fileCreateUpload: <ThrowOnError extends boolean = false>(options: Options<FileCreateUploadData, ThrowOnError>) => RequestResult<FileCreateUploadResponses, FileCreateUploadErrors, ThrowOnError>;
|
|
458
484
|
/**
|
|
459
485
|
* Add an upload part
|
|
460
486
|
*
|
|
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.
|
|
487
|
+
* 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
488
|
*/
|
|
463
489
|
export declare const fileAddUploadPart: <ThrowOnError extends boolean = false>(options: Options<FileAddUploadPartData, ThrowOnError>) => RequestResult<FileAddUploadPartResponses, FileAddUploadPartErrors, ThrowOnError>;
|
|
464
490
|
/**
|
|
465
491
|
* Complete an upload
|
|
466
492
|
*
|
|
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.
|
|
493
|
+
* 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
494
|
*/
|
|
469
495
|
export declare const fileCompleteUpload: <ThrowOnError extends boolean = false>(options: Options<FileCompleteUploadData, ThrowOnError>) => RequestResult<FileCompleteUploadResponses, FileCompleteUploadErrors, ThrowOnError>;
|
|
470
496
|
/**
|
|
@@ -473,22 +499,28 @@ export declare const fileCompleteUpload: <ThrowOnError extends boolean = false>(
|
|
|
473
499
|
* 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
500
|
*/
|
|
475
501
|
export declare const fileCancelUpload: <ThrowOnError extends boolean = false>(options: Options<FileCancelUploadData, ThrowOnError>) => RequestResult<FileCancelUploadResponses, FileCancelUploadErrors, ThrowOnError>;
|
|
502
|
+
/**
|
|
503
|
+
* Retrieve an upload
|
|
504
|
+
*
|
|
505
|
+
* 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.
|
|
506
|
+
*/
|
|
507
|
+
export declare const fileRetrieveUpload: <ThrowOnError extends boolean = false>(options: Options<FileRetrieveUploadData, ThrowOnError>) => RequestResult<FileRetrieveUploadResponses, FileRetrieveUploadErrors, ThrowOnError>;
|
|
476
508
|
/**
|
|
477
509
|
* Create a one-time upload URL
|
|
478
510
|
*
|
|
479
|
-
* Upload a local file of up to
|
|
511
|
+
* 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"}.
|
|
480
512
|
*/
|
|
481
513
|
export declare const fileCreateSignedUpload: <ThrowOnError extends boolean = false>(options: Options<FileCreateSignedUploadData, ThrowOnError>) => RequestResult<FileCreateSignedUploadResponses, FileCreateSignedUploadErrors, ThrowOnError>;
|
|
482
514
|
/**
|
|
483
515
|
* Create a download URL
|
|
484
516
|
*
|
|
485
|
-
* 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
|
|
517
|
+
* 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}.
|
|
486
518
|
*/
|
|
487
519
|
export declare const fileCreateContentUrl: <ThrowOnError extends boolean = false>(options: Options<FileCreateContentUrlData, ThrowOnError>) => RequestResult<FileCreateContentUrlResponses, FileCreateContentUrlErrors, ThrowOnError>;
|
|
488
520
|
/**
|
|
489
521
|
* Revoke a file content link
|
|
490
522
|
*
|
|
491
|
-
* 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
|
|
523
|
+
* 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/>"}.
|
|
492
524
|
*/
|
|
493
525
|
export declare const fileRevokeContentLink: <ThrowOnError extends boolean = false>(options: Options<FileRevokeContentLinkData, ThrowOnError>) => RequestResult<FileRevokeContentLinkResponses, FileRevokeContentLinkErrors, ThrowOnError>;
|
|
494
526
|
/**
|
|
@@ -741,6 +773,12 @@ export declare const compactResponse: <ThrowOnError extends boolean = false>(opt
|
|
|
741
773
|
* 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.
|
|
742
774
|
*/
|
|
743
775
|
export declare const countResponseInputTokens: <ThrowOnError extends boolean = false>(options: Options<CountResponseInputTokensData, ThrowOnError>) => RequestResult<CountResponseInputTokensResponses, CountResponseInputTokensErrors, ThrowOnError>;
|
|
776
|
+
/**
|
|
777
|
+
* List organization members
|
|
778
|
+
*
|
|
779
|
+
* 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.
|
|
780
|
+
*/
|
|
781
|
+
export declare const listOrganizationMembers: <ThrowOnError extends boolean = false>(options?: Options<ListOrganizationMembersData, ThrowOnError>) => RequestResult<ListOrganizationMembersResponses, ListOrganizationMembersErrors, ThrowOnError>;
|
|
744
782
|
/**
|
|
745
783
|
* List your organization's feedback
|
|
746
784
|
*
|
|
@@ -2163,13 +2201,160 @@ export declare const cutUndeleteProject: <ThrowOnError extends boolean = false>(
|
|
|
2163
2201
|
/**
|
|
2164
2202
|
* Execute editing script
|
|
2165
2203
|
*
|
|
2166
|
-
* 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.
|
|
2204
|
+
* 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);`
|
|
2205
|
+
*
|
|
2206
|
+
* <!-- cut-reference:start -->
|
|
2207
|
+
* ### Script function, field and error reference
|
|
2208
|
+
*
|
|
2209
|
+
* Every script function, clip field and error code has its own section, read one at a time:
|
|
2167
2210
|
*
|
|
2168
|
-
* ```js
|
|
2169
|
-
* const t = AddTrack("video");
|
|
2170
|
-
* Insert(t, {type: "color", color: "#123456", start: 0, length: 3});
|
|
2171
|
-
* Print(t);
|
|
2172
2211
|
* ```
|
|
2212
|
+
* codemode.describe("praxis.cut.script.<Name>") // one function: signature, arguments, return, errors, example
|
|
2213
|
+
* codemode.describe("praxis.cut.fields.<name>") // one field: type, unit, range, default, where writable
|
|
2214
|
+
* codemode.describe("praxis.cut.errors.<CODE>") // one code: meaning, causes, fix
|
|
2215
|
+
* codemode.describe("praxis.cut.script") // names, one page at a time
|
|
2216
|
+
* ```
|
|
2217
|
+
*
|
|
2218
|
+
* Published at https://docs.deepraxis.com/docs/developers/cut/script-reference with one anchor per entry. Names below omit the `praxis.cut.<kind>.` prefix.
|
|
2219
|
+
*
|
|
2220
|
+
* #### Script functions (script)
|
|
2221
|
+
*
|
|
2222
|
+
* - `GetTimeline` — Duration, tracks, joins; clips are under `items`.
|
|
2223
|
+
* - `GetItem` — One clip's compact view, by id.
|
|
2224
|
+
* - `FindItems` — Visit every clip with its track; collect results.
|
|
2225
|
+
* - `GetMedia` — Media metadata; `duration` is seconds.
|
|
2226
|
+
* - `GetTranscript` — Transcript words in source microseconds.
|
|
2227
|
+
* - `GetAnalysis` — Silence, filler, scene or beat segments.
|
|
2228
|
+
* - `ListTransitions` — Join transition kinds and parameters.
|
|
2229
|
+
* - `ListEffects` — Visual-effect catalog and parameters.
|
|
2230
|
+
* - `ListAnimations` — Animation presets by phase and target.
|
|
2231
|
+
* - `ListFonts` — Font families, weights and scripts.
|
|
2232
|
+
* - `ListTextStyles` — Text style presets for `style.preset`.
|
|
2233
|
+
* - `ListTextTemplates` — Multi-layer templates and their slots.
|
|
2234
|
+
* - `Insert` — Add a clip; a track never overlaps itself.
|
|
2235
|
+
* - `Append` — Add a clip at the end of a track.
|
|
2236
|
+
* - `Update` — Change named fields; the rest stay.
|
|
2237
|
+
* - `SetSpeed` — Change rate, keeping source or duration.
|
|
2238
|
+
* - `Delete` — Remove a clip. There is no `Remove`.
|
|
2239
|
+
* - `Join` — Overlap clips; followers shift, track shortens.
|
|
2240
|
+
* - `UpdateJoin` — Change a join's length or effect.
|
|
2241
|
+
* - `DeleteJoin` — Remove a join; restore the butt cut.
|
|
2242
|
+
* - `Split` — Cut a clip in two at a time.
|
|
2243
|
+
* - `Trim` — Move one clip edge by seconds.
|
|
2244
|
+
* - `Move` — Set a clip's start or track.
|
|
2245
|
+
* - `RippleDeleteRange` — Cut a time range and close the gap.
|
|
2246
|
+
* - `AddTrack` — Add a video, audio or caption track.
|
|
2247
|
+
* - `UpdateTrack` — Change a track's name, lock, gain or role.
|
|
2248
|
+
* - `DeleteTrack` — Remove a track and its clips.
|
|
2249
|
+
* - `SetSettings` — Change canvas, frame rate or background.
|
|
2250
|
+
* - `AddCaptionsFromTranscript` — Captions from a clip's kept words.
|
|
2251
|
+
* - `InsertTemplate` — Insert a template and fill its slots.
|
|
2252
|
+
* - `AlignCaptions` — Rebuild captions from text punctuation.
|
|
2253
|
+
* - `ImportCaptions` — Import SRT or WebVTT onto captions.
|
|
2254
|
+
* - `ExportCaptions` — Export captions as SRT or WebVTT.
|
|
2255
|
+
* - `SetMarker` — Label a timeline position.
|
|
2256
|
+
* - `Print` — Append values to the result's `prints`.
|
|
2257
|
+
* - `Preview` — Up to 8 frames as inline PNG data URLs.
|
|
2258
|
+
*
|
|
2259
|
+
* #### Fields (fields)
|
|
2260
|
+
*
|
|
2261
|
+
* - `type` — Clip kind; decides which fields apply.
|
|
2262
|
+
* - `start` — Clip start in seconds; snaps to frames.
|
|
2263
|
+
* - `length` — Duration; video and audio may omit it or write "auto".
|
|
2264
|
+
* - `media` — Source `{ libraryId, assetId }`.
|
|
2265
|
+
* - `sourceIn` — First source second kept; default 0.
|
|
2266
|
+
* - `sourceOut` — Exclusive source end; read-only.
|
|
2267
|
+
* - `text` — Text of a text or caption clip.
|
|
2268
|
+
* - `color` — Solid colour of a color clip.
|
|
2269
|
+
* - `shape` — Shape clip kind: `rect` or `ellipse`.
|
|
2270
|
+
* - `width` — Shape width, a fraction of canvas width.
|
|
2271
|
+
* - `height` — Shape height, a fraction of canvas height.
|
|
2272
|
+
* - `radius` — Rect corner rounding, in 1080-height px.
|
|
2273
|
+
* - `fill` — Shape or text paint: colour or gradient.
|
|
2274
|
+
* - `stroke` — Shape outline: colour and width.
|
|
2275
|
+
* - `transform` — Position, scale, rotation, opacity, crop, blur.
|
|
2276
|
+
* - `fit` — contain, cover, fill or none.
|
|
2277
|
+
* - `blend` — Layer blend mode; null clears.
|
|
2278
|
+
* - `style` — Text styling: font, fill, strokes, glow, position.
|
|
2279
|
+
* - `style.position` — top, middle or bottom; omit it, never null.
|
|
2280
|
+
* - `playback` — Rate, direction, audio policy, or freeze.
|
|
2281
|
+
* - `volumeDb` — Audio level in dB; 0 is source level.
|
|
2282
|
+
* - `gain` — Keyframed audio level in dB.
|
|
2283
|
+
* - `fadeIn` — Fade-in seconds at the clip's start.
|
|
2284
|
+
* - `fadeOut` — Fade-out seconds at the clip's end.
|
|
2285
|
+
* - `duck` — Lower this clip while another track plays.
|
|
2286
|
+
* - `animate` — Transform keyframes; `at` is clip-relative seconds.
|
|
2287
|
+
* - `reveal` — Per-character, word or line reveal timing.
|
|
2288
|
+
* - `animation` — Preset slots `{ in, out, loop }`; null clears.
|
|
2289
|
+
* - `effects` — Effect stack, at most 8; null clears.
|
|
2290
|
+
* - `transitionIn` — Entrance effect: kind plus seconds.
|
|
2291
|
+
* - `transitionOut` — Exit effect: kind plus seconds.
|
|
2292
|
+
* - `mask` — Shape, path or track matte.
|
|
2293
|
+
* - `words` — Caption words with clip-local times.
|
|
2294
|
+
*
|
|
2295
|
+
* #### Error codes (errors)
|
|
2296
|
+
*
|
|
2297
|
+
* - `JOIN_CONFLICT` — A join is invalid or blocks this edit.
|
|
2298
|
+
* - `INVALID_TRANSITION` — Bad transition kind, parameter or length.
|
|
2299
|
+
* - `INVALID_STYLE` — A style value is out of range.
|
|
2300
|
+
* - `INVALID_MASK` — A mask definition is malformed.
|
|
2301
|
+
* - `MASK_IN_USE` — The edit would break a live mask.
|
|
2302
|
+
* - `TOO_MANY_MASKS` — At most 16 masks per project.
|
|
2303
|
+
* - `RATE_OUT_OF_RANGE` — A rate is outside 0.25-4.
|
|
2304
|
+
* - `UNSUPPORTED_PLAYBACK` — Reverse without an explicit mute.
|
|
2305
|
+
* - `INVALID_PLAYBACK` — A playback object is partial or malformed.
|
|
2306
|
+
* - `UNKNOWN_FONT` — The family is not in `ListFonts()`.
|
|
2307
|
+
* - `UNKNOWN_FIELD` — The field name is not accepted here.
|
|
2308
|
+
* - `UNKNOWN_TEXT_STYLE` — `style.preset` is not in the catalog.
|
|
2309
|
+
* - `TEXT_STYLE_TARGET_MISMATCH` — Preset on the wrong clip type.
|
|
2310
|
+
* - `CAPTION_ALIGN_LOW_CONFIDENCE` — Alignment confidence too low; nothing changed.
|
|
2311
|
+
* - `OVERLAP` — Two clips on one track would share time.
|
|
2312
|
+
* - `OUT_OF_SOURCE` — The clip would read past its source.
|
|
2313
|
+
* - `LOCKED_TRACK` — The edit targets a locked track.
|
|
2314
|
+
* - `UNBOUND_LIBRARY` — The library is not bound to the project.
|
|
2315
|
+
* - `TRACK_KIND_MISMATCH` — The clip type does not fit the track.
|
|
2316
|
+
* - `NOT_FOUND` — The named id is not in this project.
|
|
2317
|
+
* - `TOO_SHORT` — The result would be under one frame.
|
|
2318
|
+
* - `INVALID_DUCK` — Bad `duck` level or a missing track.
|
|
2319
|
+
* - `UNKNOWN_ANIMATION` — The preset is not in `ListAnimations()`.
|
|
2320
|
+
* - `INVALID_ANIMATION_PARAM` — Bad slot, parameter or keyframe limit.
|
|
2321
|
+
* - `ANIMATION_TOO_LONG` — In plus out exceed the clip length.
|
|
2322
|
+
* - `ANIMATION_TARGET_MISMATCH` — The preset does not match the clip type.
|
|
2323
|
+
* - `ANIMATION_PHASE_MISMATCH` — The preset is in the wrong slot.
|
|
2324
|
+
* - `UNKNOWN_EFFECT` — The effect is not in `ListEffects()`.
|
|
2325
|
+
* - `INVALID_EFFECT_PARAM` — Bad effect parameter or keyframe.
|
|
2326
|
+
* - `TOO_MANY_EFFECTS` — More than 8 effects on one clip.
|
|
2327
|
+
* - `PROJECT_NOT_FOUND` — No visible project has this id.
|
|
2328
|
+
* - `EXPORT_NOT_FOUND` — No such export in this project.
|
|
2329
|
+
* - `DRAFT_RENDER_NOT_FOUND` — No such draft render.
|
|
2330
|
+
* - `VERSION_NOT_FOUND` — No saved version has this revision.
|
|
2331
|
+
* - `LIBRARY_NOT_FOUND` — The library is missing or invisible.
|
|
2332
|
+
* - `BINDING_INVALID` — The binding request is malformed.
|
|
2333
|
+
* - `BINDING_IN_USE` — Clips still use this library's assets.
|
|
2334
|
+
* - `NOTHING_TO_UNDO` — No earlier revision to return to.
|
|
2335
|
+
* - `NOTHING_TO_REDO` — No undone revision is waiting.
|
|
2336
|
+
* - `UNDO_CONFLICT` — The revision to undo is no longer head.
|
|
2337
|
+
* - `REVISION_CONFLICT` — The project moved; your revision is stale.
|
|
2338
|
+
* - `CUT_BUSY` — The project is busy; retry.
|
|
2339
|
+
* - `INVALID_CAPTION_FILE` — The subtitle file is malformed or too big.
|
|
2340
|
+
* - `SCRIPT_ERROR` — The script threw or did not parse.
|
|
2341
|
+
* - `SCRIPT_LIMIT` — An execute budget was exceeded.
|
|
2342
|
+
* - `OPS_REJECTED` — An op failed; the whole edit rolled back.
|
|
2343
|
+
* - `EDIT_EXPIRED` — The saved edit id is over ten minutes old.
|
|
2344
|
+
* - `MEDIA_NOT_FOUND` — The asset id is not in that library.
|
|
2345
|
+
* - `MEDIA_OFFLINE` — The asset cannot be fetched right now.
|
|
2346
|
+
* - `MEDIA_UNAVAILABLE` — The asset is not usable for rendering.
|
|
2347
|
+
* - `MEDIA_IMPORT_FAILED` — Importing media failed.
|
|
2348
|
+
* - `FRAME_OUT_OF_RANGE` — The preview time is outside the project.
|
|
2349
|
+
* - `PROJECT_TOO_LARGE` — The project exceeds the size limit.
|
|
2350
|
+
* - `RESPONSE_TOO_LARGE` — The response would exceed its budget.
|
|
2351
|
+
* - `EXPORT_FAILED` — The render failed; read `error.cause`.
|
|
2352
|
+
* - `INVALID_PARAMS` — The request is malformed.
|
|
2353
|
+
* - `PERMISSION_DENIED` — This credential may not do that here.
|
|
2354
|
+
* - `NOT_IMPLEMENTED` — Not available on this platform yet.
|
|
2355
|
+
* - `INTERNAL` — Unexpected failure; retry with the request id.
|
|
2356
|
+
* <!-- cut-reference:end -->
|
|
2357
|
+
*
|
|
2173
2358
|
*/
|
|
2174
2359
|
export declare const cutExecute: <ThrowOnError extends boolean = false>(options: Options<CutExecuteData, ThrowOnError>) => RequestResult<CutExecuteResponses, CutExecuteErrors, ThrowOnError>;
|
|
2175
2360
|
/**
|
|
@@ -2187,13 +2372,13 @@ export declare const cutRetrieveTimeline: <ThrowOnError extends boolean = false>
|
|
|
2187
2372
|
/**
|
|
2188
2373
|
* Render preview frames
|
|
2189
2374
|
*
|
|
2190
|
-
* 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.
|
|
2375
|
+
* 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.
|
|
2191
2376
|
*/
|
|
2192
2377
|
export declare const cutListFrames: <ThrowOnError extends boolean = false>(options: Options<CutListFramesData, ThrowOnError>) => RequestResult<CutListFramesResponses, CutListFramesErrors, ThrowOnError>;
|
|
2193
2378
|
/**
|
|
2194
|
-
* Analyze project media
|
|
2379
|
+
* Analyze project media or measure the project mix
|
|
2195
2380
|
*
|
|
2196
|
-
* Request silence, filler-word or
|
|
2381
|
+
* 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.
|
|
2197
2382
|
*/
|
|
2198
2383
|
export declare const cutCreateAnalysis: <ThrowOnError extends boolean = false>(options: Options<CutCreateAnalysisData, ThrowOnError>) => RequestResult<CutCreateAnalysisResponses, CutCreateAnalysisErrors, ThrowOnError>;
|
|
2199
2384
|
/**
|
|
@@ -2232,6 +2417,18 @@ export declare const cutListExports: <ThrowOnError extends boolean = false>(opti
|
|
|
2232
2417
|
* 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.
|
|
2233
2418
|
*/
|
|
2234
2419
|
export declare const cutCreateExport: <ThrowOnError extends boolean = false>(options: Options<CutCreateExportData, ThrowOnError>) => RequestResult<CutCreateExportResponses, CutCreateExportErrors, ThrowOnError>;
|
|
2420
|
+
/**
|
|
2421
|
+
* Create draft range render
|
|
2422
|
+
*
|
|
2423
|
+
* 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.
|
|
2424
|
+
*/
|
|
2425
|
+
export declare const cutCreateRender: <ThrowOnError extends boolean = false>(options: Options<CutCreateRenderData, ThrowOnError>) => RequestResult<CutCreateRenderResponses, CutCreateRenderErrors, ThrowOnError>;
|
|
2426
|
+
/**
|
|
2427
|
+
* Retrieve draft range render
|
|
2428
|
+
*
|
|
2429
|
+
* 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.
|
|
2430
|
+
*/
|
|
2431
|
+
export declare const cutRetrieveRender: <ThrowOnError extends boolean = false>(options: Options<CutRetrieveRenderData, ThrowOnError>) => RequestResult<CutRetrieveRenderResponses, CutRetrieveRenderErrors, ThrowOnError>;
|
|
2235
2432
|
/**
|
|
2236
2433
|
* Retrieve video export
|
|
2237
2434
|
*
|
|
@@ -2390,6 +2587,366 @@ export declare const databaseUpdate: <ThrowOnError extends boolean = false>(opti
|
|
|
2390
2587
|
* 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.
|
|
2391
2588
|
*/
|
|
2392
2589
|
export declare const databaseInsert: <ThrowOnError extends boolean = false>(options: Options<DatabaseInsertData, ThrowOnError>) => RequestResult<DatabaseInsertResponses, DatabaseInsertErrors, ThrowOnError>;
|
|
2590
|
+
/**
|
|
2591
|
+
* Read a commit's test catalog
|
|
2592
|
+
*
|
|
2593
|
+
* 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.
|
|
2594
|
+
*/
|
|
2595
|
+
export declare const devopsTestCatalogGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestCatalogGetData, ThrowOnError>) => RequestResult<DevopsTestCatalogGetResponses, DevopsTestCatalogGetErrors, ThrowOnError>;
|
|
2596
|
+
/**
|
|
2597
|
+
* List test suites
|
|
2598
|
+
*
|
|
2599
|
+
* 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.
|
|
2600
|
+
*/
|
|
2601
|
+
export declare const devopsTestSuitesList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestSuitesListData, ThrowOnError>) => RequestResult<DevopsTestSuitesListResponses, DevopsTestSuitesListErrors, ThrowOnError>;
|
|
2602
|
+
/**
|
|
2603
|
+
* Retrieve a test suite
|
|
2604
|
+
*
|
|
2605
|
+
* 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.
|
|
2606
|
+
*/
|
|
2607
|
+
export declare const devopsTestSuitesGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestSuitesGetData, ThrowOnError>) => RequestResult<DevopsTestSuitesGetResponses, DevopsTestSuitesGetErrors, ThrowOnError>;
|
|
2608
|
+
/**
|
|
2609
|
+
* List test cases
|
|
2610
|
+
*
|
|
2611
|
+
* 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.
|
|
2612
|
+
*/
|
|
2613
|
+
export declare const devopsTestCasesList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestCasesListData, ThrowOnError>) => RequestResult<DevopsTestCasesListResponses, DevopsTestCasesListErrors, ThrowOnError>;
|
|
2614
|
+
/**
|
|
2615
|
+
* Retrieve a test case
|
|
2616
|
+
*
|
|
2617
|
+
* 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.
|
|
2618
|
+
*/
|
|
2619
|
+
export declare const devopsTestCasesGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestCasesGetData, ThrowOnError>) => RequestResult<DevopsTestCasesGetResponses, DevopsTestCasesGetErrors, ThrowOnError>;
|
|
2620
|
+
/**
|
|
2621
|
+
* List test plans
|
|
2622
|
+
*
|
|
2623
|
+
* 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.
|
|
2624
|
+
*/
|
|
2625
|
+
export declare const devopsTestPlansList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansListData, ThrowOnError>) => RequestResult<DevopsTestPlansListResponses, DevopsTestPlansListErrors, ThrowOnError>;
|
|
2626
|
+
/**
|
|
2627
|
+
* Create a test plan
|
|
2628
|
+
*
|
|
2629
|
+
* 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.
|
|
2630
|
+
*/
|
|
2631
|
+
export declare const devopsTestPlansCreate: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansCreateData, ThrowOnError>) => RequestResult<DevopsTestPlansCreateResponses, DevopsTestPlansCreateErrors, ThrowOnError>;
|
|
2632
|
+
/**
|
|
2633
|
+
* Delete a test plan
|
|
2634
|
+
*
|
|
2635
|
+
* 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.
|
|
2636
|
+
*/
|
|
2637
|
+
export declare const devopsTestPlansDelete: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansDeleteData, ThrowOnError>) => RequestResult<DevopsTestPlansDeleteResponses, DevopsTestPlansDeleteErrors, ThrowOnError>;
|
|
2638
|
+
/**
|
|
2639
|
+
* Retrieve a test plan
|
|
2640
|
+
*
|
|
2641
|
+
* 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.
|
|
2642
|
+
*/
|
|
2643
|
+
export declare const devopsTestPlansGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansGetData, ThrowOnError>) => RequestResult<DevopsTestPlansGetResponses, DevopsTestPlansGetErrors, ThrowOnError>;
|
|
2644
|
+
/**
|
|
2645
|
+
* Update a test plan
|
|
2646
|
+
*
|
|
2647
|
+
* 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.
|
|
2648
|
+
*/
|
|
2649
|
+
export declare const devopsTestPlansUpdate: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansUpdateData, ThrowOnError>) => RequestResult<DevopsTestPlansUpdateResponses, DevopsTestPlansUpdateErrors, ThrowOnError>;
|
|
2650
|
+
/**
|
|
2651
|
+
* Pause a test plan
|
|
2652
|
+
*
|
|
2653
|
+
* 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.
|
|
2654
|
+
*/
|
|
2655
|
+
export declare const devopsTestPlansPause: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansPauseData, ThrowOnError>) => RequestResult<DevopsTestPlansPauseResponses, DevopsTestPlansPauseErrors, ThrowOnError>;
|
|
2656
|
+
/**
|
|
2657
|
+
* Resume a test plan
|
|
2658
|
+
*
|
|
2659
|
+
* 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.
|
|
2660
|
+
*/
|
|
2661
|
+
export declare const devopsTestPlansResume: <ThrowOnError extends boolean = false>(options: Options<DevopsTestPlansResumeData, ThrowOnError>) => RequestResult<DevopsTestPlansResumeResponses, DevopsTestPlansResumeErrors, ThrowOnError>;
|
|
2662
|
+
/**
|
|
2663
|
+
* List test runs
|
|
2664
|
+
*
|
|
2665
|
+
* 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.
|
|
2666
|
+
*/
|
|
2667
|
+
export declare const devopsTestRunsList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestRunsListData, ThrowOnError>) => RequestResult<DevopsTestRunsListResponses, DevopsTestRunsListErrors, ThrowOnError>;
|
|
2668
|
+
/**
|
|
2669
|
+
* Create a test run
|
|
2670
|
+
*
|
|
2671
|
+
* 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.
|
|
2672
|
+
*/
|
|
2673
|
+
export declare const devopsTestRunsCreate: <ThrowOnError extends boolean = false>(options: Options<DevopsTestRunsCreateData, ThrowOnError>) => RequestResult<DevopsTestRunsCreateResponses, DevopsTestRunsCreateErrors, ThrowOnError>;
|
|
2674
|
+
/**
|
|
2675
|
+
* Retrieve a test run
|
|
2676
|
+
*
|
|
2677
|
+
* 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.
|
|
2678
|
+
*/
|
|
2679
|
+
export declare const devopsTestRunsGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestRunsGetData, ThrowOnError>) => RequestResult<DevopsTestRunsGetResponses, DevopsTestRunsGetErrors, ThrowOnError>;
|
|
2680
|
+
/**
|
|
2681
|
+
* Cancel a test run
|
|
2682
|
+
*
|
|
2683
|
+
* 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.
|
|
2684
|
+
*/
|
|
2685
|
+
export declare const devopsTestRunsCancel: <ThrowOnError extends boolean = false>(options: Options<DevopsTestRunsCancelData, ThrowOnError>) => RequestResult<DevopsTestRunsCancelResponses, DevopsTestRunsCancelErrors, ThrowOnError>;
|
|
2686
|
+
/**
|
|
2687
|
+
* List a run's executions
|
|
2688
|
+
*
|
|
2689
|
+
* 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.
|
|
2690
|
+
*/
|
|
2691
|
+
export declare const devopsTestExecutionsList: <ThrowOnError extends boolean = false>(options: Options<DevopsTestExecutionsListData, ThrowOnError>) => RequestResult<DevopsTestExecutionsListResponses, DevopsTestExecutionsListErrors, ThrowOnError>;
|
|
2692
|
+
/**
|
|
2693
|
+
* Retrieve one case's execution in a run
|
|
2694
|
+
*
|
|
2695
|
+
* 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.
|
|
2696
|
+
*/
|
|
2697
|
+
export declare const devopsTestExecutionsGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTestExecutionsGetData, ThrowOnError>) => RequestResult<DevopsTestExecutionsGetResponses, DevopsTestExecutionsGetErrors, ThrowOnError>;
|
|
2698
|
+
/**
|
|
2699
|
+
* Upload an external test report
|
|
2700
|
+
*
|
|
2701
|
+
* 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.
|
|
2702
|
+
*/
|
|
2703
|
+
export declare const devopsTestReportsUpload: <ThrowOnError extends boolean = false>(options: Options<DevopsTestReportsUploadData, ThrowOnError>) => RequestResult<DevopsTestReportsUploadResponses, DevopsTestReportsUploadErrors, ThrowOnError>;
|
|
2704
|
+
/**
|
|
2705
|
+
* List projects
|
|
2706
|
+
*
|
|
2707
|
+
* List the delivery projects this organization has, newest first, with each project's repository binding and settings. Call this first when you do not already hold a project id: every other operation in this domain is addressed by one. A project from another organization is never listed, so an empty page means this organization has none rather than that they are hidden. The order is by creation time descending; follow nextPageToken until it is empty to see them all.
|
|
2708
|
+
*/
|
|
2709
|
+
export declare const devopsProjectsList: <ThrowOnError extends boolean = false>(options?: Options<DevopsProjectsListData, ThrowOnError>) => RequestResult<DevopsProjectsListResponses, DevopsProjectsListErrors, ThrowOnError>;
|
|
2710
|
+
/**
|
|
2711
|
+
* Retrieve a project
|
|
2712
|
+
*
|
|
2713
|
+
* Read one project by id: its repository binding, its release schedule and its gate settings. Use it to confirm a project's configuration before releasing into it, and to learn which environment a promotion order starts from. A project that was deleted, or that belongs to another organization, answers PROJECT_NOT_FOUND — the two are indistinguishable on purpose, so the answer never tells you whether a project exists elsewhere.
|
|
2714
|
+
*/
|
|
2715
|
+
export declare const devopsProjectsGet: <ThrowOnError extends boolean = false>(options: Options<DevopsProjectsGetData, ThrowOnError>) => RequestResult<DevopsProjectsGetResponses, DevopsProjectsGetErrors, ThrowOnError>;
|
|
2716
|
+
/**
|
|
2717
|
+
* List releases
|
|
2718
|
+
*
|
|
2719
|
+
* List the project's releases, newest first. Use it to find the release a promotion should carry, or to see what has been released recently and whether any of it was abandoned. The list carries the render state and the abandoned flag, so a caller can skip a release that is still rendering or that was withdrawn without reading each one. Neither filter nor orderBy is accepted on this collection yet; a request that sends one is refused rather than silently ignored.
|
|
2720
|
+
*/
|
|
2721
|
+
export declare const devopsReleasesList: <ThrowOnError extends boolean = false>(options: Options<DevopsReleasesListData, ThrowOnError>) => RequestResult<DevopsReleasesListResponses, DevopsReleasesListErrors, ThrowOnError>;
|
|
2722
|
+
/**
|
|
2723
|
+
* Create a release
|
|
2724
|
+
*
|
|
2725
|
+
* Create a release: an immutable snapshot of what will be deployed, named and fingerprinted once so later promotions can be compared against it. Send commit to release a commit as it stands, or base plus picks to build a patch release on a release that is already in production; the two shapes are exclusive and the patch shape is refused with PATCH_NOT_ELIGIBLE when the picks do not qualify. Rendering starts immediately and the answer reports its state; a promotion refuses a release that is still rendering with RELEASE_NOT_READY rather than deploying half of it. Set validateOnly to see the plan and the refusals without writing a release, and requestId to make a retry of the same call answer the first release instead of creating a second.
|
|
2726
|
+
*/
|
|
2727
|
+
export declare const devopsReleasesCreate: <ThrowOnError extends boolean = false>(options: Options<DevopsReleasesCreateData, ThrowOnError>) => RequestResult<DevopsReleasesCreateResponses, DevopsReleasesCreateErrors, ThrowOnError>;
|
|
2728
|
+
/**
|
|
2729
|
+
* Retrieve a release
|
|
2730
|
+
*
|
|
2731
|
+
* Read one release in full: the commit it carries, the targets and source digests it was rendered from, which environments have verified it, and where it currently runs. Call it before promoting to confirm the release is not abandoned and that its render succeeded, and after deploying to learn which environments already hold it so the same release is not promoted twice. A release from another organization answers RELEASE_NOT_FOUND, which is also the answer for one that never existed.
|
|
2732
|
+
*/
|
|
2733
|
+
export declare const devopsReleasesGet: <ThrowOnError extends boolean = false>(options: Options<DevopsReleasesGetData, ThrowOnError>) => RequestResult<DevopsReleasesGetResponses, DevopsReleasesGetErrors, ThrowOnError>;
|
|
2734
|
+
/**
|
|
2735
|
+
* Abandon a release
|
|
2736
|
+
*
|
|
2737
|
+
* Withdraw a release so it can no longer be promoted: a later promotion of it is refused with RELEASE_ABANDONED. Use it when a release was created by mistake or has been superseded, and record why in reason — the reason is stored on the release as the attribution of the act. A release with a promotion still in flight cannot be abandoned, because the queue is mid-flight on it; cancel that promotion first, which is the door for stopping a deployment. Abandoning is one-way: a withdrawn release is never un-abandoned, and a new release is created instead.
|
|
2738
|
+
*/
|
|
2739
|
+
export declare const devopsReleasesAbandon: <ThrowOnError extends boolean = false>(options: Options<DevopsReleasesAbandonData, ThrowOnError>) => RequestResult<DevopsReleasesAbandonResponses, DevopsReleasesAbandonErrors, ThrowOnError>;
|
|
2740
|
+
/**
|
|
2741
|
+
* Create a promotion
|
|
2742
|
+
*
|
|
2743
|
+
* Promote a release into one environment: this is the operation that actually schedules a deployment. Name the release and the environment; path is regular for an ordinary promotion, patch to carry a patch release, targeted to deploy only the targets you list, and rollback to return the environment to an earlier release. The service reads the environment's promotion order and refuses when an upstream environment has not verified this release yet, unless a bypass carries the authorization for that gate. An environment takes one promotion at a time, so a create while another is running is queued behind it rather than refused. Set validateOnly to read the plan and its refusals — layers, skipped targets, pending migrations, missing configuration keys — without scheduling anything, which is the safe way to find out what a promotion will do.
|
|
2744
|
+
*/
|
|
2745
|
+
export declare const devopsPromotionsCreate: <ThrowOnError extends boolean = false>(options: Options<DevopsPromotionsCreateData, ThrowOnError>) => RequestResult<DevopsPromotionsCreateResponses, DevopsPromotionsCreateErrors, ThrowOnError>;
|
|
2746
|
+
/**
|
|
2747
|
+
* List promotions
|
|
2748
|
+
*
|
|
2749
|
+
* List the project's promotions, newest first, across every environment. Use it to see what is queued, what is observing, and what finished recently, without reading each environment separately. A promotion in a terminal state stays in this list, which is how a caller tells "never promoted" apart from "promoted and then rolled back". Neither filter nor orderBy is accepted yet, so page through with pageToken instead of narrowing the query.
|
|
2750
|
+
*/
|
|
2751
|
+
export declare const devopsPromotionsList: <ThrowOnError extends boolean = false>(options: Options<DevopsPromotionsListData, ThrowOnError>) => RequestResult<DevopsPromotionsListResponses, DevopsPromotionsListErrors, ThrowOnError>;
|
|
2752
|
+
/**
|
|
2753
|
+
* Retrieve a promotion
|
|
2754
|
+
*
|
|
2755
|
+
* Read one promotion: its state, its approval, its plan, and the failure that stopped it when there is one. Poll this after creating a promotion to follow it to a terminal state, or read it to find out why a deployment stopped — failure.cause tells plan refusal apart from a failed deploy, and executor names the runs involved. Pass expand=rollouts to receive the per-target rollouts in the same answer instead of listing them separately. state observing means the environment is deployed and the observation window is running, so the promotion is not finished and conclude is still to come.
|
|
2756
|
+
*/
|
|
2757
|
+
export declare const devopsPromotionsGet: <ThrowOnError extends boolean = false>(options: Options<DevopsPromotionsGetData, ThrowOnError>) => RequestResult<DevopsPromotionsGetResponses, DevopsPromotionsGetErrors, ThrowOnError>;
|
|
2758
|
+
/**
|
|
2759
|
+
* Approve or reject a promotion
|
|
2760
|
+
*
|
|
2761
|
+
* Answer the approval an environment asked for: send approved true to let the promotion proceed, false to reject it and end it in approval_rejected. This is the environment-level gate an environment with requireApproval raises, not the per-rollout approval. Comment records the reasoning next to the decision, which is what a later reader sees instead of the bare verdict. The call is refused with PROMOTION_NOT_AWAITING_APPROVAL when the promotion is not waiting for one, so a stale approval cannot restart something that already finished. Approving is attributed to the credential that sends it.
|
|
2762
|
+
*/
|
|
2763
|
+
export declare const devopsPromotionsApprove: <ThrowOnError extends boolean = false>(options: Options<DevopsPromotionsApproveData, ThrowOnError>) => RequestResult<DevopsPromotionsApproveResponses, DevopsPromotionsApproveErrors, ThrowOnError>;
|
|
2764
|
+
/**
|
|
2765
|
+
* Cancel a promotion
|
|
2766
|
+
*
|
|
2767
|
+
* Stop a promotion that has not finished, moving it through cancelling to cancelled and stopping the deploys it had scheduled. Use it to halt a deployment that is failing or that should no longer continue; reason is recorded as the attribution of the stop. Cancelling does not undo what already deployed: an environment whose targets were written keeps those targets, and returning them to an earlier release is a separate rollback promotion. A promotion that already reached a terminal state is refused with PROMOTION_ALREADY_FINISHED rather than silently ignored.
|
|
2768
|
+
*/
|
|
2769
|
+
export declare const devopsPromotionsCancel: <ThrowOnError extends boolean = false>(options: Options<DevopsPromotionsCancelData, ThrowOnError>) => RequestResult<DevopsPromotionsCancelResponses, DevopsPromotionsCancelErrors, ThrowOnError>;
|
|
2770
|
+
/**
|
|
2771
|
+
* Retry a promotion
|
|
2772
|
+
*
|
|
2773
|
+
* Continue a promotion that stopped part-way, such as one in halted where some targets succeeded and others failed. The retry re-runs the targets that did not succeed and leaves the ones that did alone, so a partially deployed environment is completed rather than redeployed from the start. A promotion that is still running is refused, and so is one that already reached a terminal state; read the promotion first and retry only a halted or errored one. The retry is attributed to the credential that sends it and is recorded on the promotion.
|
|
2774
|
+
*/
|
|
2775
|
+
export declare const devopsPromotionsRetry: <ThrowOnError extends boolean = false>(options: Options<DevopsPromotionsRetryData, ThrowOnError>) => RequestResult<DevopsPromotionsRetryResponses, DevopsPromotionsRetryErrors, ThrowOnError>;
|
|
2776
|
+
/**
|
|
2777
|
+
* Conclude an observation
|
|
2778
|
+
*
|
|
2779
|
+
* Record the verdict on a promotion that is observing: send keep to accept the deployment as the environment's new state, or rollback to return the environment to the release it held before. This is the decision the observation window exists for, so a promotion in observing state stays open until it is concluded; reason is stored as the attribution. Concluding with rollback schedules the return, it does not merely label the promotion. A promotion that is not observing is refused with PROMOTION_NOT_OBSERVING, which is how a caller tells "already concluded" apart from a call that had no effect.
|
|
2780
|
+
*/
|
|
2781
|
+
export declare const devopsPromotionsConclude: <ThrowOnError extends boolean = false>(options: Options<DevopsPromotionsConcludeData, ThrowOnError>) => RequestResult<DevopsPromotionsConcludeResponses, DevopsPromotionsConcludeErrors, ThrowOnError>;
|
|
2782
|
+
/**
|
|
2783
|
+
* List a promotion's rollouts
|
|
2784
|
+
*
|
|
2785
|
+
* List the per-target rollouts of one promotion: which target each is deploying, which layer it waits on, and where in its phases it has got to. Call it when a promotion is halted or failed to find the target that stopped, since the promotion's own state summarises what the rollouts show one by one. A promotion with nothing to deploy answers an empty page rather than a refusal. Neither filter nor orderBy is accepted here, and the rollouts come in the order the plan laid them out.
|
|
2786
|
+
*/
|
|
2787
|
+
export declare const devopsRolloutsList: <ThrowOnError extends boolean = false>(options: Options<DevopsRolloutsListData, ThrowOnError>) => RequestResult<DevopsRolloutsListResponses, DevopsRolloutsListErrors, ThrowOnError>;
|
|
2788
|
+
/**
|
|
2789
|
+
* Retrieve a rollout
|
|
2790
|
+
*
|
|
2791
|
+
* Read one rollout in full: its phases and the jobs inside them, each job's most recent attempt, the checkpoint it was deploying from, and why it failed when it did. This is the level that names the failing step — a promotion tells you that a target failed, a rollout tells you which job run did and what it reported. Use logFileId or a job run's eventLogPath to reach the logs that step produced. A rollout from another organization answers ROLLOUT_NOT_FOUND, the same answer as one that never existed.
|
|
2792
|
+
*/
|
|
2793
|
+
export declare const devopsRolloutsGet: <ThrowOnError extends boolean = false>(options: Options<DevopsRolloutsGetData, ThrowOnError>) => RequestResult<DevopsRolloutsGetResponses, DevopsRolloutsGetErrors, ThrowOnError>;
|
|
2794
|
+
/**
|
|
2795
|
+
* List environments
|
|
2796
|
+
*
|
|
2797
|
+
* List the project's environments in promotion order: development first, production last. order is the promotion sequence, so the environment before the one you are promoting into is the one that must have verified the release first. Each entry carries its tier, whether it requires approval, and whether its queue is idle or busy; a busy queue names the promotion holding it and how many wait behind. This collection is not paged: a project has few environments and the whole ordered list is the answer.
|
|
2798
|
+
*/
|
|
2799
|
+
export declare const devopsEnvironmentsList: <ThrowOnError extends boolean = false>(options: Options<DevopsEnvironmentsListData, ThrowOnError>) => RequestResult<DevopsEnvironmentsListResponses, DevopsEnvironmentsListErrors, ThrowOnError>;
|
|
2800
|
+
/**
|
|
2801
|
+
* List environment checkpoints
|
|
2802
|
+
*
|
|
2803
|
+
* List where each target of an environment currently stands: the release and commit deployed to it, the promotion that put it there, and how far behind the default branch that commit is. Read it to answer "what is running in production right now" and to tell a promotion that will change something apart from one that will skip every target as unchanged. behindMain counts commits on the default branch that the deployed commit does not have, so zero means the environment carries the current branch head. Targets that were never deployed to have no checkpoints until something deploys to them.
|
|
2804
|
+
*/
|
|
2805
|
+
export declare const devopsEnvironmentsCheckpointsList: <ThrowOnError extends boolean = false>(options: Options<DevopsEnvironmentsCheckpointsListData, ThrowOnError>) => RequestResult<DevopsEnvironmentsCheckpointsListResponses, DevopsEnvironmentsCheckpointsListErrors, ThrowOnError>;
|
|
2806
|
+
/**
|
|
2807
|
+
* List targets
|
|
2808
|
+
*
|
|
2809
|
+
* List what the project deploys — one target per deployable path in the repository, with its kind, its destination and the targets it depends on. Targets are discovered from the code, not entered by hand, so this list is the service's reading of the repository rather than a configuration you maintain here. A project whose catalog has never been read has it read on the first call, at the default branch's head, so the first answer is already the catalog instead of an empty page. Archived targets, which the repository no longer deploys, are left out.
|
|
2810
|
+
*/
|
|
2811
|
+
export declare const devopsTargetsList: <ThrowOnError extends boolean = false>(options: Options<DevopsTargetsListData, ThrowOnError>) => RequestResult<DevopsTargetsListResponses, DevopsTargetsListErrors, ThrowOnError>;
|
|
2812
|
+
/**
|
|
2813
|
+
* Refresh the target catalog
|
|
2814
|
+
*
|
|
2815
|
+
* Re-read the repository at a commit and answer the deployment targets it implies, recording what was found. Call it after adding or removing a deployable service so later promotions see the current layout; omit commit to read the default branch's head, or name one to read that commit. The answer includes the dependency graph and any cycles in it, and a cycle is reported rather than refused, matching how the deploy pipeline treats one. This is a read of the repository that also remembers what it read, so it is safe to call again; nothing is deployed by it.
|
|
2816
|
+
*/
|
|
2817
|
+
export declare const devopsTargetsRefresh: <ThrowOnError extends boolean = false>(options: Options<DevopsTargetsRefreshData, ThrowOnError>) => RequestResult<DevopsTargetsRefreshResponses, DevopsTargetsRefreshErrors, ThrowOnError>;
|
|
2818
|
+
/**
|
|
2819
|
+
* List flags
|
|
2820
|
+
*
|
|
2821
|
+
* List the project's flags with their per-environment configuration, newest first. Use it to find a flag by key when code names one, and to review the flags of a project — the entries carry lifecycle, staleness, the observation deadline and the removal ticket, which is what an expiry review reads. filter accepts exactly one term, lifecycle=archived, to list the archived flags instead of the live ones; any other filter or orderBy is refused rather than ignored. totalSize is answered on the first page only.
|
|
2822
|
+
*/
|
|
2823
|
+
export declare const devopsFlagsList: <ThrowOnError extends boolean = false>(options: Options<DevopsFlagsListData, ThrowOnError>) => RequestResult<DevopsFlagsListResponses, DevopsFlagsListErrors, ThrowOnError>;
|
|
2824
|
+
/**
|
|
2825
|
+
* Create a flag
|
|
2826
|
+
*
|
|
2827
|
+
* Create a feature flag in a project: its key, what kind of flag it is, the values it can serve, and which variation is served when it is off. The key is what code names, so it is unique per project and a key already in use is refused with FLAG_KEY_TAKEN rather than reused — an archived flag keeps its key. owner, observeUntil and removalTicket carry the flag's lifecycle: a release or experiment flag expects an observation deadline and the ticket that removes it, and a flag missing them is refused with FLAG_LIFECYCLE_INCOMPLETE. A new flag starts with every environment off, so creating one changes no runtime behaviour; turn an environment on with the environment update.
|
|
2828
|
+
*/
|
|
2829
|
+
export declare const devopsFlagsCreate: <ThrowOnError extends boolean = false>(options: Options<DevopsFlagsCreateData, ThrowOnError>) => RequestResult<DevopsFlagsCreateResponses, DevopsFlagsCreateErrors, ThrowOnError>;
|
|
2830
|
+
/**
|
|
2831
|
+
* Retrieve a flag
|
|
2832
|
+
*
|
|
2833
|
+
* Read one flag in full: every environment's configuration, the rules and rollouts each environment serves, the flag's lifecycle, and where code references its key as of the last scan. Call it before changing an environment so you can send the version you read, and after a release to confirm the flag reached the state you expected. An archived flag is still readable here — that is how its key and history stay answerable after it stopped evaluating. codeRefs.count tells you how much code still names the key, which is what decides whether removing the flag is safe.
|
|
2834
|
+
*/
|
|
2835
|
+
export declare const devopsFlagsGet: <ThrowOnError extends boolean = false>(options: Options<DevopsFlagsGetData, ThrowOnError>) => RequestResult<DevopsFlagsGetResponses, DevopsFlagsGetErrors, ThrowOnError>;
|
|
2836
|
+
/**
|
|
2837
|
+
* Update a flag
|
|
2838
|
+
*
|
|
2839
|
+
* Change a flag's metadata — its name, description, owner, observation deadline, removal ticket or tags — without touching what any environment serves. Send the fields to change inside flag and name them in updateMask; a field present in flag but absent from the mask is left alone, and a mask naming a field this operation cannot change is refused rather than ignored. Sending null clears a nullable field such as observeUntil. Served values are not changed here: use the environment update for what an environment serves, which is versioned and checked. An archived flag cannot be updated.
|
|
2840
|
+
*/
|
|
2841
|
+
export declare const devopsFlagsUpdate: <ThrowOnError extends boolean = false>(options: Options<DevopsFlagsUpdateData, ThrowOnError>) => RequestResult<DevopsFlagsUpdateResponses, DevopsFlagsUpdateErrors, ThrowOnError>;
|
|
2842
|
+
/**
|
|
2843
|
+
* Update a flag's environment
|
|
2844
|
+
*
|
|
2845
|
+
* Change what one environment of a flag serves: whether it is on, its targeting rules, its prerequisite flags, its individually targeted keys, its fallthrough, and the progressive rollout it runs. This is the write that changes runtime behaviour, so it is versioned: send the version you read and a change based on a stale version is refused with FLAG_VERSION_CONFLICT instead of silently overwriting someone else's edit. comment records why the configuration changed, next to the change itself. Targets whose keys are not deployed yet are refused with FLAG_CODE_NOT_DEPLOYED, because serving a variation the running code cannot name would fail at evaluation time.
|
|
2846
|
+
*/
|
|
2847
|
+
export declare const devopsFlagsUpdateEnvironment: <ThrowOnError extends boolean = false>(options: Options<DevopsFlagsUpdateEnvironmentData, ThrowOnError>) => RequestResult<DevopsFlagsUpdateEnvironmentResponses, DevopsFlagsUpdateEnvironmentErrors, ThrowOnError>;
|
|
2848
|
+
/**
|
|
2849
|
+
* Conclude a flag
|
|
2850
|
+
*
|
|
2851
|
+
* Record the decision a temporary flag's observation window ended with: promote makes the chosen variation the permanent behaviour and moves the flag to launched, rollback returns the environment to its off behaviour, and extend keeps observing with a new observeUntil deadline. reason is stored as the attribution of the decision. This is the act the observation flag machinery requires when the deadline arrives, so an expired flag is concluded rather than left standing. A promote or rollback finishes the flag's rollout; the code and the flag are then removed by the ticket the flag recorded, which this call does not do.
|
|
2852
|
+
*/
|
|
2853
|
+
export declare const devopsFlagsConclude: <ThrowOnError extends boolean = false>(options: Options<DevopsFlagsConcludeData, ThrowOnError>) => RequestResult<DevopsFlagsConcludeResponses, DevopsFlagsConcludeErrors, ThrowOnError>;
|
|
2854
|
+
/**
|
|
2855
|
+
* Archive a flag
|
|
2856
|
+
*
|
|
2857
|
+
* Archive a flag once it is no longer needed: it stops evaluating in every environment, leaves the ordinary flag list, and keeps its key and history. Use it for a flag whose code has been removed and whose key nothing names any more; codeRefs.count on the flag is what tells you whether that is true. Archiving is the terminal lifecycle state — an archived flag is never un-archived and its key is never reused, so a flag that may come back is turned off in its environment instead. The key stays reserved, which is why a later create with the same key is refused.
|
|
2858
|
+
*/
|
|
2859
|
+
export declare const devopsFlagsArchive: <ThrowOnError extends boolean = false>(options: Options<DevopsFlagsArchiveData, ThrowOnError>) => RequestResult<DevopsFlagsArchiveResponses, DevopsFlagsArchiveErrors, ThrowOnError>;
|
|
2860
|
+
/**
|
|
2861
|
+
* Create a progressive rollout
|
|
2862
|
+
*
|
|
2863
|
+
* Start a staged rollout of one variation of a flag in one environment: the steps are percentages with a hold time each, and the guard says which signals are watched and whether a bad reading pauses the rollout or rolls it back. Use it instead of turning a flag fully on, so a bad variation is caught at a small percentage. bucketBy names the context attribute that decides which bucket a caller falls into, so the same caller stays in the same bucket across steps. One progressive rollout runs per flag and environment; a second one while the first is active is refused with ROLLOUT_ALREADY_ACTIVE.
|
|
2864
|
+
*/
|
|
2865
|
+
export declare const devopsProgressiveRolloutsCreate: <ThrowOnError extends boolean = false>(options: Options<DevopsProgressiveRolloutsCreateData, ThrowOnError>) => RequestResult<DevopsProgressiveRolloutsCreateResponses, DevopsProgressiveRolloutsCreateErrors, ThrowOnError>;
|
|
2866
|
+
/**
|
|
2867
|
+
* Retrieve a progressive rollout
|
|
2868
|
+
*
|
|
2869
|
+
* Read one progressive rollout: which step it is on, how much of the audience that is, when the next step is due, and every step it has already taken with who moved it and why. Poll it to follow a rollout, and read history to find out why it paused or rolled back — a guard that fired leaves the step and the reason there. state scheduled means the first step has not started, running means it is advancing on its hold times, and rolled_back is terminal. nextStepTime is the time the current hold ends.
|
|
2870
|
+
*/
|
|
2871
|
+
export declare const devopsProgressiveRolloutsGet: <ThrowOnError extends boolean = false>(options: Options<DevopsProgressiveRolloutsGetData, ThrowOnError>) => RequestResult<DevopsProgressiveRolloutsGetResponses, DevopsProgressiveRolloutsGetErrors, ThrowOnError>;
|
|
2872
|
+
/**
|
|
2873
|
+
* Pause a progressive rollout
|
|
2874
|
+
*
|
|
2875
|
+
* Hold a running progressive rollout at its current percentage: no further step is taken until it is resumed, and the percentage already served keeps being served. Use it when a guard signal looks wrong but not wrong enough to roll back, so a person can look before the rollout advances. reason is recorded on the rollout as the attribution of the hold. Pausing a rollout that already completed or was rolled back is refused; read it first to see whether there is anything to hold.
|
|
2876
|
+
*/
|
|
2877
|
+
export declare const devopsProgressiveRolloutsPause: <ThrowOnError extends boolean = false>(options: Options<DevopsProgressiveRolloutsPauseData, ThrowOnError>) => RequestResult<DevopsProgressiveRolloutsPauseResponses, DevopsProgressiveRolloutsPauseErrors, ThrowOnError>;
|
|
2878
|
+
/**
|
|
2879
|
+
* Resume a progressive rollout
|
|
2880
|
+
*
|
|
2881
|
+
* Continue a paused progressive rollout from the step it stopped at, restarting the hold time for the current step rather than skipping it. Use it after a pause has been looked into and the rollout is judged safe to continue. A rollout that is running already, or that finished, is refused; read it first to see whether it is paused. The resumption is attributed to the credential that sends it and recorded in the rollout's step history.
|
|
2882
|
+
*/
|
|
2883
|
+
export declare const devopsProgressiveRolloutsResume: <ThrowOnError extends boolean = false>(options: Options<DevopsProgressiveRolloutsResumeData, ThrowOnError>) => RequestResult<DevopsProgressiveRolloutsResumeResponses, DevopsProgressiveRolloutsResumeErrors, ThrowOnError>;
|
|
2884
|
+
/**
|
|
2885
|
+
* Roll back a progressive rollout
|
|
2886
|
+
*
|
|
2887
|
+
* End a progressive rollout by returning the flag's environment to the variation it served before the rollout started, so the audience that was already switched over goes back. Use it when a guard signal says the variation is bad and waiting for the next step would expose more callers. reason is recorded on the rollout as the attribution of the decision. The rollback is terminal: the rollout does not restart, and a new rollout is created if the variation should be tried again. It changes what the environment serves, not the flag's other environments.
|
|
2888
|
+
*/
|
|
2889
|
+
export declare const devopsProgressiveRolloutsRollback: <ThrowOnError extends boolean = false>(options: Options<DevopsProgressiveRolloutsRollbackData, ThrowOnError>) => RequestResult<DevopsProgressiveRolloutsRollbackResponses, DevopsProgressiveRolloutsRollbackErrors, ThrowOnError>;
|
|
2890
|
+
/**
|
|
2891
|
+
* Delete a target's OpenTofu state
|
|
2892
|
+
*
|
|
2893
|
+
* Delete the current OpenTofu state of one deploy target, as OpenTofu does when a workspace is deleted. The kept versions of earlier writes stay. While a lock is held the call must carry its ID, otherwise it answers 409 LOCK_CONFLICT. Deleting a state that does not exist succeeds.
|
|
2894
|
+
*/
|
|
2895
|
+
export declare const devopsTofuStateDelete: <ThrowOnError extends boolean = false>(options: Options<DevopsTofuStateDeleteData, ThrowOnError>) => RequestResult<DevopsTofuStateDeleteResponses, DevopsTofuStateDeleteErrors, ThrowOnError>;
|
|
2896
|
+
/**
|
|
2897
|
+
* Read a target's OpenTofu state
|
|
2898
|
+
*
|
|
2899
|
+
* Read the current OpenTofu state of one deploy target in one DevOps environment. This is the read half of the OpenTofu HTTP backend that `praxis devops deploy --engine tofu` configures: OpenTofu sends HTTP Basic with any username and a Praxis API key as the password, and the route accepts the ordinary Bearer key too. The answer is the state document exactly as the last write stored it. A target never deployed in this environment answers 404, which OpenTofu reads as an empty state.
|
|
2900
|
+
*/
|
|
2901
|
+
export declare const devopsTofuStateGet: <ThrowOnError extends boolean = false>(options: Options<DevopsTofuStateGetData, ThrowOnError>) => RequestResult<DevopsTofuStateGetResponses, DevopsTofuStateGetErrors, ThrowOnError>;
|
|
2902
|
+
/**
|
|
2903
|
+
* Write a target's OpenTofu state
|
|
2904
|
+
*
|
|
2905
|
+
* Store a new OpenTofu state for one deploy target. OpenTofu calls this after every apply, passing the lock ID it holds as ID. Each accepted write also keeps an immutable version of that state (the latest 50 per target are kept), so a rollout's state change can be audited. A state document is at most 1 MiB. A write whose serial is lower than the stored serial of the same lineage is a stale write and answers 409 STALE_SERIAL; re-run so OpenTofu reads the newer state first.
|
|
2906
|
+
*/
|
|
2907
|
+
export declare const devopsTofuStateWrite: <ThrowOnError extends boolean = false>(options: Options<DevopsTofuStateWriteData, ThrowOnError>) => RequestResult<DevopsTofuStateWriteResponses, DevopsTofuStateWriteErrors, ThrowOnError>;
|
|
2908
|
+
/**
|
|
2909
|
+
* Unlock a target's OpenTofu state
|
|
2910
|
+
*
|
|
2911
|
+
* Release the lock on one target's state; this is the DELETE that `praxis devops deploy` configures as OpenTofu's unlock_method (the default UNLOCK verb on the state path works too). The lock ID is read from the lock info body, or from the ID query value. Releasing a lock that is not held succeeds; releasing it under a different ID answers 409 LOCK_CONFLICT.
|
|
2912
|
+
*/
|
|
2913
|
+
export declare const devopsTofuStateUnlock: <ThrowOnError extends boolean = false>(options: Options<DevopsTofuStateUnlockData, ThrowOnError>) => RequestResult<DevopsTofuStateUnlockResponses, DevopsTofuStateUnlockErrors, ThrowOnError>;
|
|
2914
|
+
/**
|
|
2915
|
+
* Lock a target's OpenTofu state
|
|
2916
|
+
*
|
|
2917
|
+
* Take the lock on one target's state before OpenTofu plans or applies; this is the POST that `praxis devops deploy` configures as OpenTofu's lock_method (the default LOCK verb on the state path works too). Exactly one holder can hold the lock. A held lock answers 423 with the holder's lock info, which names who is deploying; wait for them or, if they are gone, release it with a force-unlock using the ID in that answer.
|
|
2918
|
+
*/
|
|
2919
|
+
export declare const devopsTofuStateLock: <ThrowOnError extends boolean = false>(options: Options<DevopsTofuStateLockData, ThrowOnError>) => RequestResult<DevopsTofuStateLockResponses, DevopsTofuStateLockErrors, ThrowOnError>;
|
|
2920
|
+
/**
|
|
2921
|
+
* List changes
|
|
2922
|
+
*
|
|
2923
|
+
* List the project's changes, newest first, each with its derived stage and one cell per environment. Use it to see what is in flight before opening another change, or to find the id (the branch name) of a change you want to read. filter narrows the list: stage is derived from the facts, so it is applied after derivation, while type, owner and ended narrow on stored columns. Leaving a filter field out, or sending an empty array, does not narrow that field. ended=true lists changes that are done or abandoned, ended=false lists the rest. totalSize is answered on the first page only and counts what the filter leaves.
|
|
2924
|
+
*/
|
|
2925
|
+
export declare const devopsChangesList: <ThrowOnError extends boolean = false>(options: Options<DevopsChangesListData, ThrowOnError>) => RequestResult<DevopsChangesListResponses, DevopsChangesListErrors, ThrowOnError>;
|
|
2926
|
+
/**
|
|
2927
|
+
* Create a change
|
|
2928
|
+
*
|
|
2929
|
+
* Open a change: the unit that carries one piece of work from a branch to production. A change has no separate id — its id is its branch name, <type>/<slug> (for example feat/run-page-v2), and the branch is cut from main as part of this call. type says what the work is and slug names it; both together are the id, so the same pair sent again answers the change the first call made instead of creating a second. A change with a flag also creates a release flag whose key is the slug, off in every environment, so opening one changes no runtime behaviour; withFlag defaults to true for feat and false for every other type, and you may override it either way. Requesting a change opens it at once — there is no approval step — and the caller becomes its owner. A slug already used by another type in the project is refused with CHANGE_SLUG_TAKEN because both would need the same branch name. The stage in the answer is derived from facts such as pull requests and promotions; it is never something you set.
|
|
2930
|
+
*/
|
|
2931
|
+
export declare const devopsChangesCreate: <ThrowOnError extends boolean = false>(options: Options<DevopsChangesCreateData, ThrowOnError>) => RequestResult<DevopsChangesCreateResponses, DevopsChangesCreateErrors, ThrowOnError>;
|
|
2932
|
+
/**
|
|
2933
|
+
* Retrieve a change
|
|
2934
|
+
*
|
|
2935
|
+
* Read one change in full: its derived stage, its pull requests (one per slice, oldest first), its flag, its workspace, and one cell per environment showing the version it rode and how far its flag has been rolled out there. The id is the branch name and contains a slash, so it must be percent-encoded in the path: feat/run-page-v2 is sent as feat%2Frun-page-v2. The stage is derived, not stored — with several pull requests it shows the slice that is furthest behind, so a change already in production that opens a new slice goes back to reviewing. When suspectedIn is set, the latest verification in that environment failed and this change is listed among the suspects until a later verification succeeds.
|
|
2936
|
+
*/
|
|
2937
|
+
export declare const devopsChangesGet: <ThrowOnError extends boolean = false>(options: Options<DevopsChangesGetData, ThrowOnError>) => RequestResult<DevopsChangesGetResponses, DevopsChangesGetErrors, ThrowOnError>;
|
|
2938
|
+
/**
|
|
2939
|
+
* Abandon a change
|
|
2940
|
+
*
|
|
2941
|
+
* Stop a change for good: it no longer moves forward and its stage becomes abandoned. reason is required and is kept with the change. Pull requests that were already merged are not undone — the system cleans them up, or a new change reverts them — so abandoning is a statement about the change, not a rollback of code. The id is the branch name and its slash must be percent-encoded in the path (feat%2Frun-page-v2). A change that is already abandoned is refused with INVALID_ARGUMENT, which is how a caller tells an earlier abandon apart from a call that had no effect.
|
|
2942
|
+
*/
|
|
2943
|
+
export declare const devopsChangesAbandon: <ThrowOnError extends boolean = false>(options: Options<DevopsChangesAbandonData, ThrowOnError>) => RequestResult<DevopsChangesAbandonResponses, DevopsChangesAbandonErrors, ThrowOnError>;
|
|
2944
|
+
/**
|
|
2945
|
+
* Mark the last slice
|
|
2946
|
+
*
|
|
2947
|
+
* Say whether the pull request being merged is the last slice of the change. A change defaults to yes; until it is marked as the last slice it cannot reach rolling out or done, because rolling out a container that may still grow would roll out the wrong thing. Send lastSlice=false before merging a pull request when more slices will follow, and true again on the final one. The id is the branch name and its slash must be percent-encoded in the path (feat%2Frun-page-v2).
|
|
2948
|
+
*/
|
|
2949
|
+
export declare const devopsChangesMarkLastSlice: <ThrowOnError extends boolean = false>(options: Options<DevopsChangesMarkLastSliceData, ThrowOnError>) => RequestResult<DevopsChangesMarkLastSliceResponses, DevopsChangesMarkLastSliceErrors, ThrowOnError>;
|
|
2393
2950
|
/**
|
|
2394
2951
|
* List knowledge bases
|
|
2395
2952
|
*
|
|
@@ -2399,7 +2956,7 @@ export declare const knowledgeListVectorStores: <ThrowOnError extends boolean =
|
|
|
2399
2956
|
/**
|
|
2400
2957
|
* Create knowledge base
|
|
2401
2958
|
*
|
|
2402
|
-
* 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.
|
|
2959
|
+
* 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"}.
|
|
2403
2960
|
*/
|
|
2404
2961
|
export declare const knowledgeCreateVectorStore: <ThrowOnError extends boolean = false>(options: Options<KnowledgeCreateVectorStoreData, ThrowOnError>) => RequestResult<KnowledgeCreateVectorStoreResponses, KnowledgeCreateVectorStoreErrors, ThrowOnError>;
|
|
2405
2962
|
/**
|
|
@@ -2435,7 +2992,7 @@ export declare const knowledgeListFiles: <ThrowOnError extends boolean = false>(
|
|
|
2435
2992
|
/**
|
|
2436
2993
|
* Add file
|
|
2437
2994
|
*
|
|
2438
|
-
* Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
2995
|
+
* 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.
|
|
2439
2996
|
*/
|
|
2440
2997
|
export declare const knowledgeAttachFile: <ThrowOnError extends boolean = false>(options: Options<KnowledgeAttachFileData, ThrowOnError>) => RequestResult<KnowledgeAttachFileResponses, KnowledgeAttachFileErrors, ThrowOnError>;
|
|
2441
2998
|
/**
|
|
@@ -2525,7 +3082,7 @@ export declare const knowledgeListEvents: <ThrowOnError extends boolean = false>
|
|
|
2525
3082
|
/**
|
|
2526
3083
|
* List libraries
|
|
2527
3084
|
*
|
|
2528
|
-
*
|
|
3085
|
+
* 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.
|
|
2529
3086
|
*/
|
|
2530
3087
|
export declare const mediaListLibraries: <ThrowOnError extends boolean = false>(options?: Options<MediaListLibrariesData, ThrowOnError>) => RequestResult<MediaListLibrariesResponses, MediaListLibrariesErrors, ThrowOnError>;
|
|
2531
3088
|
/**
|
|
@@ -2534,184 +3091,352 @@ export declare const mediaListLibraries: <ThrowOnError extends boolean = false>(
|
|
|
2534
3091
|
* 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.
|
|
2535
3092
|
*/
|
|
2536
3093
|
export declare const mediaCreateLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaCreateLibraryData, ThrowOnError>) => RequestResult<MediaCreateLibraryResponses, MediaCreateLibraryErrors, ThrowOnError>;
|
|
3094
|
+
/**
|
|
3095
|
+
* Create frame URLs
|
|
3096
|
+
*
|
|
3097
|
+
* 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.
|
|
3098
|
+
*/
|
|
3099
|
+
export declare const mediaCreateFrameUrls: <ThrowOnError extends boolean = false>(options: Options<MediaCreateFrameUrlsData, ThrowOnError>) => RequestResult<MediaCreateFrameUrlsResponses, MediaCreateFrameUrlsErrors, ThrowOnError>;
|
|
2537
3100
|
/**
|
|
2538
3101
|
* Delete library
|
|
2539
3102
|
*
|
|
2540
|
-
*
|
|
3103
|
+
* 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.
|
|
2541
3104
|
*/
|
|
2542
3105
|
export declare const mediaDeleteLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaDeleteLibraryData, ThrowOnError>) => RequestResult<MediaDeleteLibraryResponses, MediaDeleteLibraryErrors, ThrowOnError>;
|
|
2543
3106
|
/**
|
|
2544
3107
|
* Get library
|
|
2545
3108
|
*
|
|
2546
|
-
*
|
|
3109
|
+
* 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.
|
|
2547
3110
|
*/
|
|
2548
3111
|
export declare const mediaGetLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaGetLibraryData, ThrowOnError>) => RequestResult<MediaGetLibraryResponses, MediaGetLibraryErrors, ThrowOnError>;
|
|
2549
3112
|
/**
|
|
2550
3113
|
* Update library
|
|
2551
3114
|
*
|
|
2552
|
-
* Update an active library
|
|
3115
|
+
* 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.
|
|
2553
3116
|
*/
|
|
2554
3117
|
export declare const mediaUpdateLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaUpdateLibraryData, ThrowOnError>) => RequestResult<MediaUpdateLibraryResponses, MediaUpdateLibraryErrors, ThrowOnError>;
|
|
2555
3118
|
/**
|
|
2556
3119
|
* Restore library
|
|
2557
3120
|
*
|
|
2558
|
-
*
|
|
3121
|
+
* 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.
|
|
2559
3122
|
*/
|
|
2560
3123
|
export declare const mediaRestoreLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaRestoreLibraryData, ThrowOnError>) => RequestResult<MediaRestoreLibraryResponses, MediaRestoreLibraryErrors, ThrowOnError>;
|
|
2561
3124
|
/**
|
|
2562
3125
|
* Purge library
|
|
2563
3126
|
*
|
|
2564
|
-
*
|
|
3127
|
+
* 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.
|
|
2565
3128
|
*/
|
|
2566
3129
|
export declare const mediaPurgeLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaPurgeLibraryData, ThrowOnError>) => RequestResult<MediaPurgeLibraryResponses, MediaPurgeLibraryErrors, ThrowOnError>;
|
|
2567
3130
|
/**
|
|
2568
3131
|
* List assets
|
|
2569
3132
|
*
|
|
2570
|
-
*
|
|
3133
|
+
* Upload content into an active library and return the stored asset. 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 asset. Chunk uploads require both chunk headers.
|
|
2571
3134
|
*/
|
|
2572
3135
|
export declare const mediaListAssets: <ThrowOnError extends boolean = false>(options: Options<MediaListAssetsData, ThrowOnError>) => RequestResult<MediaListAssetsResponses, MediaListAssetsErrors, ThrowOnError>;
|
|
2573
3136
|
/**
|
|
2574
3137
|
* Upload asset
|
|
2575
3138
|
*
|
|
2576
|
-
*
|
|
3139
|
+
* 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.
|
|
2577
3140
|
*/
|
|
2578
3141
|
export declare const mediaUploadAsset: <ThrowOnError extends boolean = false>(options: Options<MediaUploadAssetData, ThrowOnError>) => RequestResult<MediaUploadAssetResponses, MediaUploadAssetErrors, ThrowOnError>;
|
|
2579
3142
|
/**
|
|
2580
3143
|
* Import file
|
|
2581
3144
|
*
|
|
2582
|
-
* Copy
|
|
3145
|
+
* 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.
|
|
2583
3146
|
*/
|
|
2584
3147
|
export declare const mediaImportAsset: <ThrowOnError extends boolean = false>(options: Options<MediaImportAssetData, ThrowOnError>) => RequestResult<MediaImportAssetResponses, MediaImportAssetErrors, ThrowOnError>;
|
|
2585
3148
|
/**
|
|
2586
3149
|
* Delete asset
|
|
2587
3150
|
*
|
|
2588
|
-
*
|
|
3151
|
+
* 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.
|
|
2589
3152
|
*/
|
|
2590
3153
|
export declare const mediaDeleteAsset: <ThrowOnError extends boolean = false>(options: Options<MediaDeleteAssetData, ThrowOnError>) => RequestResult<MediaDeleteAssetResponses, MediaDeleteAssetErrors, ThrowOnError>;
|
|
2591
3154
|
/**
|
|
2592
3155
|
* Get asset
|
|
2593
3156
|
*
|
|
2594
|
-
*
|
|
3157
|
+
* 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.
|
|
2595
3158
|
*/
|
|
2596
3159
|
export declare const mediaGetAsset: <ThrowOnError extends boolean = false>(options: Options<MediaGetAssetData, ThrowOnError>) => RequestResult<MediaGetAssetResponses, MediaGetAssetErrors, ThrowOnError>;
|
|
2597
3160
|
/**
|
|
2598
3161
|
* Update asset
|
|
2599
3162
|
*
|
|
2600
|
-
*
|
|
3163
|
+
* 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.
|
|
2601
3164
|
*/
|
|
2602
3165
|
export declare const mediaUpdateAsset: <ThrowOnError extends boolean = false>(options: Options<MediaUpdateAssetData, ThrowOnError>) => RequestResult<MediaUpdateAssetResponses, MediaUpdateAssetErrors, ThrowOnError>;
|
|
2603
3166
|
/**
|
|
2604
3167
|
* Reprocess asset
|
|
2605
3168
|
*
|
|
2606
|
-
*
|
|
3169
|
+
* 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.
|
|
2607
3170
|
*/
|
|
2608
3171
|
export declare const mediaReprocessAsset: <ThrowOnError extends boolean = false>(options: Options<MediaReprocessAssetData, ThrowOnError>) => RequestResult<MediaReprocessAssetResponses, MediaReprocessAssetErrors, ThrowOnError>;
|
|
2609
3172
|
/**
|
|
2610
3173
|
* List understandings
|
|
2611
3174
|
*
|
|
2612
|
-
* List an asset
|
|
3175
|
+
* 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.
|
|
2613
3176
|
*/
|
|
2614
3177
|
export declare const mediaListUnderstandings: <ThrowOnError extends boolean = false>(options: Options<MediaListUnderstandingsData, ThrowOnError>) => RequestResult<MediaListUnderstandingsResponses, MediaListUnderstandingsErrors, ThrowOnError>;
|
|
2615
3178
|
/**
|
|
2616
3179
|
* Expression search
|
|
2617
3180
|
*
|
|
2618
|
-
*
|
|
3181
|
+
* 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.
|
|
2619
3182
|
*/
|
|
2620
3183
|
export declare const mediaExpressionSearch: <ThrowOnError extends boolean = false>(options: Options<MediaExpressionSearchData, ThrowOnError>) => RequestResult<MediaExpressionSearchResponses, MediaExpressionSearchErrors, ThrowOnError>;
|
|
2621
3184
|
/**
|
|
2622
3185
|
* Visual search
|
|
2623
3186
|
*
|
|
2624
|
-
*
|
|
3187
|
+
* 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.
|
|
2625
3188
|
*/
|
|
2626
3189
|
export declare const mediaVisualSearch: <ThrowOnError extends boolean = false>(options: Options<MediaVisualSearchData, ThrowOnError>) => RequestResult<MediaVisualSearchResponses, MediaVisualSearchErrors, ThrowOnError>;
|
|
2627
3190
|
/**
|
|
2628
3191
|
* Semantic search
|
|
2629
3192
|
*
|
|
2630
|
-
* Search assets with a nonblank text query
|
|
3193
|
+
* 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.
|
|
2631
3194
|
*/
|
|
2632
3195
|
export declare const mediaSemanticSearch: <ThrowOnError extends boolean = false>(options: Options<MediaSemanticSearchData, ThrowOnError>) => RequestResult<MediaSemanticSearchResponses, MediaSemanticSearchErrors, ThrowOnError>;
|
|
2633
3196
|
/**
|
|
2634
3197
|
* Semantic search alias
|
|
2635
3198
|
*
|
|
2636
|
-
*
|
|
3199
|
+
* 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.
|
|
2637
3200
|
*/
|
|
2638
3201
|
export declare const mediaSearch: <ThrowOnError extends boolean = false>(options: Options<MediaSearchData, ThrowOnError>) => RequestResult<MediaSearchResponses, MediaSearchErrors, ThrowOnError>;
|
|
2639
3202
|
/**
|
|
2640
3203
|
* List folders
|
|
2641
3204
|
*
|
|
2642
|
-
*
|
|
3205
|
+
* undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.
|
|
2643
3206
|
*/
|
|
2644
3207
|
export declare const mediaListFolders: <ThrowOnError extends boolean = false>(options: Options<MediaListFoldersData, ThrowOnError>) => RequestResult<MediaListFoldersResponses, MediaListFoldersErrors, ThrowOnError>;
|
|
2645
3208
|
/**
|
|
2646
3209
|
* Create batch
|
|
2647
3210
|
*
|
|
2648
|
-
*
|
|
3211
|
+
* 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.
|
|
2649
3212
|
*/
|
|
2650
3213
|
export declare const mediaCreateBatch: <ThrowOnError extends boolean = false>(options: Options<MediaCreateBatchData, ThrowOnError>) => RequestResult<MediaCreateBatchResponses, MediaCreateBatchErrors, ThrowOnError>;
|
|
2651
3214
|
/**
|
|
2652
3215
|
* Get batch
|
|
2653
3216
|
*
|
|
2654
|
-
*
|
|
3217
|
+
* 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.
|
|
2655
3218
|
*/
|
|
2656
3219
|
export declare const mediaGetBatch: <ThrowOnError extends boolean = false>(options: Options<MediaGetBatchData, ThrowOnError>) => RequestResult<MediaGetBatchResponses, MediaGetBatchErrors, ThrowOnError>;
|
|
2657
3220
|
/**
|
|
2658
3221
|
* Batch assets alias
|
|
2659
3222
|
*
|
|
2660
|
-
*
|
|
3223
|
+
* 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.
|
|
2661
3224
|
*/
|
|
2662
3225
|
export declare const mediaBatchAssets: <ThrowOnError extends boolean = false>(options: Options<MediaBatchAssetsData, ThrowOnError>) => RequestResult<MediaBatchAssetsResponses, MediaBatchAssetsErrors, ThrowOnError>;
|
|
2663
3226
|
/**
|
|
2664
|
-
* Get job
|
|
3227
|
+
* Get job
|
|
2665
3228
|
*
|
|
2666
|
-
*
|
|
3229
|
+
* Read the current batch or generation Job status and progress. For generation, inspect outputs and failures; a successful output has already landed in the library as an asset.
|
|
2667
3230
|
*/
|
|
2668
3231
|
export declare const mediaGetJob: <ThrowOnError extends boolean = false>(options: Options<MediaGetJobData, ThrowOnError>) => RequestResult<MediaGetJobResponses, MediaGetJobErrors, ThrowOnError>;
|
|
2669
3232
|
/**
|
|
2670
3233
|
* List events
|
|
2671
3234
|
*
|
|
2672
|
-
* Read library events in sequence order
|
|
3235
|
+
* 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.
|
|
2673
3236
|
*/
|
|
2674
3237
|
export declare const mediaListEvents: <ThrowOnError extends boolean = false>(options: Options<MediaListEventsData, ThrowOnError>) => RequestResult<MediaListEventsResponses, MediaListEventsErrors, ThrowOnError>;
|
|
2675
3238
|
/**
|
|
2676
3239
|
* Create delivery token
|
|
2677
3240
|
*
|
|
2678
|
-
* 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
|
|
3241
|
+
* 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.
|
|
2679
3242
|
*/
|
|
2680
3243
|
export declare const mediaCreateDeliveryToken: <ThrowOnError extends boolean = false>(options: Options<MediaCreateDeliveryTokenData, ThrowOnError>) => RequestResult<MediaCreateDeliveryTokenResponses, MediaCreateDeliveryTokenErrors, ThrowOnError>;
|
|
2681
3244
|
/**
|
|
2682
|
-
*
|
|
3245
|
+
* Get default library
|
|
2683
3246
|
*
|
|
2684
|
-
*
|
|
3247
|
+
* Return this organization’s default library. Calling ensures the organization’s default library exists (ADR-093): the first call creates it and later calls return the same library, so this is the method to call before writing when no library id is known. Generated and edited media land here when no library is named. The path segment {lib} accepts the literal default, which resolves to this library before the credential check — so an agent that has never listed libraries can still write to the right place. Returns the same Library object as libraries.retrieve; a credential bound to one library reaches this only when that binding covers the default library.
|
|
2685
3248
|
*/
|
|
2686
|
-
export declare const
|
|
3249
|
+
export declare const mediaGetDefaultLibrary: <ThrowOnError extends boolean = false>(options?: Options<MediaGetDefaultLibraryData, ThrowOnError>) => RequestResult<MediaGetDefaultLibraryResponses, MediaGetDefaultLibraryErrors, ThrowOnError>;
|
|
2687
3250
|
/**
|
|
2688
|
-
*
|
|
3251
|
+
* Set default library
|
|
2689
3252
|
*
|
|
2690
|
-
*
|
|
3253
|
+
* Point this organization’s default library at an existing library. Calling ensures the organization’s default library exists (ADR-093): the path is resolved before the credential check, so a first call creates the default library when there is none and then repoints it. The path segment {lib} accepts the literal default, which resolves to this library before the credential check. Supply library_id from library creation or listing; the library must be active and belong to the organization. This changes where library-less generation and uploads land across the whole organization, so it affects other callers as well as this one. It does not move or copy any asset — assets already in the previous default library stay there. Returns the library now set as the default. Deleting the default library is refused with LIBRARY_IS_DEFAULT until another library is made the default.
|
|
2691
3254
|
*/
|
|
2692
|
-
export declare const
|
|
3255
|
+
export declare const mediaSetDefaultLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaSetDefaultLibraryData, ThrowOnError>) => RequestResult<MediaSetDefaultLibraryResponses, MediaSetDefaultLibraryErrors, ThrowOnError>;
|
|
2693
3256
|
/**
|
|
2694
|
-
*
|
|
3257
|
+
* Get asset lineage
|
|
2695
3258
|
*
|
|
2696
|
-
* Read
|
|
3259
|
+
* Read the whole edit tree containing one asset, so a caller sees what it was edited from and what was edited from it. Use library_id from creation or listing and asset_id from asset creation or listing; library_id also accepts the literal default, which resolves to the organization’s default library before the credential check. The response names the root the tree descends from, the asset asked about, and every step between them, each with the operation, prompt and creation time that produced it. Deleted assets stay in the tree, marked deleted, so the chain stays connected after cleanup. This is a read: it starts no processing and changes no asset. Example: GET /media/v1/libraries/lib_example/assets/9dfa312ef9bc4b00816339b598b1152c/lineage.
|
|
2697
3260
|
*/
|
|
2698
|
-
export declare const
|
|
3261
|
+
export declare const mediaGetAssetLineage: <ThrowOnError extends boolean = false>(options: Options<MediaGetAssetLineageData, ThrowOnError>) => RequestResult<MediaGetAssetLineageResponses, MediaGetAssetLineageErrors, ThrowOnError>;
|
|
2699
3262
|
/**
|
|
2700
|
-
*
|
|
3263
|
+
* Generate image
|
|
2701
3264
|
*
|
|
2702
|
-
*
|
|
3265
|
+
* Generate one or more images from a text prompt and store them straight into the library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check, so an agent that has never listed a library can still generate. The request body is the image request itself: prompt is required, and n, size, background, output_format, output, references, seed, model, asset_folder and understanding are optional. Set output to sticker for a cut-out with a transparent background. references attach existing assets with a role — edit_target, style, structure or subject — and a model that cannot honour a role returns REFERENCE_TYPE_MISMATCH. Aspect ratio is not accepted for images; name size instead. Generation is billed by the model usage it consumes, at the same prices as the model API, and the job reports the charge in usage (US dollars, six decimals, final once the job is completed or failed) and each produced asset carries its own part in provenance.cost; nothing is charged for a request refused before it starts. When the job is done, tell the person the usage amount and give them each output’s viewer_url, which opens the asset in the Console. The response is 202 with a queued Job whose type is image and whose operation is generate; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until its status is completed or failed, then read the produced assets from the library. Send Idempotency-Key, or idempotency_key in the body, to retry without generating and charging twice. Example: POST /media/v1/libraries/default/images/generations with {"prompt":"A red kite above a calm sea at sunrise","n":1,"output":"sticker"}.
|
|
2703
3266
|
*/
|
|
2704
|
-
export declare const
|
|
3267
|
+
export declare const mediaGenerateImage: <ThrowOnError extends boolean = false>(options: Options<MediaGenerateImageData, ThrowOnError>) => RequestResult<MediaGenerateImageResponses, MediaGenerateImageErrors, ThrowOnError>;
|
|
2705
3268
|
/**
|
|
2706
|
-
*
|
|
3269
|
+
* Generate video
|
|
2707
3270
|
*
|
|
2708
|
-
*
|
|
3271
|
+
* Generate one or more videos from a text prompt and store them straight into the library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check, so an agent that has never listed a library can still generate. mode says what the video is anchored to: text needs only a prompt, image animates the existing image named by first_frame, and first_last interpolates between first_frame and last_frame. The frames must be image or sticker assets of the same library; a fetchable URL for each is sent to the model and recorded in the produced asset’s provenance. mode reference and output gif are refused with OPERATION_NOT_SUPPORTED in this release, and negative_prompt, references and an unknown mode are refused before anything is charged. Every output lands in the library as a video asset as soon as it is ready — there is no candidate state and nothing expires, so outputs.save is not part of this lane. Generation is billed per second by the model usage it consumes, at the same prices as the model API, and the job reports the charge in usage (US dollars, six decimals) and each produced asset carries its own part in provenance.cost; a refused request costs nothing. When the job is done, tell the person the usage amount and give them each output’s viewer_url. The response is 202 with a queued Job whose type is video and whose operation is generate; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until its status is completed or failed, then read the produced assets from the library. Send Idempotency-Key, or idempotency_key in the body, to retry without generating and charging twice. Example: POST /media/v1/libraries/default/videos/generations with {"prompt":"A red kite above a calm sea at sunrise","mode":"text","n":1}.
|
|
2709
3272
|
*/
|
|
2710
|
-
export declare const
|
|
3273
|
+
export declare const mediaGenerateVideo: <ThrowOnError extends boolean = false>(options: Options<MediaGenerateVideoData, ThrowOnError>) => RequestResult<MediaGenerateVideoResponses, MediaGenerateVideoErrors, ThrowOnError>;
|
|
2711
3274
|
/**
|
|
2712
|
-
*
|
|
3275
|
+
* Edit asset
|
|
2713
3276
|
*
|
|
2714
|
-
*
|
|
3277
|
+
* Edit an existing asset and store the result as a new asset. Use library_id from creation or listing and asset_id from asset creation or listing; library_id also accepts the literal default, which resolves to the organization’s default library before the credential check. The source asset is never overwritten: the new asset hangs under it in the edit chain, records it in derived_from, and reads back with assets.lineage, so earlier steps stay reachable. The body is operation plus the optional model, asset_folder, understanding and idempotency_key; operation.type selects the edit and carries that operation’s own fields. This release performs variations, inpaint, erase, replace_object, recolor, remove_background and replace_background on images; every other type in the operation vocabulary — the video and audio edits — is refused with OPERATION_NOT_SUPPORTED. inpaint takes mask, a PNG File identifier beginning with file- whose transparent area marks the region to replace, plus the prompt describing what belongs there. Aspects beyond the source asset’s material type return REFERENCE_TYPE_MISMATCH. Editing is billed by the model usage it consumes, at the same prices as the model API, and the job reports the charge in usage (US dollars, six decimals) and the new asset carries it in provenance.cost; when the job is done, tell the person the usage amount and give them the output’s viewer_url. The response is 202 with a queued Job whose type is image, whose operation is the edit applied, and whose source_asset_id is the asset edited; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until it is completed or failed, then read the produced asset. Example: POST /media/v1/libraries/lib_example/assets/9dfa312ef9bc4b00816339b598b1152c/edits with {"operation":{"type":"variations","strength":"subtle"}}.
|
|
3278
|
+
*/
|
|
3279
|
+
export declare const mediaEditAsset: <ThrowOnError extends boolean = false>(options: Options<MediaEditAssetData, ThrowOnError>) => RequestResult<MediaEditAssetResponses, MediaEditAssetErrors, ThrowOnError>;
|
|
3280
|
+
/**
|
|
3281
|
+
* Create speech
|
|
3282
|
+
*
|
|
3283
|
+
* Synthesise speech from text and store the recording straight into the library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check, so an agent that has never listed a library can still synthesise. input is the text to speak. voice is optional and may be omitted, in which case the model’s default voice is used; when it is given it must be one of the voices of the model being used — read them from the types.speech list of GET /media/v1/generation/capabilities, which gives each voice an id, a name, a gender, a language and a style, or pass a voice material id of this same library — and a voice that is neither is refused with INVALID_PARAMS in the voice field before any job exists, so a wrong name is free to try but reading the capabilities first is free without trying. Do not use OpenAI voice names such as alloy or aura: they are not valid here. speed is passed to the provider unchanged, and instructions and language are refused with OPERATION_NOT_SUPPORTED in this release. Cloning a voice from recordings is not available yet. The provider caps one request at a short stretch of text, so a long input is cut into segments at paragraph and sentence boundaries and synthesised in order, then joined into the single recording the library receives: nothing is spoken twice and nothing is dropped. Because the segments are joined byte for byte, a multi-segment input accepts only response_format mp3 (the default) or pcm; opus is available for a single-segment input. A speech job has one result however many segments it took. Synthesis is billed by the model usage it consumes, at the same prices as the model API, and the job reports the charge in usage (US dollars, six decimals, the sum over every segment) and the recording carries it in provenance.cost; a request refused before it starts costs nothing. When the job is done, tell the person the usage amount and give them the output’s viewer_url. The response is 202 with a queued Job whose type is speech and whose operation is generate; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until its status is completed or failed, then read the produced asset from the library — the recording carries material_type audio, audio_role voice, ai_generated true, and provenance naming this job, the text spoken and the model. Send Idempotency-Key, or idempotency_key in the body, to retry without synthesising and charging twice. Example: POST /media/v1/libraries/default/audio/speech with {"input":"A red kite above a calm sea at sunrise."}, or with {"input":"A red kite above a calm sea at sunrise.","voice":"zh_female_wenroumama_uranus_bigtts"} for a gentle female voice.
|
|
3284
|
+
*/
|
|
3285
|
+
export declare const mediaCreateSpeech: <ThrowOnError extends boolean = false>(options: Options<MediaCreateSpeechData, ThrowOnError>) => RequestResult<MediaCreateSpeechResponses, MediaCreateSpeechErrors, ThrowOnError>;
|
|
3286
|
+
/**
|
|
3287
|
+
* Summarize understanding failures
|
|
3288
|
+
*
|
|
3289
|
+
* 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.
|
|
3290
|
+
*/
|
|
3291
|
+
export declare const mediaUnderstandingFailureSummary: <ThrowOnError extends boolean = false>(options: Options<MediaUnderstandingFailureSummaryData, ThrowOnError>) => RequestResult<MediaUnderstandingFailureSummaryResponses, MediaUnderstandingFailureSummaryErrors, ThrowOnError>;
|
|
3292
|
+
/**
|
|
3293
|
+
* List understanding results across a library
|
|
3294
|
+
*
|
|
3295
|
+
* 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.
|
|
3296
|
+
*/
|
|
3297
|
+
export declare const mediaListUnderstandingsByLibrary: <ThrowOnError extends boolean = false>(options: Options<MediaListUnderstandingsByLibraryData, ThrowOnError>) => RequestResult<MediaListUnderstandingsByLibraryResponses, MediaListUnderstandingsByLibraryErrors, ThrowOnError>;
|
|
3298
|
+
/**
|
|
3299
|
+
* List jobs
|
|
3300
|
+
*
|
|
3301
|
+
* List batch and generation jobs in a library. Filter by status or by pipeline_run_id (the jobs one automation run started) and continue with next_cursor. Poll a generation Job until terminal; every produced output is already a library asset.
|
|
3302
|
+
*/
|
|
3303
|
+
export declare const mediaListJobs: <ThrowOnError extends boolean = false>(options: Options<MediaListJobsData, ThrowOnError>) => RequestResult<MediaListJobsResponses, MediaListJobsErrors, ThrowOnError>;
|
|
3304
|
+
/**
|
|
3305
|
+
* Cancel job
|
|
3306
|
+
*
|
|
3307
|
+
* Cancel a queued or running generation job. Outputs already produced remain in the library; poll or read the returned Job to confirm its status.
|
|
3308
|
+
*/
|
|
3309
|
+
export declare const mediaCancelJob: <ThrowOnError extends boolean = false>(options: Options<MediaCancelJobData, ThrowOnError>) => RequestResult<MediaCancelJobResponses, MediaCancelJobErrors, ThrowOnError>;
|
|
3310
|
+
/**
|
|
3311
|
+
* Get generation capabilities
|
|
3312
|
+
*
|
|
3313
|
+
* Read what Praxis offers for each kind of generation — image, video and speech — before asking for one, and read a speech model’s voices here before naming one. Every type answers the models available for it, the model it uses when a request names none, and what each model costs per unit; a speech model the platform publishes voices for also carries default_voice and voices there, each voice with an id, a name, a gender, a language and a style — so a request for "a gentle female voice" is answered by matching the style and gender rather than by guessing an identifier. Pass a voice id back verbatim as voice, or omit voice to take default_voice; a voice that is neither one of those nor a voice material of the library is refused with INVALID_PARAMS before any job is created. OpenAI voice names such as alloy and aura are not valid here. The video fields beside the types keep their original meaning (intents, default model, duration and aspect-ratio limits, per-library concurrency). The models come from the platform model catalogue, and an id listed here is accepted verbatim as the model field of that type’s generation request. A video model additionally carries the modes it can be driven in and the durations, aspect ratios and resolutions the catalogue has registered for it — modes, duration_seconds, aspect_ratios and resolutions — so read them before requesting video and choose a mode and a value this model lists; an empty list means the platform has not registered that option yet, and then omit the field rather than assume a value. price.amount is a decimal string with its currency; video models that charge by resolution also carry price.by_resolution, whose amount is then the cheapest tier. A model the catalogue cannot route right now is still listed, with available false, so a caller can show it as temporarily unavailable instead of hiding it. When the catalogue cannot be read the endpoint still answers: every type comes back with an empty models list and its real default_model, and the voices a speech model carries are absent rather than empty, because the voices come from the platform and not from the catalogue. Generation is charged per unit and every output is stored in the library.
|
|
3314
|
+
*/
|
|
3315
|
+
export declare const mediaGetGenerationCapabilities: <ThrowOnError extends boolean = false>(options?: Options<MediaGetGenerationCapabilitiesData, ThrowOnError>) => RequestResult<MediaGetGenerationCapabilitiesResponses, MediaGetGenerationCapabilitiesErrors, ThrowOnError>;
|
|
3316
|
+
/**
|
|
3317
|
+
* List types
|
|
3318
|
+
*
|
|
3319
|
+
* 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.
|
|
3320
|
+
*/
|
|
3321
|
+
export declare const ontologyListTypes: <ThrowOnError extends boolean = false>(options?: Options<OntologyListTypesData, ThrowOnError>) => RequestResult<OntologyListTypesResponses, OntologyListTypesErrors, ThrowOnError>;
|
|
3322
|
+
/**
|
|
3323
|
+
* Register type
|
|
3324
|
+
*
|
|
3325
|
+
* 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.
|
|
3326
|
+
*/
|
|
3327
|
+
export declare const ontologyRegisterType: <ThrowOnError extends boolean = false>(options: Options<OntologyRegisterTypeData, ThrowOnError>) => RequestResult<unknown, OntologyRegisterTypeErrors, ThrowOnError>;
|
|
3328
|
+
/**
|
|
3329
|
+
* Retrieve type
|
|
3330
|
+
*
|
|
3331
|
+
* 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.
|
|
3332
|
+
*/
|
|
3333
|
+
export declare const ontologyRetrieveType: <ThrowOnError extends boolean = false>(options: Options<OntologyRetrieveTypeData, ThrowOnError>) => RequestResult<OntologyRetrieveTypeResponses, OntologyRetrieveTypeErrors, ThrowOnError>;
|
|
3334
|
+
/**
|
|
3335
|
+
* List nodes
|
|
3336
|
+
*
|
|
3337
|
+
* 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.
|
|
3338
|
+
*/
|
|
3339
|
+
export declare const ontologyListNodes: <ThrowOnError extends boolean = false>(options?: Options<OntologyListNodesData, ThrowOnError>) => RequestResult<OntologyListNodesResponses, OntologyListNodesErrors, ThrowOnError>;
|
|
3340
|
+
/**
|
|
3341
|
+
* Create node
|
|
3342
|
+
*
|
|
3343
|
+
* 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; it does not give any agent a memory.
|
|
3344
|
+
*/
|
|
3345
|
+
export declare const ontologyCreateNode: <ThrowOnError extends boolean = false>(options: Options<OntologyCreateNodeData, ThrowOnError>) => RequestResult<OntologyCreateNodeResponses, OntologyCreateNodeErrors, ThrowOnError>;
|
|
3346
|
+
/**
|
|
3347
|
+
* Retrieve node
|
|
3348
|
+
*
|
|
3349
|
+
* 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.
|
|
3350
|
+
*/
|
|
3351
|
+
export declare const ontologyRetrieveNode: <ThrowOnError extends boolean = false>(options: Options<OntologyRetrieveNodeData, ThrowOnError>) => RequestResult<OntologyRetrieveNodeResponses, OntologyRetrieveNodeErrors, ThrowOnError>;
|
|
3352
|
+
/**
|
|
3353
|
+
* Update node
|
|
3354
|
+
*
|
|
3355
|
+
* 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.
|
|
3356
|
+
*/
|
|
3357
|
+
export declare const ontologyUpdateNode: <ThrowOnError extends boolean = false>(options: Options<OntologyUpdateNodeData, ThrowOnError>) => RequestResult<OntologyUpdateNodeResponses, OntologyUpdateNodeErrors, ThrowOnError>;
|
|
3358
|
+
/**
|
|
3359
|
+
* Retrieve neighborhood
|
|
3360
|
+
*
|
|
3361
|
+
* Load the subgraph around one node instead of the whole graph — the read to use when a screen or an agent needs the context of one entity. Returns the start node, every node within depth hops of it, the relations whose both ends are in that set, and truncated true when the node limit cut the walk short. direction chooses which way relations are followed; as_of and include_invalid read the graph as those parameters do elsewhere. Visibility is exactly nodes.retrieve's — a node you may reach but not read comes back restricted with its name only, and relations touching it are withheld, so this read never reaches further than a node read does. The node id comes from nodes.list, nodes.create or a changeset; an unknown one answers ONTOLOGY_NODE_NOT_FOUND, the same answer nodes.retrieve gives.
|
|
3362
|
+
*/
|
|
3363
|
+
export declare const ontologyNeighborhood: <ThrowOnError extends boolean = false>(options: Options<OntologyNeighborhoodData, ThrowOnError>) => RequestResult<OntologyNeighborhoodResponses, OntologyNeighborhoodErrors, ThrowOnError>;
|
|
3364
|
+
/**
|
|
3365
|
+
* Merge node
|
|
3366
|
+
*
|
|
3367
|
+
* 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.
|
|
3368
|
+
*/
|
|
3369
|
+
export declare const ontologyMergeNode: <ThrowOnError extends boolean = false>(options: Options<OntologyMergeNodeData, ThrowOnError>) => RequestResult<OntologyMergeNodeResponses, OntologyMergeNodeErrors, ThrowOnError>;
|
|
3370
|
+
/**
|
|
3371
|
+
* List relations
|
|
3372
|
+
*
|
|
3373
|
+
* 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.
|
|
3374
|
+
*/
|
|
3375
|
+
export declare const ontologyListRelations: <ThrowOnError extends boolean = false>(options?: Options<OntologyListRelationsData, ThrowOnError>) => RequestResult<OntologyListRelationsResponses, OntologyListRelationsErrors, ThrowOnError>;
|
|
3376
|
+
/**
|
|
3377
|
+
* Create relation
|
|
3378
|
+
*
|
|
3379
|
+
* 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; it does not give any agent a memory.
|
|
3380
|
+
*/
|
|
3381
|
+
export declare const ontologyCreateRelation: <ThrowOnError extends boolean = false>(options: Options<OntologyCreateRelationData, ThrowOnError>) => RequestResult<OntologyCreateRelationResponses, OntologyCreateRelationErrors, ThrowOnError>;
|
|
3382
|
+
/**
|
|
3383
|
+
* Retrieve relation
|
|
3384
|
+
*
|
|
3385
|
+
* 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.
|
|
3386
|
+
*/
|
|
3387
|
+
export declare const ontologyRetrieveRelation: <ThrowOnError extends boolean = false>(options: Options<OntologyRetrieveRelationData, ThrowOnError>) => RequestResult<OntologyRetrieveRelationResponses, OntologyRetrieveRelationErrors, ThrowOnError>;
|
|
3388
|
+
/**
|
|
3389
|
+
* Invalidate relation
|
|
3390
|
+
*
|
|
3391
|
+
* 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.
|
|
3392
|
+
*/
|
|
3393
|
+
export declare const ontologyInvalidateRelation: <ThrowOnError extends boolean = false>(options: Options<OntologyInvalidateRelationData, ThrowOnError>) => RequestResult<OntologyInvalidateRelationResponses, OntologyInvalidateRelationErrors, ThrowOnError>;
|
|
3394
|
+
/**
|
|
3395
|
+
* Apply changeset
|
|
3396
|
+
*
|
|
3397
|
+
* 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.
|
|
3398
|
+
*/
|
|
3399
|
+
export declare const ontologyApplyChangeset: <ThrowOnError extends boolean = false>(options: Options<OntologyApplyChangesetData, ThrowOnError>) => RequestResult<OntologyApplyChangesetResponses, OntologyApplyChangesetErrors, ThrowOnError>;
|
|
3400
|
+
/**
|
|
3401
|
+
* Search nodes
|
|
3402
|
+
*
|
|
3403
|
+
* 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's recall, which reads the graph from that agent's own viewpoint inside its sessions.
|
|
3404
|
+
*/
|
|
3405
|
+
export declare const ontologySearch: <ThrowOnError extends boolean = false>(options: Options<OntologySearchData, ThrowOnError>) => RequestResult<OntologySearchResponses, OntologySearchErrors, ThrowOnError>;
|
|
3406
|
+
/**
|
|
3407
|
+
* List sandboxes (v2)
|
|
3408
|
+
*
|
|
3409
|
+
* 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.
|
|
3410
|
+
*/
|
|
3411
|
+
export declare const getSandboxV1Sandboxes: <ThrowOnError extends boolean = false>(options?: Options<GetSandboxV1SandboxesData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesResponses, GetSandboxV1SandboxesErrors, ThrowOnError>;
|
|
3412
|
+
/**
|
|
3413
|
+
* Create sandbox (v2)
|
|
3414
|
+
*
|
|
3415
|
+
* Create a sandbox from a template. Every sandbox declares its lifecycle at creation. On the own face (X-Praxis-Face: own-v1) send ephemeral: true for an ephemeral sandbox (never pauses, cannot be snapshotted, deleted when it ends; for jobs such as transcodes, scripts and builds) or ephemeral: false for a persistent one (pauses and resumes, snapshots, mounts volumes, kept after it stops; for long-lived computers). Leaving ephemeral out returns INVALID_PARAMS. autoPause: true, onExpire: pause, autoPauseMemory, autoResume, idleTimeout, retention and volumes belong to persistent sandboxes and need ephemeral: false. Choose persistent only for long-lived computers. On the E2B-compatible face autoPause is the declaration: true is persistent, false or absent is ephemeral and ends at its timeout. Responses carry ephemeral. When a sandbox's machine has ended (timeout, kill, retention, provider loss), reaching it returns SANDBOX_EXPIRED (410) with terminationReason in the message: its files are gone, create a new sandbox.
|
|
3416
|
+
*/
|
|
3417
|
+
export declare const postSandboxV1Sandboxes: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesResponses, PostSandboxV1SandboxesErrors, ThrowOnError>;
|
|
3418
|
+
/**
|
|
3419
|
+
* Sandbox metrics
|
|
3420
|
+
*
|
|
3421
|
+
* 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.
|
|
3422
|
+
*/
|
|
3423
|
+
export declare const getSandboxV1SandboxesBySandboxIdMetrics: <ThrowOnError extends boolean = false>(options: Options<GetSandboxV1SandboxesBySandboxIdMetricsData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesBySandboxIdMetricsResponses, GetSandboxV1SandboxesBySandboxIdMetricsErrors, ThrowOnError>;
|
|
3424
|
+
/**
|
|
3425
|
+
* Pause sandbox
|
|
3426
|
+
*
|
|
3427
|
+
* 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.
|
|
3428
|
+
*/
|
|
3429
|
+
export declare const postSandboxV1SandboxesBySandboxIdPause: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdPauseData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdPauseResponses, PostSandboxV1SandboxesBySandboxIdPauseErrors, ThrowOnError>;
|
|
3430
|
+
/**
|
|
3431
|
+
* Set sandbox timeout
|
|
3432
|
+
*
|
|
3433
|
+
* 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.
|
|
3434
|
+
*/
|
|
3435
|
+
export declare const postSandboxV1SandboxesBySandboxIdTimeout: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdTimeoutData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdTimeoutResponses, PostSandboxV1SandboxesBySandboxIdTimeoutErrors, ThrowOnError>;
|
|
3436
|
+
/**
|
|
3437
|
+
* Connect sandbox (v2)
|
|
3438
|
+
*
|
|
3439
|
+
* 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.
|
|
2715
3440
|
*/
|
|
2716
3441
|
export declare const postSandboxV1SandboxesBySandboxIdConnect: <ThrowOnError extends boolean = false>(options: Options<PostSandboxV1SandboxesBySandboxIdConnectData, ThrowOnError>) => RequestResult<PostSandboxV1SandboxesBySandboxIdConnectResponses, PostSandboxV1SandboxesBySandboxIdConnectErrors, ThrowOnError>;
|
|
2717
3442
|
/**
|
|
@@ -2786,6 +3511,12 @@ export declare const putSandboxV1SandboxesBySandboxIdNetwork: <ThrowOnError exte
|
|
|
2786
3511
|
* 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.
|
|
2787
3512
|
*/
|
|
2788
3513
|
export declare const getSandboxV1SandboxesBySandboxIdLogs: <ThrowOnError extends boolean = false>(options: Options<GetSandboxV1SandboxesBySandboxIdLogsData, ThrowOnError>) => RequestResult<GetSandboxV1SandboxesBySandboxIdLogsResponses, GetSandboxV1SandboxesBySandboxIdLogsErrors, ThrowOnError>;
|
|
3514
|
+
/**
|
|
3515
|
+
* Get sandbox events
|
|
3516
|
+
*
|
|
3517
|
+
* Read one sandbox's lifecycle events, newest first by default. Unlike every other read on this face, it answers for a sandbox whose machine has ENDED (killed or failed) — a sandbox's cause of death is readable here even after its files are gone. The killed event carries eventData.terminationReason (the platform's own reason: requested, lease_expired, max_running, provider_lost, start_failed, retention, admin, unknown) and eventData.kill_reason (the E2B-shaped bucket: request, timeout, admin, orphaned, unknown); the updated event carries expiresAt. Page with offset, limit (1–100, default 10), orderAsc and repeatable types. An ended sandbox that is never going to come back also answers SANDBOX_EXPIRED (410) with terminationReason on its files and commands.
|
|
3518
|
+
*/
|
|
3519
|
+
export declare const getSandboxEvents: <ThrowOnError extends boolean = false>(options: Options<GetSandboxEventsData, ThrowOnError>) => RequestResult<GetSandboxEventsResponses, GetSandboxEventsErrors, ThrowOnError>;
|
|
2789
3520
|
/**
|
|
2790
3521
|
* Start template build (v2)
|
|
2791
3522
|
*
|
|
@@ -2858,6 +3589,456 @@ export declare const searchCrawl: <ThrowOnError extends boolean = false>(options
|
|
|
2858
3589
|
* Tavily Map traverses websites like a graph and can explore hundreds of paths in parallel with intelligent discovery to generate comprehensive site maps.
|
|
2859
3590
|
*/
|
|
2860
3591
|
export declare const searchMap: <ThrowOnError extends boolean = false>(options: Options<SearchMapData, ThrowOnError>) => RequestResult<SearchMapResponses, SearchMapErrors, ThrowOnError>;
|
|
3592
|
+
/**
|
|
3593
|
+
* List the genres Studio can write
|
|
3594
|
+
*
|
|
3595
|
+
* 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.
|
|
3596
|
+
*/
|
|
3597
|
+
export declare const studioGenresList: <ThrowOnError extends boolean = false>(options?: Options<StudioGenresListData, ThrowOnError>) => RequestResult<StudioGenresListResponses, StudioGenresListErrors, ThrowOnError>;
|
|
3598
|
+
/**
|
|
3599
|
+
* Read one genre with its built-in templates
|
|
3600
|
+
*
|
|
3601
|
+
* 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.
|
|
3602
|
+
*/
|
|
3603
|
+
export declare const studioGenresGet: <ThrowOnError extends boolean = false>(options: Options<StudioGenresGetData, ThrowOnError>) => RequestResult<StudioGenresGetResponses, StudioGenresGetErrors, ThrowOnError>;
|
|
3604
|
+
/**
|
|
3605
|
+
* List the platforms a work can be produced for
|
|
3606
|
+
*
|
|
3607
|
+
* 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.
|
|
3608
|
+
*/
|
|
3609
|
+
export declare const studioPlatformsList: <ThrowOnError extends boolean = false>(options?: Options<StudioPlatformsListData, ThrowOnError>) => RequestResult<StudioPlatformsListResponses, StudioPlatformsListErrors, ThrowOnError>;
|
|
3610
|
+
/**
|
|
3611
|
+
* Read the rules of one platform
|
|
3612
|
+
*
|
|
3613
|
+
* 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.
|
|
3614
|
+
*/
|
|
3615
|
+
export declare const studioPlatformsGet: <ThrowOnError extends boolean = false>(options: Options<StudioPlatformsGetData, ThrowOnError>) => RequestResult<StudioPlatformsGetResponses, StudioPlatformsGetErrors, ThrowOnError>;
|
|
3616
|
+
/**
|
|
3617
|
+
* List the works of this organization
|
|
3618
|
+
*
|
|
3619
|
+
* 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.
|
|
3620
|
+
*/
|
|
3621
|
+
export declare const studioWorksList: <ThrowOnError extends boolean = false>(options?: Options<StudioWorksListData, ThrowOnError>) => RequestResult<StudioWorksListResponses, StudioWorksListErrors, ThrowOnError>;
|
|
3622
|
+
/**
|
|
3623
|
+
* Create a work with its goal
|
|
3624
|
+
*
|
|
3625
|
+
* 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, and the one-sentence message. The work holds the goal only; the requirement for one piece (the person's text, its points, a length, banned wording) belongs to that draft and is given with the drafts create call, so a novel's plot points and length never bind the promotion derived from it. 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. A reference library belongs to the work and is created with it, so the setting written later stays this work's own; pass based_on to start from another work and have its setting and styles copied in as your own.
|
|
3626
|
+
*/
|
|
3627
|
+
export declare const studioWorksCreate: <ThrowOnError extends boolean = false>(options: Options<StudioWorksCreateData, ThrowOnError>) => RequestResult<StudioWorksCreateResponses, StudioWorksCreateErrors, ThrowOnError>;
|
|
3628
|
+
/**
|
|
3629
|
+
* Resolve a loose reference to a work, draft or unit
|
|
3630
|
+
*
|
|
3631
|
+
* 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.
|
|
3632
|
+
*/
|
|
3633
|
+
export declare const studioWorksResolve: <ThrowOnError extends boolean = false>(options: Options<StudioWorksResolveData, ThrowOnError>) => RequestResult<StudioWorksResolveResponses, StudioWorksResolveErrors, ThrowOnError>;
|
|
3634
|
+
/**
|
|
3635
|
+
* Read a work, optionally with one draft and unit
|
|
3636
|
+
*
|
|
3637
|
+
* 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.
|
|
3638
|
+
*/
|
|
3639
|
+
export declare const studioWorksGet: <ThrowOnError extends boolean = false>(options: Options<StudioWorksGetData, ThrowOnError>) => RequestResult<StudioWorksGetResponses, StudioWorksGetErrors, ThrowOnError>;
|
|
3640
|
+
/**
|
|
3641
|
+
* Change the title, goal or attached libraries
|
|
3642
|
+
*
|
|
3643
|
+
* 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.
|
|
3644
|
+
*/
|
|
3645
|
+
export declare const studioWorksUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioWorksUpdateData, ThrowOnError>) => RequestResult<StudioWorksUpdateResponses, StudioWorksUpdateErrors, ThrowOnError>;
|
|
3646
|
+
/**
|
|
3647
|
+
* List the drafts a work carries
|
|
3648
|
+
*
|
|
3649
|
+
* 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.
|
|
3650
|
+
*/
|
|
3651
|
+
export declare const studioDraftsList: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsListData, ThrowOnError>) => RequestResult<StudioDraftsListResponses, StudioDraftsListErrors, ThrowOnError>;
|
|
3652
|
+
/**
|
|
3653
|
+
* Create a draft of a genre inside a work
|
|
3654
|
+
*
|
|
3655
|
+
* 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.
|
|
3656
|
+
*/
|
|
3657
|
+
export declare const studioDraftsCreate: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsCreateData, ThrowOnError>) => RequestResult<StudioDraftsCreateResponses, StudioDraftsCreateErrors, ThrowOnError>;
|
|
3658
|
+
/**
|
|
3659
|
+
* Read one draft with optional units and todos
|
|
3660
|
+
*
|
|
3661
|
+
* 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.
|
|
3662
|
+
*/
|
|
3663
|
+
export declare const studioDraftsGet: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsGetData, ThrowOnError>) => RequestResult<StudioDraftsGetResponses, StudioDraftsGetErrors, ThrowOnError>;
|
|
3664
|
+
/**
|
|
3665
|
+
* Change a draft title, key, properties or style
|
|
3666
|
+
*
|
|
3667
|
+
* 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.
|
|
3668
|
+
*/
|
|
3669
|
+
export declare const studioDraftsUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsUpdateData, ThrowOnError>) => RequestResult<StudioDraftsUpdateResponses, StudioDraftsUpdateErrors, ThrowOnError>;
|
|
3670
|
+
/**
|
|
3671
|
+
* Add to or correct a draft's brief
|
|
3672
|
+
*
|
|
3673
|
+
* Extend the brief of one draft: append text, attach files, replace its constraints, add points taken from an outline, edit one point, or drop a point. The brief belongs to the draft, not the work: the length and plot points of a novel do not bind the promotion derived from it. 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 constraints (a length such as 3000 字以内, banned wording) are what the length check and the context pack read. The brief carries its own revision, separate from the draft's.
|
|
3674
|
+
*/
|
|
3675
|
+
export declare const studioDraftsUpdateBrief: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsUpdateBriefData, ThrowOnError>) => RequestResult<StudioDraftsUpdateBriefResponses, StudioDraftsUpdateBriefErrors, ThrowOnError>;
|
|
3676
|
+
/**
|
|
3677
|
+
* Read the whole unit outline as Markdown
|
|
3678
|
+
*
|
|
3679
|
+
* 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.
|
|
3680
|
+
*/
|
|
3681
|
+
export declare const studioDraftsOutline: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsOutlineData, ThrowOnError>) => RequestResult<StudioDraftsOutlineResponses, StudioDraftsOutlineErrors, ThrowOnError>;
|
|
3682
|
+
/**
|
|
3683
|
+
* List the foreshadows of a draft
|
|
3684
|
+
*
|
|
3685
|
+
* List the threads this draft sets up and pays off: each foreshadow names the unit that plants it, the unit that pays it off (or null while it is still open) and a note on what was planted. The foreshadow_paid check reports every open one in the draft's status and review, so a mystery or serial that plants a clue in chapter 2 is reminded until a later chapter answers it.
|
|
3686
|
+
*/
|
|
3687
|
+
export declare const studioForeshadowsList: <ThrowOnError extends boolean = false>(options: Options<StudioForeshadowsListData, ThrowOnError>) => RequestResult<StudioForeshadowsListResponses, StudioForeshadowsListErrors, ThrowOnError>;
|
|
3688
|
+
/**
|
|
3689
|
+
* Drop a foreshadow
|
|
3690
|
+
*
|
|
3691
|
+
* Remove a thread that is no longer in the story. Deleting a key that does not exist answers the same as deleting one that did.
|
|
3692
|
+
*/
|
|
3693
|
+
export declare const studioForeshadowsDelete: <ThrowOnError extends boolean = false>(options: Options<StudioForeshadowsDeleteData, ThrowOnError>) => RequestResult<StudioForeshadowsDeleteResponses, StudioForeshadowsDeleteErrors, ThrowOnError>;
|
|
3694
|
+
/**
|
|
3695
|
+
* Plant or pay off a foreshadow
|
|
3696
|
+
*
|
|
3697
|
+
* Record a thread under a key of your choice: the unit that plants it and, once written, the unit that pays it off. Call it when you write the setup (payoff left out or null) and again with the same key when a later unit answers it. Both units must belong to this draft. An open foreshadow is reported by the foreshadow_paid check until it has a payoff, and a unit's context pack does not need to be asked for it.
|
|
3698
|
+
*/
|
|
3699
|
+
export declare const studioForeshadowsUpsert: <ThrowOnError extends boolean = false>(options: Options<StudioForeshadowsUpsertData, ThrowOnError>) => RequestResult<StudioForeshadowsUpsertResponses, StudioForeshadowsUpsertErrors, ThrowOnError>;
|
|
3700
|
+
/**
|
|
3701
|
+
* List the setting changes of a work
|
|
3702
|
+
*
|
|
3703
|
+
* List the recorded changes, all of them or those of one entry. Use it to check what a character has been through before writing the next unit, or to find a progression to delete.
|
|
3704
|
+
*/
|
|
3705
|
+
export declare const studioProgressionsList: <ThrowOnError extends boolean = false>(options: Options<StudioProgressionsListData, ThrowOnError>) => RequestResult<StudioProgressionsListResponses, StudioProgressionsListErrors, ThrowOnError>;
|
|
3706
|
+
/**
|
|
3707
|
+
* Record how a setting entry changes at a unit
|
|
3708
|
+
*
|
|
3709
|
+
* Record that an entry changes as of one unit: a character is injured in chapter 6, a shop moves in chapter 9, a secret becomes known. The library keeps what an entry is from the start; a progression keeps what becomes true later. A unit's context pack shows an entry's changes up to and including that unit (截至本单元的设定变化) and withholds the later ones, so chapter 3 is not written with chapter 6's injury. Name the entry by its name, an alias or its ent_ identifier, and the unit by its number.
|
|
3710
|
+
*/
|
|
3711
|
+
export declare const studioProgressionsCreate: <ThrowOnError extends boolean = false>(options: Options<StudioProgressionsCreateData, ThrowOnError>) => RequestResult<StudioProgressionsCreateResponses, StudioProgressionsCreateErrors, ThrowOnError>;
|
|
3712
|
+
/**
|
|
3713
|
+
* Delete a setting change
|
|
3714
|
+
*
|
|
3715
|
+
* Remove one recorded change, by the prg_ identifier the list returns; to correct a change, delete it and record the new one.
|
|
3716
|
+
*/
|
|
3717
|
+
export declare const studioProgressionsDelete: <ThrowOnError extends boolean = false>(options: Options<StudioProgressionsDeleteData, ThrowOnError>) => RequestResult<StudioProgressionsDeleteResponses, StudioProgressionsDeleteErrors, ThrowOnError>;
|
|
3718
|
+
/**
|
|
3719
|
+
* Read the computed todo list of a draft
|
|
3720
|
+
*
|
|
3721
|
+
* 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.
|
|
3722
|
+
*/
|
|
3723
|
+
export declare const studioDraftsStatus: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsStatusData, ThrowOnError>) => RequestResult<StudioDraftsStatusResponses, StudioDraftsStatusErrors, ThrowOnError>;
|
|
3724
|
+
/**
|
|
3725
|
+
* Read a review pass over the whole draft
|
|
3726
|
+
*
|
|
3727
|
+
* 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.
|
|
3728
|
+
*/
|
|
3729
|
+
export declare const studioDraftsReview: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsReviewData, ThrowOnError>) => RequestResult<StudioDraftsReviewResponses, StudioDraftsReviewErrors, ThrowOnError>;
|
|
3730
|
+
/**
|
|
3731
|
+
* Confirm a draft already follows its source
|
|
3732
|
+
*
|
|
3733
|
+
* 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.
|
|
3734
|
+
*/
|
|
3735
|
+
export declare const studioDraftsRebase: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsRebaseData, ThrowOnError>) => RequestResult<StudioDraftsRebaseResponses, StudioDraftsRebaseErrors, ThrowOnError>;
|
|
3736
|
+
/**
|
|
3737
|
+
* Export the draft as Markdown or plain text
|
|
3738
|
+
*
|
|
3739
|
+
* 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.
|
|
3740
|
+
*/
|
|
3741
|
+
export declare const studioDraftsExport: <ThrowOnError extends boolean = false>(options: Options<StudioDraftsExportData, ThrowOnError>) => RequestResult<StudioDraftsExportResponses, StudioDraftsExportErrors, ThrowOnError>;
|
|
3742
|
+
/**
|
|
3743
|
+
* Add one unit to the draft tree
|
|
3744
|
+
*
|
|
3745
|
+
* 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.
|
|
3746
|
+
*/
|
|
3747
|
+
export declare const studioUnitsCreate: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsCreateData, ThrowOnError>) => RequestResult<StudioUnitsCreateResponses, StudioUnitsCreateErrors, ThrowOnError>;
|
|
3748
|
+
/**
|
|
3749
|
+
* Add a whole outline of units at once
|
|
3750
|
+
*
|
|
3751
|
+
* 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.
|
|
3752
|
+
*/
|
|
3753
|
+
export declare const studioUnitsBatchCreate: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsBatchCreateData, ThrowOnError>) => RequestResult<StudioUnitsBatchCreateResponses, StudioUnitsBatchCreateErrors, ThrowOnError>;
|
|
3754
|
+
/**
|
|
3755
|
+
* Write intents for many units in one call
|
|
3756
|
+
*
|
|
3757
|
+
* 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.
|
|
3758
|
+
*/
|
|
3759
|
+
export declare const studioUnitsBatchUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsBatchUpdateData, ThrowOnError>) => RequestResult<StudioUnitsBatchUpdateResponses, StudioUnitsBatchUpdateErrors, ThrowOnError>;
|
|
3760
|
+
/**
|
|
3761
|
+
* Read one unit with its blocks and Markdown
|
|
3762
|
+
*
|
|
3763
|
+
* 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.
|
|
3764
|
+
*/
|
|
3765
|
+
export declare const studioUnitsGet: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsGetData, ThrowOnError>) => RequestResult<StudioUnitsGetResponses, StudioUnitsGetErrors, ThrowOnError>;
|
|
3766
|
+
/**
|
|
3767
|
+
* Change a unit intent, body or status
|
|
3768
|
+
*
|
|
3769
|
+
* 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.
|
|
3770
|
+
*/
|
|
3771
|
+
export declare const studioUnitsUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsUpdateData, ThrowOnError>) => RequestResult<StudioUnitsUpdateResponses, StudioUnitsUpdateErrors, ThrowOnError>;
|
|
3772
|
+
/**
|
|
3773
|
+
* Move a unit to another place in the tree
|
|
3774
|
+
*
|
|
3775
|
+
* 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.
|
|
3776
|
+
*/
|
|
3777
|
+
export declare const studioUnitsMove: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsMoveData, ThrowOnError>) => RequestResult<StudioUnitsMoveResponses, StudioUnitsMoveErrors, ThrowOnError>;
|
|
3778
|
+
/**
|
|
3779
|
+
* Edit a unit body block by block
|
|
3780
|
+
*
|
|
3781
|
+
* 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.
|
|
3782
|
+
*/
|
|
3783
|
+
export declare const studioUnitsPatchBlocks: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsPatchBlocksData, ThrowOnError>) => RequestResult<StudioUnitsPatchBlocksResponses, StudioUnitsPatchBlocksErrors, ThrowOnError>;
|
|
3784
|
+
/**
|
|
3785
|
+
* Read the context pack for writing one unit
|
|
3786
|
+
*
|
|
3787
|
+
* 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.
|
|
3788
|
+
*/
|
|
3789
|
+
export declare const studioUnitsContext: <ThrowOnError extends boolean = false>(options: Options<StudioUnitsContextData, ThrowOnError>) => RequestResult<StudioUnitsContextResponses, StudioUnitsContextErrors, ThrowOnError>;
|
|
3790
|
+
/**
|
|
3791
|
+
* List the reference libraries of this organization
|
|
3792
|
+
*
|
|
3793
|
+
* 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. Pass work to read one work's own library alone; leave it out for every library the organization owns.
|
|
3794
|
+
*/
|
|
3795
|
+
export declare const studioCodexesList: <ThrowOnError extends boolean = false>(options?: Options<StudioCodexesListData, ThrowOnError>) => RequestResult<StudioCodexesListResponses, StudioCodexesListErrors, ThrowOnError>;
|
|
3796
|
+
/**
|
|
3797
|
+
* Create a reference library
|
|
3798
|
+
*
|
|
3799
|
+
* Create a reference library: a store of the people, places, products and facts a piece draws on. 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 made this way is shared across works, which suits brand facts several pieces mention; the library a work needs for its own setting is created with the work itself, and the work list call finds it by filtering on work.
|
|
3800
|
+
*/
|
|
3801
|
+
export declare const studioCodexesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioCodexesCreateData, ThrowOnError>) => RequestResult<StudioCodexesCreateResponses, StudioCodexesCreateErrors, ThrowOnError>;
|
|
3802
|
+
/**
|
|
3803
|
+
* Delete a reference library
|
|
3804
|
+
*
|
|
3805
|
+
* 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.
|
|
3806
|
+
*/
|
|
3807
|
+
export declare const studioCodexesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioCodexesDeleteData, ThrowOnError>) => RequestResult<StudioCodexesDeleteResponses, StudioCodexesDeleteErrors, ThrowOnError>;
|
|
3808
|
+
/**
|
|
3809
|
+
* Read one reference library
|
|
3810
|
+
*
|
|
3811
|
+
* 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.
|
|
3812
|
+
*/
|
|
3813
|
+
export declare const studioCodexesGet: <ThrowOnError extends boolean = false>(options: Options<StudioCodexesGetData, ThrowOnError>) => RequestResult<StudioCodexesGetResponses, StudioCodexesGetErrors, ThrowOnError>;
|
|
3814
|
+
/**
|
|
3815
|
+
* Rename a reference library or change its description
|
|
3816
|
+
*
|
|
3817
|
+
* 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.
|
|
3818
|
+
*/
|
|
3819
|
+
export declare const studioCodexesUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioCodexesUpdateData, ThrowOnError>) => RequestResult<StudioCodexesUpdateResponses, StudioCodexesUpdateErrors, ThrowOnError>;
|
|
3820
|
+
/**
|
|
3821
|
+
* List the entries of a reference library
|
|
3822
|
+
*
|
|
3823
|
+
* 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.
|
|
3824
|
+
*/
|
|
3825
|
+
export declare const studioEntriesList: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesListData, ThrowOnError>) => RequestResult<StudioEntriesListResponses, StudioEntriesListErrors, ThrowOnError>;
|
|
3826
|
+
/**
|
|
3827
|
+
* Add an entry to a reference library
|
|
3828
|
+
*
|
|
3829
|
+
* 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, notes, facts and story time that should reach a writer when it is mentioned. Attach a picture gallery when the entry should be looked at as well as read. 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.
|
|
3830
|
+
*/
|
|
3831
|
+
export declare const studioEntriesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesCreateData, ThrowOnError>) => RequestResult<StudioEntriesCreateResponses, StudioEntriesCreateErrors, ThrowOnError>;
|
|
3832
|
+
/**
|
|
3833
|
+
* Delete a reference entry
|
|
3834
|
+
*
|
|
3835
|
+
* 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.
|
|
3836
|
+
*/
|
|
3837
|
+
export declare const studioEntriesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesDeleteData, ThrowOnError>) => RequestResult<StudioEntriesDeleteResponses, StudioEntriesDeleteErrors, ThrowOnError>;
|
|
3838
|
+
/**
|
|
3839
|
+
* Read one reference entry
|
|
3840
|
+
*
|
|
3841
|
+
* Read one entry in full: its description, its notes, its fact ledger, its relations to other entries, its story time, its detection settings and its picture gallery. 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.
|
|
3842
|
+
*/
|
|
3843
|
+
export declare const studioEntriesGet: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesGetData, ThrowOnError>) => RequestResult<StudioEntriesGetResponses, StudioEntriesGetErrors, ThrowOnError>;
|
|
3844
|
+
/**
|
|
3845
|
+
* Change what a reference entry says
|
|
3846
|
+
*
|
|
3847
|
+
* Change one entry: its type, its name, its aliases, its description, its facts, its notes, its story time, its tracking setting, its picture gallery 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.
|
|
3848
|
+
*/
|
|
3849
|
+
export declare const studioEntriesUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioEntriesUpdateData, ThrowOnError>) => RequestResult<StudioEntriesUpdateResponses, StudioEntriesUpdateErrors, ThrowOnError>;
|
|
3850
|
+
/**
|
|
3851
|
+
* List the writing styles of this organization
|
|
3852
|
+
*
|
|
3853
|
+
* 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.
|
|
3854
|
+
*/
|
|
3855
|
+
export declare const studioStylesList: <ThrowOnError extends boolean = false>(options?: Options<StudioStylesListData, ThrowOnError>) => RequestResult<StudioStylesListResponses, StudioStylesListErrors, ThrowOnError>;
|
|
3856
|
+
/**
|
|
3857
|
+
* Create a writing style
|
|
3858
|
+
*
|
|
3859
|
+
* 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. A style belongs to the work you name in work, and a work may only attach its own styles, so create the style with the work it will be used in. Attach a style to a work, or to one draft of it, and its samples then reach every context pack.
|
|
3860
|
+
*/
|
|
3861
|
+
export declare const studioStylesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioStylesCreateData, ThrowOnError>) => RequestResult<StudioStylesCreateResponses, StudioStylesCreateErrors, ThrowOnError>;
|
|
3862
|
+
/**
|
|
3863
|
+
* Delete a writing style
|
|
3864
|
+
*
|
|
3865
|
+
* 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.
|
|
3866
|
+
*/
|
|
3867
|
+
export declare const studioStylesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioStylesDeleteData, ThrowOnError>) => RequestResult<StudioStylesDeleteResponses, StudioStylesDeleteErrors, ThrowOnError>;
|
|
3868
|
+
/**
|
|
3869
|
+
* Read one writing style
|
|
3870
|
+
*
|
|
3871
|
+
* 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.
|
|
3872
|
+
*/
|
|
3873
|
+
export declare const studioStylesGet: <ThrowOnError extends boolean = false>(options: Options<StudioStylesGetData, ThrowOnError>) => RequestResult<StudioStylesGetResponses, StudioStylesGetErrors, ThrowOnError>;
|
|
3874
|
+
/**
|
|
3875
|
+
* Change a writing style
|
|
3876
|
+
*
|
|
3877
|
+
* Change a style: its name, its description, its samples, its picture 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.
|
|
3878
|
+
*/
|
|
3879
|
+
export declare const studioStylesUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioStylesUpdateData, ThrowOnError>) => RequestResult<StudioStylesUpdateResponses, StudioStylesUpdateErrors, ThrowOnError>;
|
|
3880
|
+
/**
|
|
3881
|
+
* List the templates a genre can start from
|
|
3882
|
+
*
|
|
3883
|
+
* 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.
|
|
3884
|
+
*/
|
|
3885
|
+
export declare const studioTemplatesList: <ThrowOnError extends boolean = false>(options?: Options<StudioTemplatesListData, ThrowOnError>) => RequestResult<StudioTemplatesListResponses, StudioTemplatesListErrors, ThrowOnError>;
|
|
3886
|
+
/**
|
|
3887
|
+
* Save a starting structure as a template
|
|
3888
|
+
*
|
|
3889
|
+
* 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.
|
|
3890
|
+
*/
|
|
3891
|
+
export declare const studioTemplatesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioTemplatesCreateData, ThrowOnError>) => RequestResult<StudioTemplatesCreateResponses, StudioTemplatesCreateErrors, ThrowOnError>;
|
|
3892
|
+
/**
|
|
3893
|
+
* Delete a saved template
|
|
3894
|
+
*
|
|
3895
|
+
* 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.
|
|
3896
|
+
*/
|
|
3897
|
+
export declare const studioTemplatesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioTemplatesDeleteData, ThrowOnError>) => RequestResult<StudioTemplatesDeleteResponses, StudioTemplatesDeleteErrors, ThrowOnError>;
|
|
3898
|
+
/**
|
|
3899
|
+
* Read one template
|
|
3900
|
+
*
|
|
3901
|
+
* 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.
|
|
3902
|
+
*/
|
|
3903
|
+
export declare const studioTemplatesGet: <ThrowOnError extends boolean = false>(options: Options<StudioTemplatesGetData, ThrowOnError>) => RequestResult<StudioTemplatesGetResponses, StudioTemplatesGetErrors, ThrowOnError>;
|
|
3904
|
+
/**
|
|
3905
|
+
* List the rendition themes of a platform
|
|
3906
|
+
*
|
|
3907
|
+
* 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. The first page starts with the built-in themes (builtin true, such as warm-card@1 for Xiaohongshu cards and plain-mono@1 for WeChat articles), which every organization can use and nobody can change or delete; your organization's own themes follow. 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.
|
|
3908
|
+
*/
|
|
3909
|
+
export declare const studioThemesList: <ThrowOnError extends boolean = false>(options?: Options<StudioThemesListData, ThrowOnError>) => RequestResult<StudioThemesListResponses, StudioThemesListErrors, ThrowOnError>;
|
|
3910
|
+
/**
|
|
3911
|
+
* Create a rendition theme
|
|
3912
|
+
*
|
|
3913
|
+
* 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.
|
|
3914
|
+
*/
|
|
3915
|
+
export declare const studioThemesCreate: <ThrowOnError extends boolean = false>(options: Options<StudioThemesCreateData, ThrowOnError>) => RequestResult<StudioThemesCreateResponses, StudioThemesCreateErrors, ThrowOnError>;
|
|
3916
|
+
/**
|
|
3917
|
+
* Delete a rendition theme
|
|
3918
|
+
*
|
|
3919
|
+
* 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.
|
|
3920
|
+
*/
|
|
3921
|
+
export declare const studioThemesDelete: <ThrowOnError extends boolean = false>(options: Options<StudioThemesDeleteData, ThrowOnError>) => RequestResult<StudioThemesDeleteResponses, StudioThemesDeleteErrors, ThrowOnError>;
|
|
3922
|
+
/**
|
|
3923
|
+
* Read one rendition theme
|
|
3924
|
+
*
|
|
3925
|
+
* 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.
|
|
3926
|
+
*/
|
|
3927
|
+
export declare const studioThemesGet: <ThrowOnError extends boolean = false>(options: Options<StudioThemesGetData, ThrowOnError>) => RequestResult<StudioThemesGetResponses, StudioThemesGetErrors, ThrowOnError>;
|
|
3928
|
+
/**
|
|
3929
|
+
* Change a rendition theme
|
|
3930
|
+
*
|
|
3931
|
+
* 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.
|
|
3932
|
+
*/
|
|
3933
|
+
export declare const studioThemesUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioThemesUpdateData, ThrowOnError>) => RequestResult<StudioThemesUpdateResponses, StudioThemesUpdateErrors, ThrowOnError>;
|
|
3934
|
+
/**
|
|
3935
|
+
* Create a rendition of a draft for a platform
|
|
3936
|
+
*
|
|
3937
|
+
* Create a rendition: the form of one draft that a platform receives, such as a Xiaohongshu card set, a DOCX file or a Markdown file. Read the platform first with the platform call and pass its versioned key; pass a theme only to override the platform's default layout. Pass render true to render in the same call and read render_state and issues in the answer; without it the rendition starts as pending and the render call produces it. Rendering a Xiaohongshu card set is billed by Browser Rendering time (meter browser_ms, product studio-render); DOCX and Markdown renditions are not billed. A draft with no body renders as invalid with a draft_empty issue, and an unavailable render service leaves render_state failed with a render_unavailable issue, so repeat the render call later. Send a request_id to make a repeated call return the first rendition instead of creating another. Next, publish the rendition to export it.
|
|
3938
|
+
*/
|
|
3939
|
+
export declare const studioRenditionsCreate: <ThrowOnError extends boolean = false>(options: Options<StudioRenditionsCreateData, ThrowOnError>) => RequestResult<StudioRenditionsCreateResponses, StudioRenditionsCreateErrors, ThrowOnError>;
|
|
3940
|
+
/**
|
|
3941
|
+
* List the renditions of a work
|
|
3942
|
+
*
|
|
3943
|
+
* List the renditions of one work, each with its platform, render state, stale flag and publish state. Pass draft to see only the renditions of one draft. Use it to find the rendition to publish or to render again, and read stale before exporting: a stale rendition was built from an older draft and cannot be exported until the render call has rebuilt it. The answer is one page; keep following next_page_token while it is present.
|
|
3944
|
+
*/
|
|
3945
|
+
export declare const studioRenditionsList: <ThrowOnError extends boolean = false>(options: Options<StudioRenditionsListData, ThrowOnError>) => RequestResult<StudioRenditionsListResponses, StudioRenditionsListErrors, ThrowOnError>;
|
|
3946
|
+
/**
|
|
3947
|
+
* Delete a rendition
|
|
3948
|
+
*
|
|
3949
|
+
* Delete a rendition and stop listing it. The draft it was built from is untouched, and a new rendition can be created from it at any time. Files already downloaded from an earlier export are not affected. Use it to clear a failed or abandoned rendition; to refresh one, call the render operation instead.
|
|
3950
|
+
*/
|
|
3951
|
+
export declare const studioRenditionsDelete: <ThrowOnError extends boolean = false>(options: Options<StudioRenditionsDeleteData, ThrowOnError>) => RequestResult<StudioRenditionsDeleteResponses, StudioRenditionsDeleteErrors, ThrowOnError>;
|
|
3952
|
+
/**
|
|
3953
|
+
* Read one rendition
|
|
3954
|
+
*
|
|
3955
|
+
* Read one rendition in full: its render state, the validation issues the render found, the parts (one per card page or thread post), the files it produced and its publish state. Call it after create, render or publish to see the outcome, because a render that finished invalid or failed is reported here and not as an HTTP error. stale is true when the draft has changed since source_revision; call the render operation before exporting a stale rendition.
|
|
3956
|
+
*/
|
|
3957
|
+
export declare const studioRenditionsGet: <ThrowOnError extends boolean = false>(options: Options<StudioRenditionsGetData, ThrowOnError>) => RequestResult<StudioRenditionsGetResponses, StudioRenditionsGetErrors, ThrowOnError>;
|
|
3958
|
+
/**
|
|
3959
|
+
* Change the theme or settings of a rendition
|
|
3960
|
+
*
|
|
3961
|
+
* Change a rendition's theme or settings. Send update_mask naming exactly the fields you change, such as theme or settings; a field left out keeps its value. The produced files are not rebuilt by this call, so call the render operation afterwards to apply the change. A rendition whose export or publish has started is locked and answers RENDITION_PUBLISH_LOCKED; create a new rendition for new content.
|
|
3962
|
+
*/
|
|
3963
|
+
export declare const studioRenditionsUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioRenditionsUpdateData, ThrowOnError>) => RequestResult<StudioRenditionsUpdateResponses, StudioRenditionsUpdateErrors, ThrowOnError>;
|
|
3964
|
+
/**
|
|
3965
|
+
* Render a rendition again from the current draft
|
|
3966
|
+
*
|
|
3967
|
+
* Render the rendition from the draft as it is now, replacing its parts and files and clearing stale. Call it after the draft changed, after a theme or settings change, or after a failed render. The answer carries render_state: rendered, invalid when the draft has an error-level issue (for example draft_empty on a draft with no body), or failed when the render service was unavailable (issue render_unavailable; repeat later). A render does not fail the HTTP call for those outcomes, so read render_state and issues. Rendering a Xiaohongshu card set is billed by Browser Rendering time (meter browser_ms, product studio-render); DOCX and Markdown are not billed. Rendering the same rendition twice at once answers REVISION_CONFLICT; retry shortly. Next, publish the rendition to export it.
|
|
3968
|
+
*/
|
|
3969
|
+
export declare const studioRenditionsRender: <ThrowOnError extends boolean = false>(options: Options<StudioRenditionsRenderData, ThrowOnError>) => RequestResult<StudioRenditionsRenderResponses, StudioRenditionsRenderErrors, ThrowOnError>;
|
|
3970
|
+
/**
|
|
3971
|
+
* Export a rendition
|
|
3972
|
+
*
|
|
3973
|
+
* Export a rendition for the platforms that deliver a file: markdown@1, docx@1 and xiaohongshu@1 end with publish.state exported, and a card rendition gains one ZIP of its pages in files. Publishing to a platform account such as X or WeChat is not available yet and answers PLATFORM_NOT_AVAILABLE; export instead. The rendition must be rendered, not stale and without error-level issues: RENDITION_NOT_RENDERED means call the render operation first, RENDITION_STALE means the draft changed so render again, RENDITION_INVALID means fix the draft problems listed in issues and render again. Exporting the same rendition twice at once answers REVISION_CONFLICT; retry shortly. Next, call the content operation to download the file.
|
|
3974
|
+
*/
|
|
3975
|
+
export declare const studioRenditionsPublish: <ThrowOnError extends boolean = false>(options: Options<StudioRenditionsPublishData, ThrowOnError>) => RequestResult<StudioRenditionsPublishResponses, StudioRenditionsPublishErrors, ThrowOnError>;
|
|
3976
|
+
/**
|
|
3977
|
+
* Get a download URL for a rendition file
|
|
3978
|
+
*
|
|
3979
|
+
* Get a signed, short-lived URL to download what a rendition produced. Without part it points to the rendition's own first file: the ZIP of pages for a card rendition, the DOCX for docx@1. With part it points to that part's first file, such as one card PNG; a part that has no file, or a rendition not rendered yet, answers RENDITION_NOT_RENDERED, and an index no part has answers INVALID_PARAMS. Call it after a successful render or export, download the url before expire_time, and call again for a fresh one when it has expired. The URL is a credential: do not store or share it.
|
|
3980
|
+
*/
|
|
3981
|
+
export declare const studioRenditionsContentUrl: <ThrowOnError extends boolean = false>(options: Options<StudioRenditionsContentUrlData, ThrowOnError>) => RequestResult<StudioRenditionsContentUrlResponses, StudioRenditionsContentUrlErrors, ThrowOnError>;
|
|
3982
|
+
/**
|
|
3983
|
+
* List the blind review rounds of a work
|
|
3984
|
+
*
|
|
3985
|
+
* List the review rounds of one work, newest round first, each with its draft, round number, status and decision. Pass draft to see the rounds of one draft only. Use it to find the round to read, to answer or to cancel, and to see whether the draft already has a round running before sending another: a running round answers REVIEW_IN_PROGRESS. The answer is one page; keep following next_page_token while it is present. Rounds of other organizations are not listed and a work of another organization answers WORK_NOT_FOUND.
|
|
3986
|
+
*/
|
|
3987
|
+
export declare const studioWorksReviewsList: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewsListData, ThrowOnError>) => RequestResult<StudioWorksReviewsListResponses, StudioWorksReviewsListErrors, ThrowOnError>;
|
|
3988
|
+
/**
|
|
3989
|
+
* Send a draft to blind review
|
|
3990
|
+
*
|
|
3991
|
+
* Send one draft of this work to the blind review centre, which freezes the draft's content revision as it is now and asks in every reviewer on the work's roster whose kind this round asks. Use it once the draft is written; the roster decides who reviews, and the sender only ever reads labels A, B, C, never the reviewer identities. Pass mode to narrow this round to expert reviewers, to audience reviewers or to both, which the settings do not decide. From the second round pass revision_of with the previous round's rv_ id and note with the change note that answers that round point by point. The answer is the new round in status reviewing; read it again with the review read until status becomes decided and then read decision, expert_reports and screening. Billing follows the reviewers' sessions, not the frame of this call. DRAFT_NOT_READY means the draft still has units without a body or fails a hard check, so finish it first; REVIEW_IN_PROGRESS means this draft already has a round running, so wait for it to decide or cancel it; REVIEW_ROUND_LIMIT means the work reached max_rounds and a person has to raise it in the review settings; NO_REVIEWERS means the work's reviewer roster has nobody of the kind this round asks, so a person adds one to the work.
|
|
3992
|
+
*/
|
|
3993
|
+
export declare const studioWorksReviewsCreate: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewsCreateData, ThrowOnError>) => RequestResult<StudioWorksReviewsCreateResponses, StudioWorksReviewsCreateErrors, ThrowOnError>;
|
|
3994
|
+
/**
|
|
3995
|
+
* Read one blind review round
|
|
3996
|
+
*
|
|
3997
|
+
* Read one round in the sender's view: its status, the seats as labels A, B, C with the state of each, the expert reports that have come back, the screening cards, the round decision and the audience tally. Reviewers appear only as labels; who they are is never part of this answer. Call it after sending a round and repeat while status is reviewing, because reviewers answer asynchronously and a round that is not decided yet carries fewer reports. status decided gives decision and screening; cancelled means a person stopped the round; failed means it could not be completed, for example when no reviewer on the roster answered at all. Pass view=audit to also get the assignment record, the confidential editor notes and the reviewer sessions; that block is filled only for an organization administrator, and anyone else reads the same round without it.
|
|
3998
|
+
*/
|
|
3999
|
+
export declare const studioWorksReviewsRetrieve: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewsRetrieveData, ThrowOnError>) => RequestResult<StudioWorksReviewsRetrieveResponses, StudioWorksReviewsRetrieveErrors, ThrowOnError>;
|
|
4000
|
+
/**
|
|
4001
|
+
* Cancel a running review round
|
|
4002
|
+
*
|
|
4003
|
+
* Cancel a round that is still reviewing, so its reviewers are no longer waited for and the draft can be sent again. Nothing that came back is deleted: the round stays readable with status cancelled and the reports it had. Use it when the draft changed so much that the running round is no longer about the current text, or when the round was sent by mistake; a person makes this call, and an agent calling it is refused with PERMISSION_DENIED. A round that already reached a decision answers REVIEW_IN_PROGRESS, because a decided round is answered by sending the next round with revision_of rather than by cancelling it. Reviewer sessions already started keep being billed.
|
|
4004
|
+
*/
|
|
4005
|
+
export declare const studioWorksReviewsCancel: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewsCancelData, ThrowOnError>) => RequestResult<StudioWorksReviewsCancelResponses, StudioWorksReviewsCancelErrors, ThrowOnError>;
|
|
4006
|
+
/**
|
|
4007
|
+
* Read the review settings of a work
|
|
4008
|
+
*
|
|
4009
|
+
* Read how this work is reviewed: the most rounds it may take and the revision the settings are at. Who reviews is not here but on the work's reviewer roster, which every round asks whole, and read that with the reviewer list. Read this before sending a round, because a draft past its max_rounds answers REVIEW_ROUND_LIMIT, and before changing it, because the update carries the revision it returns as its precondition. Settings are not part of the work body: they are read and written here.
|
|
4010
|
+
*/
|
|
4011
|
+
export declare const studioWorksReviewSettingsRetrieve: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewSettingsRetrieveData, ThrowOnError>) => RequestResult<StudioWorksReviewSettingsRetrieveResponses, StudioWorksReviewSettingsRetrieveErrors, ThrowOnError>;
|
|
4012
|
+
/**
|
|
4013
|
+
* Change how many rounds a work may take
|
|
4014
|
+
*
|
|
4015
|
+
* Change how many rounds a work may take. Send expected_revision with the revision this settings read returned, so two writers cannot overwrite each other silently; a mismatch answers REVISION_CONFLICT and the settings are unchanged. A person makes this change: an agent calling it is refused with PERMISSION_DENIED. The settings are locked while a round of this work is reviewing, which answers REVIEW_IN_PROGRESS; change them after the round decides or is cancelled. Raising max_rounds is how a draft whose rounds are used up is sent again. The changed limit applies to rounds sent from now on and never rewrites a round already sent; who reviews is on the reviewer roster, not here.
|
|
4016
|
+
*/
|
|
4017
|
+
export declare const studioWorksReviewSettingsUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewSettingsUpdateData, ThrowOnError>) => RequestResult<StudioWorksReviewSettingsUpdateResponses, StudioWorksReviewSettingsUpdateErrors, ThrowOnError>;
|
|
4018
|
+
/**
|
|
4019
|
+
* List the reviewers of a work
|
|
4020
|
+
*
|
|
4021
|
+
* List the reviewers on this work's roster: every time a round of this work is sent, every reviewer on the roster whose kind the round asks for takes part, one seat each, in the order they were added, and the sender reads them as A, B, C. Each entry gives the agent id as /v1/agents returns it (agent_…), its kind on this roster and the service agent's display name. Read it before sending a round, because a roster with nobody of the asked kind answers NO_REVIEWERS; read it after to see who has been judging. A reviewer of another work or another organization is never listed, and a work of another organization answers WORK_NOT_FOUND. The answer is one page; keep following next_page_token while it is present.
|
|
4022
|
+
*/
|
|
4023
|
+
export declare const studioWorksReviewersList: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewersListData, ThrowOnError>) => RequestResult<StudioWorksReviewersListResponses, StudioWorksReviewersListErrors, ThrowOnError>;
|
|
4024
|
+
/**
|
|
4025
|
+
* Add a reviewer to a work
|
|
4026
|
+
*
|
|
4027
|
+
* Put one of this organization's service agents on the work's reviewer roster, with the kind it reviews as: expert writes a scored report, audience fills a screening card. Every round sent from now on asks every roster member of that round's kind, so add only agents that should judge every round of this work. A person makes this change, and an agent calling it is refused with PERMISSION_DENIED. Pass the agent id as /v1/agents returns it (agent_…). The agent must be a service agent of this organization: anything else, including an absent id and another organization's agent, answers REVIEWER_NOT_SERVICE_AGENT. An agent already on the roster answers REVIEWER_ALREADY_ADDED; change its kind with the update operation instead.
|
|
4028
|
+
*/
|
|
4029
|
+
export declare const studioWorksReviewersCreate: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewersCreateData, ThrowOnError>) => RequestResult<StudioWorksReviewersCreateResponses, StudioWorksReviewersCreateErrors, ThrowOnError>;
|
|
4030
|
+
/**
|
|
4031
|
+
* Remove a reviewer from a work
|
|
4032
|
+
*
|
|
4033
|
+
* Take one agent off the work's reviewer roster, so rounds sent from now on no longer ask it. What it has already judged is kept: the rounds it took part in stay readable with their reports,. A person makes this change, and an agent calling it is refused with PERMISSION_DENIED. An agent that is not on this work's roster answers REVIEWER_NOT_FOUND.
|
|
4034
|
+
*/
|
|
4035
|
+
export declare const studioWorksReviewersDelete: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewersDeleteData, ThrowOnError>) => RequestResult<StudioWorksReviewersDeleteResponses, StudioWorksReviewersDeleteErrors, ThrowOnError>;
|
|
4036
|
+
/**
|
|
4037
|
+
* Change a reviewer's kind
|
|
4038
|
+
*
|
|
4039
|
+
* Change the kind one roster member reviews as: expert or audience. Use it when a reviewer should judge a different way, rather than removing it and adding it back, because the roster position it holds decides its label and is kept. A person makes this change, and an agent calling it is refused with PERMISSION_DENIED. A round already sent is not affected, because its seats were fixed when it was sent. An agent that is not on this work's roster answers REVIEWER_NOT_FOUND, which is also the answer for another work's reviewer.
|
|
4040
|
+
*/
|
|
4041
|
+
export declare const studioWorksReviewersUpdate: <ThrowOnError extends boolean = false>(options: Options<StudioWorksReviewersUpdateData, ThrowOnError>) => RequestResult<StudioWorksReviewersUpdateResponses, StudioWorksReviewersUpdateErrors, ThrowOnError>;
|
|
2861
4042
|
/**
|
|
2862
4043
|
* List vaults
|
|
2863
4044
|
*
|
|
@@ -2867,7 +4048,7 @@ export declare const vaultListVaults: <ThrowOnError extends boolean = false>(opt
|
|
|
2867
4048
|
/**
|
|
2868
4049
|
* Create vault
|
|
2869
4050
|
*
|
|
2870
|
-
* 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.
|
|
4051
|
+
* 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.
|
|
2871
4052
|
*/
|
|
2872
4053
|
export declare const vaultCreateVault: <ThrowOnError extends boolean = false>(options: Options<VaultCreateVaultData, ThrowOnError>) => RequestResult<VaultCreateVaultResponses, VaultCreateVaultErrors, ThrowOnError>;
|
|
2873
4054
|
/**
|
|
@@ -3095,19 +4276,19 @@ export declare const ticketGetLabels: <ThrowOnError extends boolean = false>(opt
|
|
|
3095
4276
|
/**
|
|
3096
4277
|
* Create or add labels
|
|
3097
4278
|
*
|
|
3098
|
-
* 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.
|
|
4279
|
+
* 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.
|
|
3099
4280
|
*/
|
|
3100
4281
|
export declare const ticketPostLabels: <ThrowOnError extends boolean = false>(options: Options<TicketPostLabelsData, ThrowOnError>) => RequestResult<TicketPostLabelsResponses, TicketPostLabelsErrors, ThrowOnError>;
|
|
3101
4282
|
/**
|
|
3102
4283
|
* Remove labels
|
|
3103
4284
|
*
|
|
3104
|
-
* 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.
|
|
4285
|
+
* 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.
|
|
3105
4286
|
*/
|
|
3106
4287
|
export declare const ticketDeleteLabelsName: <ThrowOnError extends boolean = false>(options: Options<TicketDeleteLabelsNameData, ThrowOnError>) => RequestResult<TicketDeleteLabelsNameResponses, TicketDeleteLabelsNameErrors, ThrowOnError>;
|
|
3107
4288
|
/**
|
|
3108
4289
|
* Update labels
|
|
3109
4290
|
*
|
|
3110
|
-
* 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.
|
|
4291
|
+
* 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.
|
|
3111
4292
|
*/
|
|
3112
4293
|
export declare const ticketPatchLabelsName: <ThrowOnError extends boolean = false>(options: Options<TicketPatchLabelsNameData, ThrowOnError>) => RequestResult<TicketPatchLabelsNameResponses, TicketPatchLabelsNameErrors, ThrowOnError>;
|
|
3113
4294
|
/**
|
|
@@ -3260,3 +4441,9 @@ export declare const ticketGetActivity: <ThrowOnError extends boolean = false>(o
|
|
|
3260
4441
|
* List repositories within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.
|
|
3261
4442
|
*/
|
|
3262
4443
|
export declare const ticketGetRepositories: <ThrowOnError extends boolean = false>(options?: Options<TicketGetRepositoriesData, ThrowOnError>) => RequestResult<TicketGetRepositoriesResponses, TicketGetRepositoriesErrors, ThrowOnError>;
|
|
4444
|
+
/**
|
|
4445
|
+
* Update repositories
|
|
4446
|
+
*
|
|
4447
|
+
* Update repositories 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.
|
|
4448
|
+
*/
|
|
4449
|
+
export declare const ticketPatchRepositoriesId: <ThrowOnError extends boolean = false>(options: Options<TicketPatchRepositoriesIdData, ThrowOnError>) => RequestResult<TicketPatchRepositoriesIdResponses, TicketPatchRepositoriesIdErrors, ThrowOnError>;
|