From d3d688094405c9e4ab805cbe8a45950e9d973795 Mon Sep 17 00:00:00 2001 From: moonyue-w <300878504+moonyue-w@users.noreply.github.com> Date: Fri, 18 Sep 2026 16:05:38 +0800 Subject: [PATCH 1/3] feat(docs): add deterministic API reference generator --- Makefile | 5 +- docs/api/README.md | 16 + docs/api/forward/README.md | 398 ++++++ docs/api/forward/classes/BatchTasks.md | 71 + docs/api/forward/classes/Batches.md | 207 +++ docs/api/forward/classes/ChannelPairings.md | 93 ++ docs/api/forward/classes/ChannelQRSessions.md | 97 ++ docs/api/forward/classes/Channels.md | 181 +++ docs/api/forward/classes/Environments.md | 201 +++ docs/api/forward/classes/Files.md | 171 +++ docs/api/forward/classes/Identities.md | 339 +++++ docs/api/forward/classes/IdentityConfigs.md | 165 +++ .../forward/classes/IdentityMemoryStores.md | 139 ++ .../forward/classes/MemoryStoreMemories.md | 195 +++ .../classes/MemoryStoreMemoryVersions.md | 131 ++ docs/api/forward/classes/MemoryStores.md | 213 +++ docs/api/forward/classes/Models.md | 63 + docs/api/forward/classes/ScheduleRuns.md | 97 ++ docs/api/forward/classes/Schedules.md | 295 +++++ docs/api/forward/classes/SessionEvents.md | 157 +++ docs/api/forward/classes/SessionResources.md | 71 + .../forward/classes/SessionThreadEvents.md | 109 ++ docs/api/forward/classes/SessionThreads.md | 141 ++ docs/api/forward/classes/Sessions.md | 227 ++++ docs/api/forward/classes/SkillVersions.md | 191 +++ docs/api/forward/classes/Skills.md | 185 +++ docs/api/forward/classes/Templates.md | 209 +++ docs/api/forward/classes/VaultCredentials.md | 161 +++ docs/api/forward/classes/Vaults.md | 151 +++ docs/api/forward/interfaces/Batch.md | 173 +++ .../forward/interfaces/BatchCancelParams.md | 21 + docs/api/forward/interfaces/BatchFile.md | 29 + .../api/forward/interfaces/BatchListParams.md | 45 + docs/api/forward/interfaces/BatchNewParams.md | 45 + .../forward/interfaces/BatchRequestCounts.md | 55 + docs/api/forward/interfaces/BatchTask.md | 61 + .../interfaces/BatchTaskArtifactsItem.md | 37 + docs/api/forward/interfaces/BatchTaskError.md | 25 + .../forward/interfaces/BatchTaskListParams.md | 45 + docs/api/forward/interfaces/BatchTaskUsage.md | 19 + docs/api/forward/interfaces/BatchUsage.md | 19 + docs/api/forward/interfaces/Channel.md | 99 ++ .../interfaces/ChannelChannelConfig.md | 19 + .../ChannelChannelConfigResponseOptions.md | 25 + .../interfaces/ChannelIdentityResolution.md | 19 + .../forward/interfaces/ChannelListParams.md | 77 ++ .../forward/interfaces/ChannelNewParams.md | 73 + docs/api/forward/interfaces/ChannelPairing.md | 69 + .../interfaces/ChannelPairingNewParams.md | 45 + .../forward/interfaces/ChannelQRSession.md | 85 ++ .../interfaces/ChannelQRSessionNewParams.md | 21 + .../forward/interfaces/ChannelUpdateParams.md | 59 + docs/api/forward/interfaces/ContentBlock.md | 37 + .../forward/interfaces/ContentBlockParam.md | 37 + docs/api/forward/interfaces/DeletedChannel.md | 29 + .../interfaces/DeletedChannelPairing.md | 29 + .../api/forward/interfaces/DeletedIdentity.md | 29 + docs/api/forward/interfaces/DeletedMemory.md | 37 + .../forward/interfaces/DeletedMemoryStore.md | 37 + .../interfaces/DeletedMemoryStoreMount.md | 37 + .../forward/interfaces/DeletedSkillVersion.md | 37 + .../api/forward/interfaces/EffectiveConfig.md | 79 ++ .../interfaces/EffectiveConfigAgent.md | 43 + .../EffectiveConfigAgentToolsItem.md | 25 + ...ffectiveConfigAgentToolsItemConfigsItem.md | 25 + .../interfaces/EffectiveConfigSession.md | 37 + .../EffectiveConfigSessionResourcesItem.md | 37 + docs/api/forward/interfaces/Environment.md | 73 + .../forward/interfaces/EnvironmentConfig.md | 25 + .../interfaces/EnvironmentConfigPackages.md | 55 + .../interfaces/EnvironmentListParams.md | 45 + .../interfaces/EnvironmentNewParams.md | 53 + .../interfaces/EnvironmentUpdateParams.md | 45 + .../interfaces/EnvironmentVariableOverride.md | 25 + .../EnvironmentVariableOverrideParam.md | 25 + docs/api/forward/interfaces/FileListParams.md | 61 + docs/api/forward/interfaces/FileMetadata.md | 101 ++ .../forward/interfaces/FileUploadParams.md | 53 + .../forward/interfaces/GitHubRepository.md | 31 + .../interfaces/GitHubRepositoryParam.md | 37 + docs/api/forward/interfaces/Identity.md | 77 ++ .../forward/interfaces/IdentityClearParams.md | 21 + .../interfaces/IdentityClearResponse.md | 43 + .../IdentityClearResponseSummary.md | 49 + docs/api/forward/interfaces/IdentityConfig.md | 89 ++ .../interfaces/IdentityConfigListParams.md | 53 + .../forward/interfaces/IdentityConfigSpec.md | 79 ++ .../interfaces/IdentityConfigSpecParam.md | 79 ++ .../interfaces/IdentityConfigUpsertParams.md | 45 + .../forward/interfaces/IdentityListParams.md | 69 + .../IdentityListTemplatesResponse.md | 19 + .../IdentityMemoryStoreListResponse.md | 25 + .../IdentityMemoryStoreMountParams.md | 21 + .../forward/interfaces/IdentityNewParams.md | 53 + docs/api/forward/interfaces/IdentityStats.md | 45 + .../forward/interfaces/IdentityTemplate.md | 37 + .../interfaces/IdentityUpdateParams.md | 53 + docs/api/forward/interfaces/ImageSource.md | 43 + .../forward/interfaces/ImageSourceParam.md | 43 + docs/api/forward/interfaces/MCPServer.md | 31 + .../forward/interfaces/MCPServerOverride.md | 31 + .../interfaces/MCPServerOverrideParam.md | 31 + docs/api/forward/interfaces/MCPServerParam.md | 31 + docs/api/forward/interfaces/Memory.md | 73 + docs/api/forward/interfaces/MemoryStore.md | 97 ++ .../interfaces/MemoryStoreListParams.md | 45 + .../interfaces/MemoryStoreMemoryListParams.md | 45 + .../interfaces/MemoryStoreMemoryNewParams.md | 37 + .../MemoryStoreMemoryUpdateParams.md | 37 + .../MemoryStoreMemoryVersionListParams.md | 45 + .../forward/interfaces/MemoryStoreMount.md | 67 + .../interfaces/MemoryStoreNewParams.md | 45 + .../interfaces/MemoryStoreUpdateParams.md | 37 + docs/api/forward/interfaces/MemoryVersion.md | 85 ++ docs/api/forward/interfaces/Model.md | 91 ++ .../forward/interfaces/ModelConfigObject.md | 31 + .../forward/interfaces/ModelConfigParam.md | 31 + .../forward/interfaces/ModelListResponse.md | 25 + .../forward/interfaces/MultiagentConfig.md | 25 + .../interfaces/MultiagentConfigParam.md | 25 + .../api/forward/interfaces/MultiagentEntry.md | 31 + .../interfaces/MultiagentEntryParam.md | 31 + .../forward/interfaces/PermissionPolicy.md | 19 + .../interfaces/PermissionPolicyParam.md | 19 + .../api/forward/interfaces/ResourceBinding.md | 19 + .../interfaces/ResourceBindingParam.md | 19 + docs/api/forward/interfaces/Schedule.md | 109 ++ .../interfaces/ScheduleArchiveManyParams.md | 29 + .../interfaces/ScheduleArchiveManyResponse.md | 21 + .../interfaces/ScheduleArchiveParams.md | 21 + .../forward/interfaces/ScheduleExecution.md | 37 + .../interfaces/ScheduleInitialEventsItem.md | 25 + .../forward/interfaces/ScheduleListParams.md | 85 ++ .../forward/interfaces/ScheduleNewParams.md | 101 ++ .../forward/interfaces/SchedulePauseParams.md | 21 + .../interfaces/SchedulePausedReason.md | 19 + docs/api/forward/interfaces/ScheduleRun.md | 165 +++ .../interfaces/ScheduleRunGetParams.md | 21 + .../interfaces/ScheduleRunListParams.md | 93 ++ .../forward/interfaces/ScheduleRunParams.md | 21 + .../interfaces/ScheduleRunTriggerContext.md | 25 + .../forward/interfaces/ScheduleSinksItem.md | 31 + .../interfaces/ScheduleSinksItemTarget.md | 25 + .../interfaces/ScheduleTriggerPolicy.md | 37 + .../interfaces/ScheduleUnpauseParams.md | 21 + .../interfaces/ScheduleUpdateParams.md | 93 ++ docs/api/forward/interfaces/Session.md | 115 ++ .../interfaces/SessionArchiveParams.md | 21 + .../forward/interfaces/SessionCancelParams.md | 21 + docs/api/forward/interfaces/SessionConfig.md | 19 + docs/api/forward/interfaces/SessionEvent.md | 259 ++++ .../interfaces/SessionEventListParams.md | 77 ++ .../forward/interfaces/SessionEventParam.md | 79 ++ .../interfaces/SessionEventSendParams.md | 27 + .../interfaces/SessionEventSendResponse.md | 19 + .../interfaces/SessionEventStreamParams.md | 45 + .../forward/interfaces/SessionListParams.md | 141 ++ .../forward/interfaces/SessionNewParams.md | 65 + .../interfaces/SessionNewParamsConfigParam.md | 19 + .../api/forward/interfaces/SessionResource.md | 61 + .../interfaces/SessionResourceAddParams.md | 37 + .../forward/interfaces/SessionResourceSpec.md | 31 + .../interfaces/SessionResourceSpecParam.md | 31 + docs/api/forward/interfaces/SessionStats.md | 25 + .../api/forward/interfaces/SessionTemplate.md | 43 + docs/api/forward/interfaces/SessionThread.md | 91 ++ .../interfaces/SessionThreadArchiveParams.md | 21 + .../SessionThreadEventListParams.md | 37 + .../SessionThreadEventStreamParams.md | 21 + .../interfaces/SessionThreadListParams.md | 37 + .../interfaces/SessionThreadStopReason.md | 19 + .../forward/interfaces/SessionUpdateParams.md | 43 + .../SessionUpdateParamsConfigParam.md | 19 + docs/api/forward/interfaces/SessionUsage.md | 19 + docs/api/forward/interfaces/Skill.md | 85 ++ docs/api/forward/interfaces/SkillBinding.md | 37 + .../forward/interfaces/SkillBindingParam.md | 37 + docs/api/forward/interfaces/SkillGetParams.md | 21 + .../api/forward/interfaces/SkillListParams.md | 69 + docs/api/forward/interfaces/SkillNewParams.md | 77 ++ docs/api/forward/interfaces/SkillOverride.md | 31 + .../forward/interfaces/SkillOverrideParam.md | 31 + .../forward/interfaces/SkillUpdateParams.md | 61 + docs/api/forward/interfaces/SkillVersion.md | 79 ++ .../interfaces/SkillVersionListParams.md | 29 + .../interfaces/SkillVersionNewParams.md | 21 + docs/api/forward/interfaces/SystemOverride.md | 25 + .../forward/interfaces/SystemOverrideParam.md | 25 + docs/api/forward/interfaces/Template.md | 141 ++ .../interfaces/TemplateArchiveParams.md | 21 + .../forward/interfaces/TemplateCloneParams.md | 37 + .../forward/interfaces/TemplateListParams.md | 45 + .../forward/interfaces/TemplateNewParams.md | 141 ++ .../interfaces/TemplateUpdateParams.md | 141 ++ docs/api/forward/interfaces/Tool.md | 61 + docs/api/forward/interfaces/ToolConfig.md | 31 + .../api/forward/interfaces/ToolConfigParam.md | 31 + docs/api/forward/interfaces/ToolOverride.md | 25 + .../forward/interfaces/ToolOverrideParam.md | 25 + docs/api/forward/interfaces/ToolParam.md | 61 + docs/api/forward/interfaces/Vault.md | 69 + .../api/forward/interfaces/VaultCredential.md | 77 ++ .../forward/interfaces/VaultCredentialAuth.md | 25 + .../interfaces/VaultCredentialListParams.md | 53 + .../interfaces/VaultCredentialNewParams.md | 45 + .../api/forward/interfaces/VaultListParams.md | 53 + docs/api/forward/interfaces/VaultNewParams.md | 37 + .../forward/type-aliases/BatchCreateParams.md | 9 + .../type-aliases/ChannelCreateParams.md | 9 + .../ChannelPairingCreateParams.md | 9 + .../ChannelQRSessionCreateParams.md | 9 + .../type-aliases/EnvironmentCreateParams.md | 9 + .../EnvironmentVariablesUnionParam.md | 9 + .../type-aliases/EventContentUnionParam.md | 9 + .../type-aliases/ForwardClientOptions.md | 9 + .../type-aliases/IdentityCreateParams.md | 9 + .../type-aliases/MemoryStoreCreateParams.md | 9 + .../MemoryStoreMemoryCreateParams.md | 9 + docs/api/forward/type-aliases/ModelConfig.md | 9 + .../type-aliases/ModelConfigUnionParam.md | 9 + .../type-aliases/ScheduleCreateParams.md | 9 + .../type-aliases/ScheduleRunRetrieveParams.md | 9 + .../type-aliases/SessionCreateParams.md | 9 + .../forward/type-aliases/SkillCreateParams.md | 9 + .../type-aliases/SkillRetrieveParams.md | 9 + .../type-aliases/SkillVersionCreateParams.md | 9 + .../type-aliases/TemplateCreateParams.md | 9 + .../forward/type-aliases/VaultCreateParams.md | 9 + .../VaultCredentialCreateParams.md | 9 + docs/api/index/README.md | 61 + docs/api/index/classes/APIClient.md | 162 +++ docs/api/index/classes/APIConnectionError.md | 79 ++ .../classes/APIConnectionTimeoutError.md | 75 ++ docs/api/index/classes/APIError.md | 184 +++ docs/api/index/classes/APIPromise.md | 568 ++++++++ docs/api/index/classes/APIUserAbortError.md | 75 ++ docs/api/index/classes/AuthenticationError.md | 213 +++ docs/api/index/classes/BadRequestError.md | 213 +++ docs/api/index/classes/ConflictError.md | 213 +++ docs/api/index/classes/ForwardClient.md | 285 ++++ docs/api/index/classes/InternalServerError.md | 213 +++ docs/api/index/classes/ManagedClient.md | 269 ++++ docs/api/index/classes/NotFoundError.md | 213 +++ docs/api/index/classes/PATCredential.md | 57 + docs/api/index/classes/Page.md | 167 +++ docs/api/index/classes/PagePromise.md | 590 +++++++++ .../index/classes/PermissionDeniedError.md | 213 +++ docs/api/index/classes/QoderError.md | 81 ++ docs/api/index/classes/RateLimitError.md | 213 +++ .../classes/ResumableSessionEventStream.md | 80 ++ docs/api/index/classes/Stream.md | 117 ++ .../index/classes/UnprocessableEntityError.md | 213 +++ docs/api/index/functions/decodeSSE.md | 21 + docs/api/index/functions/mergeHeaders.md | 19 + docs/api/index/functions/readEnv.md | 19 + docs/api/index/functions/stringifyQuery.md | 23 + docs/api/index/functions/toFile.md | 27 + docs/api/index/functions/toMultipartForm.md | 21 + .../api/index/interfaces/APIRequestOptions.md | 99 ++ docs/api/index/interfaces/ClientOptions.md | 77 ++ docs/api/index/interfaces/Credential.md | 17 + docs/api/index/interfaces/PageResponse.md | 53 + docs/api/index/interfaces/RequestOptions.md | 53 + docs/api/index/interfaces/ServerSentEvent.md | 37 + docs/api/index/type-aliases/HeadersLike.md | 9 + docs/api/index/type-aliases/Middleware.md | 23 + docs/api/index/type-aliases/PaginationMode.md | 9 + docs/api/index/type-aliases/Uploadable.md | 9 + docs/api/index/variables/VERSION.md | 9 + docs/api/managed/README.md | 1178 +++++++++++++++++ docs/api/managed/classes/Agents.md | 169 +++ docs/api/managed/classes/AgentsVersions.md | 67 + docs/api/managed/classes/DeploymentRuns.md | 89 ++ docs/api/managed/classes/Deployments.md | 241 ++++ docs/api/managed/classes/Dreams.md | 163 +++ docs/api/managed/classes/Environments.md | 196 +++ docs/api/managed/classes/EnvironmentsWork.md | 285 ++++ docs/api/managed/classes/Files.md | 163 +++ docs/api/managed/classes/MemoryStores.md | 201 +++ .../managed/classes/MemoryStoresMemories.md | 171 +++ .../classes/MemoryStoresMemoryVersions.md | 119 ++ docs/api/managed/classes/Models.md | 66 + docs/api/managed/classes/Sessions.md | 207 +++ docs/api/managed/classes/SessionsEvents.md | 145 ++ docs/api/managed/classes/SessionsResources.md | 171 +++ docs/api/managed/classes/SessionsThreads.md | 125 ++ .../managed/classes/SessionsThreadsEvents.md | 93 ++ docs/api/managed/classes/Skills.md | 143 ++ docs/api/managed/classes/SkillsVersions.md | 171 +++ docs/api/managed/classes/Vaults.md | 169 +++ docs/api/managed/classes/VaultsCredentials.md | 223 ++++ .../AdvisorRedactedResultBlockParam.md | 32 + .../interfaces/AdvisorResultBlockParam.md | 29 + .../interfaces/AdvisorToolResultBlockParam.md | 38 + .../interfaces/AdvisorToolResultErrorParam.md | 27 + .../managed/interfaces/AgentArchiveParams.md | 21 + docs/api/managed/interfaces/AgentGetParams.md | 30 + .../api/managed/interfaces/AgentListParams.md | 61 + docs/api/managed/interfaces/AgentNewParams.md | 102 ++ .../managed/interfaces/AgentUpdateParams.md | 116 ++ .../interfaces/AgentVersionListParams.md | 37 + .../interfaces/Base64ImageSourceParam.md | 31 + .../interfaces/Base64PDFSourceParam.md | 31 + .../BashCodeExecutionOutputBlockParam.md | 24 + .../BashCodeExecutionResultBlockParam.md | 42 + .../BashCodeExecutionToolResultBlockParam.md | 38 + .../BashCodeExecutionToolResultErrorParam.md | 27 + .../interfaces/BrowserStateBlockParam.md | 49 + ...rowserStateChangeDownloadCompletedParam.md | 55 + .../BrowserStateChangeDownloadFailedParam.md | 42 + .../BrowserStateChangeDownloadStartedParam.md | 34 + .../BrowserStateChangeTabOpenedParam.md | 30 + .../interfaces/BrowserStateTabEntryParam.md | 47 + .../interfaces/CacheControlEphemeralParam.md | 33 + .../managed/interfaces/CapabilitySupport.md | 17 + .../interfaces/CitationCharLocationParam.md | 48 + .../CitationContentBlockLocationParam.md | 64 + .../interfaces/CitationPageLocationParam.md | 48 + .../CitationSearchResultLocationParam.md | 77 ++ .../CitationWebSearchResultLocationParam.md | 42 + .../interfaces/CitationsConfigParam.md | 13 + docs/api/managed/interfaces/CloudConfig.md | 39 + .../managed/interfaces/CloudConfigParams.md | 50 + .../CodeExecutionOutputBlockParam.md | 24 + .../CodeExecutionResultBlockParam.md | 42 + .../CodeExecutionToolResultBlockParam.md | 40 + .../CodeExecutionToolResultErrorParam.md | 27 + .../interfaces/CompactionBlockParam.md | 47 + .../interfaces/ContainerUploadBlockParam.md | 32 + .../interfaces/ContentBlockSourceParam.md | 23 + .../interfaces/ContextManagementCapability.md | 41 + docs/api/managed/interfaces/DeletedFile.md | 27 + docs/api/managed/interfaces/DeletedSkill.md | 27 + .../managed/interfaces/DeletedSkillVersion.md | 26 + .../interfaces/DeploymentArchiveParams.md | 21 + .../managed/interfaces/DeploymentGetParams.md | 21 + .../interfaces/DeploymentListParams.md | 92 ++ .../managed/interfaces/DeploymentNewParams.md | 116 ++ .../interfaces/DeploymentPauseParams.md | 21 + .../interfaces/DeploymentRunGetParams.md | 21 + .../interfaces/DeploymentRunListParams.md | 111 ++ .../managed/interfaces/DeploymentRunParams.md | 21 + .../interfaces/DeploymentUnpauseParams.md | 21 + .../interfaces/DeploymentUpdateParams.md | 116 ++ .../managed/interfaces/DirectCallerParam.md | 17 + docs/api/managed/interfaces/Dream.md | 121 ++ .../managed/interfaces/DreamArchiveParams.md | 21 + .../managed/interfaces/DreamCancelParams.md | 21 + docs/api/managed/interfaces/DreamError.md | 21 + docs/api/managed/interfaces/DreamGetParams.md | 21 + .../api/managed/interfaces/DreamListParams.md | 72 + .../interfaces/DreamMemoryStoreInput.md | 25 + .../interfaces/DreamMemoryStoreInputParam.md | 25 + .../managed/interfaces/DreamModelConfig.md | 30 + .../interfaces/DreamModelConfigParam.md | 29 + docs/api/managed/interfaces/DreamNewParams.md | 51 + docs/api/managed/interfaces/DreamOutput.md | 23 + .../managed/interfaces/DreamSessionsInput.md | 23 + .../interfaces/DreamSessionsInputParam.md | 23 + docs/api/managed/interfaces/DreamUsage.md | 41 + .../managed/interfaces/EffortCapability.md | 57 + .../EncryptedCodeExecutionResultBlockParam.md | 42 + docs/api/managed/interfaces/Environment.md | 90 ++ .../interfaces/EnvironmentArchiveParams.md | 21 + .../interfaces/EnvironmentDeleteParams.md | 21 + .../interfaces/EnvironmentDeleteResponse.md | 27 + .../interfaces/EnvironmentGetParams.md | 21 + .../interfaces/EnvironmentListParams.md | 58 + .../interfaces/EnvironmentNewParams.md | 66 + .../interfaces/EnvironmentUpdateParams.md | 67 + .../interfaces/EnvironmentWorkAckParams.md | 21 + .../interfaces/EnvironmentWorkGetParams.md | 27 + .../EnvironmentWorkHeartbeatParams.md | 40 + .../interfaces/EnvironmentWorkListParams.md | 43 + .../interfaces/EnvironmentWorkPollParams.md | 43 + .../interfaces/EnvironmentWorkStatsParams.md | 21 + .../interfaces/EnvironmentWorkStopParams.md | 35 + .../interfaces/EnvironmentWorkUpdateParams.md | 36 + .../managed/interfaces/FallbackBlockParam.md | 53 + .../managed/interfaces/FallbackInfoParam.md | 20 + .../managed/interfaces/FileDeleteParams.md | 21 + .../interfaces/FileDocumentSourceParam.md | 23 + .../managed/interfaces/FileDownloadParams.md | 21 + .../interfaces/FileGetMetadataParams.md | 21 + .../interfaces/FileImageSourceParam.md | 23 + docs/api/managed/interfaces/FileListParams.md | 79 ++ docs/api/managed/interfaces/FileMetadata.md | 98 ++ docs/api/managed/interfaces/FileScope.md | 23 + .../managed/interfaces/FileUploadParams.md | 52 + .../managed/interfaces/HealthCheckWorkData.md | 31 + .../api/managed/interfaces/ImageBlockParam.md | 42 + .../interfaces/ImageTransformationsParam.md | 27 + docs/api/managed/interfaces/LimitedNetwork.md | 43 + .../interfaces/LimitedNetworkParams.md | 48 + .../interfaces/MCPToolUseBlockParam.md | 51 + .../interfaces/ManagedAgentsAPIActor.md | 27 + .../interfaces/ManagedAgentsAdvisor.md | 26 + .../interfaces/ManagedAgentsAdvisorParams.md | 28 + .../managed/interfaces/ManagedAgentsAgent.md | 114 ++ ...gentArchivedDeploymentPausedReasonError.md | 17 + .../ManagedAgentsAgentArchivedRunError.md | 25 + .../ManagedAgentsAgentCustomToolUseEvent.md | 60 + .../ManagedAgentsAgentMCPToolResultEvent.md | 57 + .../ManagedAgentsAgentMCPToolUseEvent.md | 78 ++ .../ManagedAgentsAgentMessageEvent.md | 41 + .../ManagedAgentsAgentMessagePreview.md | 24 + .../interfaces/ManagedAgentsAgentParams.md | 35 + .../interfaces/ManagedAgentsAgentReference.md | 29 + .../ManagedAgentsAgentThinkingEvent.md | 34 + .../ManagedAgentsAgentThinkingPreview.md | 24 + ...dAgentsAgentThreadContextCompactedEvent.md | 33 + ...edAgentsAgentThreadMessageReceivedEvent.md | 59 + ...dMessageReceivedEventContentUnionSource.md | 37 + ...anagedAgentsAgentThreadMessageSentEvent.md | 59 + ...hreadMessageSentEventContentUnionSource.md | 42 + ...ntsAgentToolConfigUnionPermissionPolicy.md | 13 + .../ManagedAgentsAgentToolResultEvent.md | 57 + ...anagedAgentsAgentToolUnionDefaultConfig.md | 23 + ...tToolUnionDefaultConfigPermissionPolicy.md | 18 + .../ManagedAgentsAgentToolUseEvent.md | 70 + .../ManagedAgentsAgentToolset20260401.md | 41 + ...agedAgentsAgentToolset20260401BashInput.md | 37 + ...agedAgentsAgentToolset20260401EditInput.md | 43 + ...agedAgentsAgentToolset20260401GlobInput.md | 28 + ...agedAgentsAgentToolset20260401GrepInput.md | 27 + ...ManagedAgentsAgentToolset20260401Params.md | 46 + ...agedAgentsAgentToolset20260401ReadInput.md | 27 + ...gedAgentsAgentToolset20260401WriteInput.md | 26 + .../ManagedAgentsAgentToolsetDefaultConfig.md | 23 + ...edAgentsAgentToolsetDefaultConfigParams.md | 26 + .../ManagedAgentsAgentWithOverridesParams.md | 80 ++ .../ManagedAgentsAlwaysAllowPolicy.md | 17 + .../ManagedAgentsAlwaysAllowPolicyParam.md | 17 + .../ManagedAgentsAlwaysAskPolicy.md | 17 + .../ManagedAgentsAlwaysAskPolicyParam.md | 17 + .../ManagedAgentsBase64DocumentSource.md | 33 + .../ManagedAgentsBase64DocumentSourceParam.md | 33 + .../ManagedAgentsBase64ImageSource.md | 34 + .../ManagedAgentsBase64ImageSourceParam.md | 34 + .../interfaces/ManagedAgentsBashToolConfig.md | 35 + .../ManagedAgentsBashToolConfigParams.md | 44 + .../interfaces/ManagedAgentsBillingError.md | 35 + .../interfaces/ManagedAgentsBranchCheckout.md | 23 + .../ManagedAgentsBranchCheckoutParam.md | 25 + .../interfaces/ManagedAgentsBudgetLimit.md | 26 + .../ManagedAgentsBudgetLimitParam.md | 26 + .../ManagedAgentsCacheCreationUsage.md | 25 + .../interfaces/ManagedAgentsCommitCheckout.md | 23 + .../ManagedAgentsCommitCheckoutParam.md | 25 + .../interfaces/ManagedAgentsCredential.md | 82 ++ ...gedAgentsCredentialHostUnreachableError.md | 50 + .../ManagedAgentsCredentialValidation.md | 75 ++ .../interfaces/ManagedAgentsCustomSkill.md | 29 + .../ManagedAgentsCustomSkillParams.md | 33 + .../interfaces/ManagedAgentsCustomTool.md | 37 + .../ManagedAgentsCustomToolInputSchema.md | 33 + ...ManagedAgentsCustomToolInputSchemaParam.md | 35 + .../ManagedAgentsCustomToolParams.md | 46 + .../ManagedAgentsDeleteSessionResource.md | 23 + .../ManagedAgentsDeletedCredential.md | 25 + .../interfaces/ManagedAgentsDeletedMemory.md | 30 + .../ManagedAgentsDeletedMemoryStore.md | 26 + .../interfaces/ManagedAgentsDeletedSession.md | 23 + .../interfaces/ManagedAgentsDeletedVault.md | 25 + .../interfaces/ManagedAgentsDeltaContent.md | 33 + .../interfaces/ManagedAgentsDeltaEvent.md | 41 + .../interfaces/ManagedAgentsDeployment.md | 158 +++ .../interfaces/ManagedAgentsDeploymentRun.md | 76 ++ ...nagedAgentsDeploymentSystemMessageEvent.md | 27 + ...dAgentsDeploymentUserDefineOutcomeEvent.md | 41 + ...ManagedAgentsDeploymentUserMessageEvent.md | 25 + ...ymentUserMessageEventContentUnionSource.md | 42 + .../interfaces/ManagedAgentsDocumentBlock.md | 42 + .../ManagedAgentsDocumentBlockParam.md | 42 + .../interfaces/ManagedAgentsEditToolConfig.md | 35 + .../ManagedAgentsEditToolConfigParams.md | 44 + .../interfaces/ManagedAgentsEffortHigh.md | 17 + .../ManagedAgentsEffortHighParam.md | 17 + .../interfaces/ManagedAgentsEffortLow.md | 17 + .../interfaces/ManagedAgentsEffortLowParam.md | 17 + .../interfaces/ManagedAgentsEffortMax.md | 17 + .../interfaces/ManagedAgentsEffortMaxParam.md | 17 + .../interfaces/ManagedAgentsEffortMedium.md | 17 + .../ManagedAgentsEffortMediumParam.md | 17 + .../interfaces/ManagedAgentsEffortXhigh.md | 17 + .../ManagedAgentsEffortXhighParam.md | 17 + ...mentArchivedDeploymentPausedReasonError.md | 17 + ...anagedAgentsEnvironmentArchivedRunError.md | 25 + ...mentNotFoundDeploymentPausedReasonError.md | 17 + ...anagedAgentsEnvironmentNotFoundRunError.md | 25 + ...edAgentsEnvironmentVariableAuthResponse.md | 41 + ...edAgentsEnvironmentVariableCreateParams.md | 49 + ...edAgentsEnvironmentVariableUpdateParams.md | 42 + ...anagedAgentsErrorDeploymentPausedReason.md | 25 + .../ManagedAgentsFileDocumentSource.md | 25 + .../ManagedAgentsFileDocumentSourceParam.md | 25 + .../ManagedAgentsFileImageSource.md | 25 + .../ManagedAgentsFileImageSourceParam.md | 25 + ...FileNotFoundDeploymentPausedReasonError.md | 17 + .../ManagedAgentsFileNotFoundRunError.md | 25 + .../interfaces/ManagedAgentsFileResource.md | 49 + .../ManagedAgentsFileResourceConfig.md | 33 + .../ManagedAgentsFileResourceParams.md | 33 + .../interfaces/ManagedAgentsFileRubric.md | 25 + .../ManagedAgentsFileRubricParams.md | 25 + .../ManagedAgentsGitHubRepositoryResource.md | 55 + ...gedAgentsGitHubRepositoryResourceConfig.md | 42 + ...gedAgentsGitHubRepositoryResourceParams.md | 49 + .../interfaces/ManagedAgentsGlobToolConfig.md | 35 + .../ManagedAgentsGlobToolConfigParams.md | 44 + .../interfaces/ManagedAgentsGrepToolConfig.md | 35 + .../ManagedAgentsGrepToolConfigParams.md | 44 + .../interfaces/ManagedAgentsImageBlock.md | 25 + .../ManagedAgentsImageBlockParam.md | 25 + .../ManagedAgentsInjectionLocationParams.md | 25 + .../ManagedAgentsInjectionLocationResponse.md | 25 + ...agedAgentsInjectionLocationUpdateParams.md | 25 + ...AgentsLimitedCredentialNetworkingParams.md | 28 + ...entsLimitedCredentialNetworkingResponse.md | 27 + ...nagedAgentsMCPAuthenticationFailedError.md | 41 + .../ManagedAgentsMCPConnectionFailedError.md | 41 + ...gressBlockedDeploymentPausedReasonError.md | 18 + .../ManagedAgentsMCPEgressBlockedRunError.md | 26 + .../ManagedAgentsMCPOAuthAuthResponse.md | 41 + .../ManagedAgentsMCPOAuthCreateParams.md | 49 + .../ManagedAgentsMCPOAuthRefreshParams.md | 57 + .../ManagedAgentsMCPOAuthRefreshResponse.md | 49 + ...anagedAgentsMCPOAuthRefreshUpdateParams.md | 33 + .../ManagedAgentsMCPOAuthUpdateParams.md | 42 + .../interfaces/ManagedAgentsMCPProbe.md | 25 + .../ManagedAgentsMCPServerURLDefinition.md | 29 + .../interfaces/ManagedAgentsMCPToolConfig.md | 29 + .../ManagedAgentsMCPToolConfigParams.md | 33 + .../interfaces/ManagedAgentsMCPToolset.md | 35 + .../ManagedAgentsMCPToolsetDefaultConfig.md | 23 + ...agedAgentsMCPToolsetDefaultConfigParams.md | 25 + .../ManagedAgentsMCPToolsetParams.md | 42 + ...nagedAgentsManualDeploymentPausedReason.md | 17 + .../ManagedAgentsManualTriggerContext.md | 18 + .../managed/interfaces/ManagedAgentsMemory.md | 112 ++ .../interfaces/ManagedAgentsMemoryPrefix.md | 32 + .../interfaces/ManagedAgentsMemoryStore.md | 82 ++ ...toreArchivedDeploymentPausedReasonError.md | 17 + ...anagedAgentsMemoryStoreArchivedRunError.md | 25 + .../ManagedAgentsMemoryStoreResource.md | 72 + .../ManagedAgentsMemoryStoreResourceConfig.md | 45 + .../ManagedAgentsMemoryStoreResourceParam.md | 45 + .../interfaces/ManagedAgentsMemoryVersion.md | 140 ++ .../ManagedAgentsModelOverloadedError.md | 34 + .../ManagedAgentsModelRateLimitedError.md | 33 + .../ManagedAgentsModelRequestFailedError.md | 33 + .../interfaces/ManagedAgentsMultiagent.md | 26 + .../ManagedAgentsMultiagentParams.md | 31 + .../ManagedAgentsMultiagentSelfParams.md | 18 + ...tionDisabledDeploymentPausedReasonError.md | 17 + ...nagedAgentsOrganizationDisabledRunError.md | 25 + .../ManagedAgentsOutcomeEvaluationResource.md | 69 + .../ManagedAgentsPlainTextDocumentSource.md | 35 + ...nagedAgentsPlainTextDocumentSourceParam.md | 35 + .../ManagedAgentsPreconditionParam.md | 33 + .../interfaces/ManagedAgentsQoderSkill.md | 29 + .../ManagedAgentsQoderSkillParams.md | 33 + .../interfaces/ManagedAgentsReadToolConfig.md | 35 + .../ManagedAgentsReadToolConfigParams.md | 44 + .../interfaces/ManagedAgentsRedactedBlock.md | 17 + .../ManagedAgentsRedactedBlockParam.md | 17 + .../ManagedAgentsRefreshHTTPResponse.md | 41 + .../interfaces/ManagedAgentsRefreshObject.md | 27 + .../ManagedAgentsRetryStatusExhausted.md | 18 + .../ManagedAgentsRetryStatusRetrying.md | 19 + .../ManagedAgentsRetryStatusTerminal.md | 18 + .../interfaces/ManagedAgentsSchedule.md | 57 + .../interfaces/ManagedAgentsScheduleParams.md | 39 + .../ManagedAgentsScheduleTriggerContext.md | 25 + .../ManagedAgentsSearchResultBlock.md | 49 + .../ManagedAgentsSearchResultBlockParam.md | 49 + .../ManagedAgentsSearchResultCitations.md | 17 + ...ManagedAgentsSearchResultCitationsParam.md | 17 + .../ManagedAgentsSearchResultContent.md | 25 + .../ManagedAgentsSearchResultContentParam.md | 25 + ...sUnsupportedDeploymentPausedReasonError.md | 18 + ...sSelfHostedResourcesUnsupportedRunError.md | 26 + .../ManagedAgentsSendSessionEvents.md | 17 + .../ManagedAgentsServerToolUsage.md | 25 + .../ManagedAgentsServiceAccountActor.md | 24 + .../interfaces/ManagedAgentsSession.md | 148 +++ .../interfaces/ManagedAgentsSessionActor.md | 28 + .../interfaces/ManagedAgentsSessionAgent.md | 83 ++ ...gentsSessionAgentToolUnionDefaultConfig.md | 23 + ...tToolUnionDefaultConfigPermissionPolicy.md | 13 + .../ManagedAgentsSessionAgentUpdateParam.md | 47 + .../ManagedAgentsSessionBudgetReached.md | 20 + ...edAgentsSessionCreationRejectedRunError.md | 25 + .../ManagedAgentsSessionDeletedEvent.md | 34 + .../interfaces/ManagedAgentsSessionEndTurn.md | 17 + .../ManagedAgentsSessionErrorEvent.md | 43 + ...sSessionErrorEventErrorUnionRetryStatus.md | 13 + ...anagedAgentsSessionEventUnionStopReason.md | 23 + .../ManagedAgentsSessionEventUnionUsage.md | 73 + ...nagedAgentsSessionMultiagentCoordinator.md | 26 + ...ManagedAgentsSessionRateLimitedRunError.md | 26 + .../ManagedAgentsSessionRequiresAction.md | 28 + ...urceNotFoundDeploymentPausedReasonError.md | 17 + ...edAgentsSessionResourceNotFoundRunError.md | 25 + .../ManagedAgentsSessionRetriesExhausted.md | 18 + .../interfaces/ManagedAgentsSessionStats.md | 27 + .../ManagedAgentsSessionStatusIdleEvent.md | 41 + ...agedAgentsSessionStatusRescheduledEvent.md | 34 + .../ManagedAgentsSessionStatusRunningEvent.md | 33 + ...nagedAgentsSessionStatusTerminatedEvent.md | 33 + .../interfaces/ManagedAgentsSessionThread.md | 101 ++ .../ManagedAgentsSessionThreadAgent.md | 75 ++ ...essionThreadAgentToolUnionDefaultConfig.md | 28 + ...tToolUnionDefaultConfigPermissionPolicy.md | 13 + .../ManagedAgentsSessionThreadCreatedEvent.md | 50 + .../ManagedAgentsSessionThreadStats.md | 36 + ...nagedAgentsSessionThreadStatusIdleEvent.md | 58 + ...entsSessionThreadStatusRescheduledEvent.md | 51 + ...edAgentsSessionThreadStatusRunningEvent.md | 50 + ...gentsSessionThreadStatusTerminatedEvent.md | 50 + .../ManagedAgentsSessionThreadUsage.md | 67 + .../ManagedAgentsSessionUpdatedEvent.md | 70 + .../interfaces/ManagedAgentsSessionUsage.md | 68 + .../ManagedAgentsSessionUsageEvent.md | 50 + .../ManagedAgentsSessionUsageSnapshot.md | 67 + ...killNotFoundDeploymentPausedReasonError.md | 17 + .../ManagedAgentsSkillNotFoundRunError.md | 25 + .../ManagedAgentsSpanModelRequestEndEvent.md | 57 + ...ManagedAgentsSpanModelRequestStartEvent.md | 33 + .../interfaces/ManagedAgentsSpanModelUsage.md | 53 + ...agedAgentsSpanOutcomeEvaluationEndEvent.md | 92 ++ ...AgentsSpanOutcomeEvaluationOngoingEvent.md | 53 + ...edAgentsSpanOutcomeEvaluationStartEvent.md | 50 + .../interfaces/ManagedAgentsStartEvent.md | 33 + .../ManagedAgentsStaticBearerAuthResponse.md | 25 + .../ManagedAgentsStaticBearerCreateParams.md | 33 + .../ManagedAgentsStaticBearerUpdateParams.md | 26 + ...gentsStreamSessionEventsUnionStopReason.md | 23 + ...agedAgentsStreamSessionEventsUnionUsage.md | 73 + ...treamSessionThreadEventsUnionStopReason.md | 28 + ...entsStreamSessionThreadEventsUnionUsage.md | 73 + .../ManagedAgentsSystemContentBlock.md | 25 + .../ManagedAgentsSystemContentBlockParam.md | 25 + .../ManagedAgentsSystemMessageEvent.md | 42 + .../ManagedAgentsSystemMessageEventParams.md | 30 + .../interfaces/ManagedAgentsTextBlock.md | 25 + .../interfaces/ManagedAgentsTextBlockParam.md | 25 + .../interfaces/ManagedAgentsTextRubric.md | 25 + .../ManagedAgentsTextRubricParams.md | 26 + ...anagedAgentsTokenEndpointAuthBasicParam.md | 25 + ...gedAgentsTokenEndpointAuthBasicResponse.md | 17 + ...AgentsTokenEndpointAuthBasicUpdateParam.md | 25 + ...ManagedAgentsTokenEndpointAuthNoneParam.md | 17 + ...agedAgentsTokenEndpointAuthNoneResponse.md | 17 + ...ManagedAgentsTokenEndpointAuthPostParam.md | 25 + ...agedAgentsTokenEndpointAuthPostResponse.md | 17 + ...dAgentsTokenEndpointAuthPostUpdateParam.md | 25 + .../ManagedAgentsURLDocumentSource.md | 25 + .../ManagedAgentsURLDocumentSourceParam.md | 25 + .../interfaces/ManagedAgentsURLImageSource.md | 25 + .../ManagedAgentsURLImageSourceParam.md | 25 + .../ManagedAgentsURLMCPServerParams.md | 34 + ...gentsUnknownDeploymentPausedReasonError.md | 18 + .../interfaces/ManagedAgentsUnknownError.md | 35 + .../ManagedAgentsUnknownRunError.md | 26 + ...sUnrestrictedCredentialNetworkingParams.md | 19 + ...nrestrictedCredentialNetworkingResponse.md | 18 + .../interfaces/ManagedAgentsUserActor.md | 25 + .../ManagedAgentsUserCustomToolResultEvent.md | 69 + ...edAgentsUserCustomToolResultEventParams.md | 44 + .../ManagedAgentsUserDefineOutcomeEvent.md | 67 + ...nagedAgentsUserDefineOutcomeEventParams.md | 42 + .../ManagedAgentsUserInterruptEvent.md | 43 + .../ManagedAgentsUserInterruptEventParams.md | 27 + .../interfaces/ManagedAgentsUserLocation.md | 49 + .../ManagedAgentsUserLocationParam.md | 51 + .../ManagedAgentsUserMessageEvent.md | 41 + ...gentsUserMessageEventContentUnionSource.md | 37 + .../ManagedAgentsUserMessageEventParams.md | 25 + .../ManagedAgentsUserToolConfirmationEvent.md | 73 + ...edAgentsUserToolConfirmationEventParams.md | 47 + .../ManagedAgentsUserToolResultEvent.md | 71 + .../ManagedAgentsUserToolResultEventParams.md | 46 + .../managed/interfaces/ManagedAgentsVault.md | 65 + ...aultArchivedDeploymentPausedReasonError.md | 17 + .../ManagedAgentsVaultArchivedRunError.md | 25 + ...aultNotFoundDeploymentPausedReasonError.md | 17 + .../ManagedAgentsVaultNotFoundRunError.md | 25 + .../ManagedAgentsWebFetchToolConfig.md | 53 + .../ManagedAgentsWebFetchToolConfigParams.md | 75 ++ .../ManagedAgentsWebSearchToolConfig.md | 55 + .../ManagedAgentsWebSearchToolConfigParams.md | 74 ++ ...paceArchivedDeploymentPausedReasonError.md | 17 + .../ManagedAgentsWorkspaceArchivedRunError.md | 25 + .../ManagedAgentsWriteToolConfig.md | 35 + .../ManagedAgentsWriteToolConfigParams.md | 44 + .../interfaces/MemoryStoreArchiveParams.md | 21 + .../interfaces/MemoryStoreDeleteParams.md | 21 + .../interfaces/MemoryStoreGetParams.md | 21 + .../interfaces/MemoryStoreListParams.md | 72 + .../MemoryStoreMemoryDeleteParams.md | 35 + .../interfaces/MemoryStoreMemoryGetParams.md | 37 + .../interfaces/MemoryStoreMemoryListParams.md | 72 + .../interfaces/MemoryStoreMemoryNewParams.md | 58 + .../MemoryStoreMemoryUpdateParams.md | 84 ++ .../MemoryStoreMemoryVersionGetParams.md | 37 + .../MemoryStoreMemoryVersionListParams.md | 105 ++ .../MemoryStoreMemoryVersionRedactParams.md | 27 + .../interfaces/MemoryStoreNewParams.md | 52 + .../interfaces/MemoryStoreUpdateParams.md | 50 + .../managed/interfaces/ModelCapabilities.md | 81 ++ docs/api/managed/interfaces/ModelInfo.md | 124 ++ .../api/managed/interfaces/ModelListParams.md | 49 + docs/api/managed/interfaces/MonetaryAmount.md | 31 + .../managed/interfaces/MonetaryAmountParam.md | 31 + .../interfaces/OutputBehaviorCreateNew.md | 19 + .../OutputBehaviorCreateNewParam.md | 19 + .../OutputBehaviorUpdateExisting.md | 25 + .../OutputBehaviorUpdateExistingParam.md | 25 + docs/api/managed/interfaces/Packages.md | 67 + docs/api/managed/interfaces/PackagesParams.md | 74 ++ .../interfaces/PlainTextSourceParam.md | 31 + .../interfaces/RedactedThinkingBlockParam.md | 27 + .../interfaces/RequestDocumentBlockParam.md | 49 + .../RequestMCPToolResultBlockParam.md | 43 + .../RequestToolAdditionBlockParam.md | 38 + .../RequestToolRemovalBlockParam.md | 38 + .../interfaces/SearchResultBlockParam.md | 49 + .../managed/interfaces/SelfHostedConfig.md | 17 + .../interfaces/SelfHostedConfigParams.md | 20 + docs/api/managed/interfaces/SelfHostedWork.md | 120 ++ .../SelfHostedWorkHeartbeatResponse.md | 51 + .../interfaces/SelfHostedWorkListResponse.md | 25 + .../interfaces/SelfHostedWorkQueueStats.md | 53 + .../SelfHostedWorkStopRequestParam.md | 17 + .../SelfHostedWorkUpdateRequestParam.md | 18 + .../ServerToolCaller20260120Param.md | 24 + .../interfaces/ServerToolCallerParam.md | 24 + .../interfaces/ServerToolUseBlockParam.md | 55 + .../interfaces/SessionArchiveParams.md | 21 + .../managed/interfaces/SessionDeleteParams.md | 21 + .../interfaces/SessionEventListParams.md | 105 ++ .../interfaces/SessionEventSendParams.md | 29 + .../interfaces/SessionEventStreamParams.md | 46 + .../managed/interfaces/SessionGetParams.md | 21 + .../managed/interfaces/SessionListParams.md | 132 ++ .../managed/interfaces/SessionNewParams.md | 95 ++ .../interfaces/SessionResourceAddParams.md | 45 + .../interfaces/SessionResourceDeleteParams.md | 27 + .../interfaces/SessionResourceGetParams.md | 27 + .../interfaces/SessionResourceListParams.md | 50 + .../interfaces/SessionResourceUpdateParams.md | 42 + .../interfaces/SessionThreadArchiveParams.md | 27 + .../SessionThreadEventListParams.md | 55 + .../SessionThreadEventStreamParams.md | 44 + .../interfaces/SessionThreadGetParams.md | 27 + .../interfaces/SessionThreadListParams.md | 37 + .../managed/interfaces/SessionUpdateParams.md | 72 + .../api/managed/interfaces/SessionWorkData.md | 28 + docs/api/managed/interfaces/Skill.md | 81 ++ .../managed/interfaces/SkillDeleteParams.md | 21 + docs/api/managed/interfaces/SkillGetParams.md | 21 + .../api/managed/interfaces/SkillListParams.md | 79 ++ docs/api/managed/interfaces/SkillNewParams.md | 48 + docs/api/managed/interfaces/SkillVersion.md | 77 ++ .../interfaces/SkillVersionDeleteParams.md | 31 + .../interfaces/SkillVersionDownloadParams.md | 31 + .../interfaces/SkillVersionGetParams.md | 31 + .../interfaces/SkillVersionListParams.md | 39 + .../interfaces/SkillVersionNewParams.md | 32 + docs/api/managed/interfaces/TextBlockParam.md | 37 + ...itorCodeExecutionCreateResultBlockParam.md | 24 + ...CodeExecutionStrReplaceResultBlockParam.md | 48 + ...EditorCodeExecutionToolResultBlockParam.md | 38 + ...EditorCodeExecutionToolResultErrorParam.md | 33 + ...EditorCodeExecutionViewResultBlockParam.md | 50 + .../managed/interfaces/ThinkingBlockParam.md | 37 + .../managed/interfaces/ThinkingCapability.md | 25 + docs/api/managed/interfaces/ThinkingTypes.md | 25 + .../ToolChangeMCPToolReferenceParam.md | 31 + .../ToolChangeMCPToolsetReferenceParam.md | 24 + .../ToolChangeToolReferenceParam.md | 25 + .../interfaces/ToolReferenceBlockParam.md | 31 + .../interfaces/ToolResultBlockParam.md | 51 + .../ToolSearchToolResultBlockParam.md | 38 + .../ToolSearchToolResultErrorParam.md | 33 + .../ToolSearchToolSearchResultBlockParam.md | 24 + .../managed/interfaces/ToolUseBlockParam.md | 59 + .../managed/interfaces/URLImageSourceParam.md | 23 + .../managed/interfaces/URLPDFSourceParam.md | 23 + .../managed/interfaces/UnrestrictedNetwork.md | 17 + .../interfaces/UnrestrictedNetworkParam.md | 20 + .../managed/interfaces/VaultArchiveParams.md | 21 + .../VaultCredentialArchiveParams.md | 27 + .../interfaces/VaultCredentialDeleteParams.md | 27 + .../interfaces/VaultCredentialGetParams.md | 27 + .../interfaces/VaultCredentialListParams.md | 63 + .../VaultCredentialMCPOAuthValidateParams.md | 27 + .../interfaces/VaultCredentialNewParams.md | 46 + .../interfaces/VaultCredentialUpdateParams.md | 52 + .../managed/interfaces/VaultDeleteParams.md | 21 + docs/api/managed/interfaces/VaultGetParams.md | 21 + .../api/managed/interfaces/VaultListParams.md | 63 + docs/api/managed/interfaces/VaultNewParams.md | 38 + .../managed/interfaces/WebFetchBlockParam.md | 39 + .../WebFetchToolResultBlockParam.md | 46 + .../WebFetchToolResultErrorBlockParam.md | 28 + .../interfaces/WebSearchResultBlockParam.md | 42 + .../WebSearchToolRequestErrorParam.md | 27 + .../WebSearchToolResultBlockParam.md | 46 + ...AdvisorToolResultBlockParamContentUnion.md | 9 + .../AdvisorToolResultErrorParamErrorCode.md | 9 + .../managed/type-aliases/AgentCreateParams.md | 9 + .../type-aliases/AgentNewParamsToolUnion.md | 9 + .../type-aliases/AgentRetrieveParams.md | 9 + .../AgentUpdateParamsToolUnion.md | 9 + .../Base64ImageSourceMediaType.md | 9 + ...ecutionToolResultBlockParamContentUnion.md | 9 + ...eExecutionToolResultErrorParamErrorCode.md | 9 + .../BrowserStateChangeUnionParam.md | 9 + .../type-aliases/CacheControlEphemeralTTL.md | 18 + .../CloudConfigNetworkingUnion.md | 9 + .../CloudConfigParamsNetworkingUnion.md | 9 + ...ecutionToolResultBlockParamContentUnion.md | 9 + .../CodeExecutionToolResultErrorCode.md | 9 + .../type-aliases/ContentBlockParamUnion.md | 9 + .../ContentBlockSourceContentUnionParam.md | 9 + docs/api/managed/type-aliases/Currency.md | 9 + .../managed/type-aliases/DeletedFileType.md | 13 + .../type-aliases/DeploymentCreateParams.md | 9 + .../DeploymentNewParamsAgentUnion.md | 9 + .../DeploymentNewParamsResourceUnion.md | 9 + .../type-aliases/DeploymentRetrieveParams.md | 9 + .../DeploymentRunRetrieveParams.md | 9 + .../DeploymentUpdateParamsAgentUnion.md | 9 + .../DeploymentUpdateParamsResourceUnion.md | 9 + .../managed/type-aliases/DreamCreateParams.md | 9 + .../managed/type-aliases/DreamInputUnion.md | 9 + .../type-aliases/DreamInputUnionParam.md | 9 + .../type-aliases/DreamMemoryStoreInputType.md | 9 + .../DreamModelConfigParamSpeed.md | 13 + .../type-aliases/DreamModelConfigSpeed.md | 13 + .../type-aliases/DreamNewParamsModelUnion.md | 9 + .../managed/type-aliases/DreamOutputType.md | 9 + .../type-aliases/DreamRetrieveParams.md | 9 + .../type-aliases/DreamSessionsInputType.md | 9 + docs/api/managed/type-aliases/DreamStatus.md | 11 + docs/api/managed/type-aliases/DreamType.md | 9 + .../type-aliases/EnvironmentConfigUnion.md | 9 + .../type-aliases/EnvironmentCreateParams.md | 9 + .../EnvironmentDeleteResponseType.md | 11 + .../EnvironmentNewParamsConfigUnion.md | 9 + .../type-aliases/EnvironmentNewParamsScope.md | 14 + .../type-aliases/EnvironmentRetrieveParams.md | 9 + .../managed/type-aliases/EnvironmentScope.md | 12 + .../EnvironmentUpdateParamsConfigUnion.md | 9 + .../EnvironmentUpdateParamsScope.md | 13 + .../EnvironmentWorkRetrieveParams.md | 9 + .../type-aliases/HealthCheckWorkDataType.md | 11 + .../ImageBlockParamSourceUnion.md | 9 + ...ImageTransformationsParamOversizedImage.md | 16 + .../type-aliases/ManagedAgentsAPIActorType.md | 9 + .../type-aliases/ManagedAgentsActorUnion.md | 9 + .../ManagedAgentsAdvisorParamsType.md | 9 + .../type-aliases/ManagedAgentsAdvisorType.md | 9 + ...ArchivedDeploymentPausedReasonErrorType.md | 9 + .../ManagedAgentsAgentArchivedRunErrorType.md | 9 + ...anagedAgentsAgentCustomToolUseEventType.md | 9 + ...entsAgentMCPToolResultEventContentUnion.md | 14 + ...entMCPToolResultEventContentUnionSource.md | 14 + ...anagedAgentsAgentMCPToolResultEventType.md | 9 + ...AgentMCPToolUseEventEvaluatedPermission.md | 11 + .../ManagedAgentsAgentMCPToolUseEventType.md | 9 + ...agedAgentsAgentMessageEventContentUnion.md | 9 + .../ManagedAgentsAgentMessageEventType.md | 9 + .../ManagedAgentsAgentMessagePreviewType.md | 9 + .../ManagedAgentsAgentParamsType.md | 9 + .../ManagedAgentsAgentReferenceType.md | 9 + .../ManagedAgentsAgentSkillUnion.md | 9 + .../ManagedAgentsAgentThinkingEventType.md | 9 + .../ManagedAgentsAgentThinkingPreviewType.md | 9 + ...ntsAgentThreadContextCompactedEventType.md | 9 + ...tThreadMessageReceivedEventContentUnion.md | 14 + ...entsAgentThreadMessageReceivedEventType.md | 9 + ...AgentThreadMessageSentEventContentUnion.md | 14 + ...edAgentsAgentThreadMessageSentEventType.md | 9 + ...ManagedAgentsAgentToolConfigParamsUnion.md | 9 + .../ManagedAgentsAgentToolConfigUnion.md | 9 + ...dAgentsAgentToolResultEventContentUnion.md | 14 + ...sAgentToolResultEventContentUnionSource.md | 9 + .../ManagedAgentsAgentToolResultEventType.md | 9 + .../ManagedAgentsAgentToolUnion.md | 9 + .../ManagedAgentsAgentToolUnionConfigs.md | 9 + ...ntsAgentToolUseEventEvaluatedPermission.md | 11 + .../ManagedAgentsAgentToolUseEventType.md | 9 + ...gedAgentsAgentToolset20260401ParamsType.md | 9 + .../ManagedAgentsAgentToolset20260401Type.md | 9 + ...efaultConfigParamsPermissionPolicyUnion.md | 9 + ...olsetDefaultConfigPermissionPolicyUnion.md | 13 + .../type-aliases/ManagedAgentsAgentType.md | 9 + ...AgentsAgentWithOverridesParamsToolUnion.md | 9 + ...nagedAgentsAgentWithOverridesParamsType.md | 9 + .../ManagedAgentsAlwaysAllowPolicyType.md | 9 + .../ManagedAgentsAlwaysAskPolicyType.md | 9 + .../ManagedAgentsBase64DocumentSourceType.md | 9 + .../ManagedAgentsBase64ImageSourceType.md | 9 + ...shToolConfigParamsPermissionPolicyUnion.md | 9 + .../ManagedAgentsBashToolConfigParamsType.md | 9 + ...entsBashToolConfigPermissionPolicyUnion.md | 13 + ...nagedAgentsBillingErrorRetryStatusUnion.md | 9 + .../ManagedAgentsBillingErrorType.md | 9 + .../ManagedAgentsBranchCheckoutType.md | 9 + .../ManagedAgentsBudgetLimitType.md | 9 + .../ManagedAgentsCommitCheckoutType.md | 9 + .../ManagedAgentsCredentialAuthUnion.md | 9 + ...ialHostUnreachableErrorRetryStatusUnion.md | 13 + ...gentsCredentialHostUnreachableErrorType.md | 9 + ...edAgentsCredentialNetworkingParamsUnion.md | 9 + .../ManagedAgentsCredentialType.md | 9 + ...ManagedAgentsCredentialValidationStatus.md | 11 + .../ManagedAgentsCredentialValidationType.md | 9 + .../ManagedAgentsCustomSkillParamsType.md | 9 + .../ManagedAgentsCustomSkillType.md | 9 + .../ManagedAgentsCustomToolParamsType.md | 9 + .../ManagedAgentsCustomToolType.md | 9 + .../ManagedAgentsDeleteSessionResourceType.md | 9 + .../ManagedAgentsDeletedCredentialType.md | 9 + .../ManagedAgentsDeletedMemoryStoreType.md | 9 + .../ManagedAgentsDeletedMemoryType.md | 9 + .../ManagedAgentsDeletedSessionType.md | 9 + .../ManagedAgentsDeletedVaultType.md | 9 + .../ManagedAgentsDeltaContentType.md | 9 + .../ManagedAgentsDeltaEventType.md | 9 + .../type-aliases/ManagedAgentsDeltaType.md | 11 + ...AgentsDeploymentInitialEventParamsUnion.md | 9 + ...anagedAgentsDeploymentInitialEventUnion.md | 9 + ...gentsDeploymentInitialEventUnionContent.md | 9 + ...dAgentsDeploymentPausedReasonErrorUnion.md | 26 + ...anagedAgentsDeploymentPausedReasonUnion.md | 9 + .../ManagedAgentsDeploymentRunErrorUnion.md | 9 + .../ManagedAgentsDeploymentRunType.md | 9 + .../ManagedAgentsDeploymentStatus.md | 11 + ...dAgentsDeploymentSystemMessageEventType.md | 9 + .../ManagedAgentsDeploymentType.md | 9 + ...oymentUserDefineOutcomeEventRubricUnion.md | 13 + ...ntsDeploymentUserDefineOutcomeEventType.md | 9 + ...sDeploymentUserMessageEventContentUnion.md | 14 + ...gedAgentsDeploymentUserMessageEventType.md | 9 + .../ManagedAgentsDocumentBlockSourceUnion.md | 9 + ...agedAgentsDocumentBlockSourceUnionParam.md | 9 + .../ManagedAgentsDocumentBlockType.md | 9 + ...itToolConfigParamsPermissionPolicyUnion.md | 9 + .../ManagedAgentsEditToolConfigParamsType.md | 9 + ...entsEditToolConfigPermissionPolicyUnion.md | 13 + .../ManagedAgentsEffortHighType.md | 9 + .../ManagedAgentsEffortLowType.md | 9 + .../ManagedAgentsEffortMaxType.md | 9 + .../ManagedAgentsEffortMediumType.md | 9 + .../ManagedAgentsEffortXhighType.md | 9 + ...ArchivedDeploymentPausedReasonErrorType.md | 9 + ...edAgentsEnvironmentArchivedRunErrorType.md | 9 + ...NotFoundDeploymentPausedReasonErrorType.md | 9 + ...edAgentsEnvironmentNotFoundRunErrorType.md | 9 + ...mentVariableAuthResponseNetworkingUnion.md | 14 + ...entsEnvironmentVariableAuthResponseType.md | 9 + ...entsEnvironmentVariableCreateParamsType.md | 9 + ...entsEnvironmentVariableUpdateParamsType.md | 9 + ...edAgentsErrorDeploymentPausedReasonType.md | 9 + .../ManagedAgentsEventParamsUnion.md | 9 + .../ManagedAgentsFileDocumentSourceType.md | 9 + .../ManagedAgentsFileImageSourceType.md | 9 + ...NotFoundDeploymentPausedReasonErrorType.md | 9 + .../ManagedAgentsFileNotFoundRunErrorType.md | 9 + .../ManagedAgentsFileResourceConfigType.md | 9 + .../ManagedAgentsFileResourceParamsType.md | 9 + .../ManagedAgentsFileResourceType.md | 9 + .../ManagedAgentsFileRubricParamsType.md | 9 + .../ManagedAgentsFileRubricType.md | 9 + ...tsGitHubRepositoryResourceCheckoutUnion.md | 13 + ...ubRepositoryResourceConfigCheckoutUnion.md | 13 + ...gentsGitHubRepositoryResourceConfigType.md | 9 + ...ubRepositoryResourceParamsCheckoutUnion.md | 9 + ...gentsGitHubRepositoryResourceParamsType.md | 9 + ...nagedAgentsGitHubRepositoryResourceType.md | 9 + ...obToolConfigParamsPermissionPolicyUnion.md | 9 + .../ManagedAgentsGlobToolConfigParamsType.md | 9 + ...entsGlobToolConfigPermissionPolicyUnion.md | 13 + ...epToolConfigParamsPermissionPolicyUnion.md | 9 + .../ManagedAgentsGrepToolConfigParamsType.md | 9 + ...entsGrepToolConfigPermissionPolicyUnion.md | 13 + .../ManagedAgentsImageBlockSourceUnion.md | 9 + ...ManagedAgentsImageBlockSourceUnionParam.md | 9 + .../ManagedAgentsImageBlockType.md | 9 + ...tsLimitedCredentialNetworkingParamsType.md | 9 + ...LimitedCredentialNetworkingResponseType.md | 9 + ...thenticationFailedErrorRetryStatusUnion.md | 13 + ...dAgentsMCPAuthenticationFailedErrorType.md | 9 + ...CPConnectionFailedErrorRetryStatusUnion.md | 13 + ...nagedAgentsMCPConnectionFailedErrorType.md | 9 + ...sBlockedDeploymentPausedReasonErrorType.md | 9 + ...nagedAgentsMCPEgressBlockedRunErrorType.md | 9 + .../ManagedAgentsMCPOAuthAuthResponseType.md | 9 + .../ManagedAgentsMCPOAuthCreateParamsType.md | 9 + ...AuthRefreshParamsTokenEndpointAuthUnion.md | 9 + ...thRefreshResponseTokenEndpointAuthUnion.md | 15 + ...freshUpdateParamsTokenEndpointAuthUnion.md | 9 + .../ManagedAgentsMCPOAuthUpdateParamsType.md | 9 + ...ManagedAgentsMCPServerURLDefinitionType.md | 9 + ...CPToolConfigParamsPermissionPolicyUnion.md | 9 + ...gentsMCPToolConfigPermissionPolicyUnion.md | 13 + ...efaultConfigParamsPermissionPolicyUnion.md | 9 + ...olsetDefaultConfigPermissionPolicyUnion.md | 13 + .../ManagedAgentsMCPToolsetParamsType.md | 9 + .../ManagedAgentsMCPToolsetType.md | 9 + ...dAgentsManualDeploymentPausedReasonType.md | 9 + .../ManagedAgentsManualTriggerContextType.md | 9 + .../ManagedAgentsMemoryListItemUnion.md | 9 + .../ManagedAgentsMemoryPrefixType.md | 9 + ...ArchivedDeploymentPausedReasonErrorType.md | 9 + ...edAgentsMemoryStoreArchivedRunErrorType.md | 9 + .../ManagedAgentsMemoryStoreResourceAccess.md | 11 + ...edAgentsMemoryStoreResourceConfigAccess.md | 11 + ...agedAgentsMemoryStoreResourceConfigType.md | 9 + ...gedAgentsMemoryStoreResourceParamAccess.md | 11 + ...nagedAgentsMemoryStoreResourceParamType.md | 9 + .../ManagedAgentsMemoryStoreResourceType.md | 9 + .../ManagedAgentsMemoryStoreType.md | 9 + .../type-aliases/ManagedAgentsMemoryType.md | 9 + .../ManagedAgentsMemoryVersionOperation.md | 12 + .../ManagedAgentsMemoryVersionType.md | 9 + .../type-aliases/ManagedAgentsMemoryView.md | 15 + .../type-aliases/ManagedAgentsModel.md | 14 + .../type-aliases/ManagedAgentsModelConfig.md | 58 + .../ManagedAgentsModelConfigEffortUnion.md | 9 + .../ManagedAgentsModelConfigParams.md | 60 + ...figParamsEffortManagedAgentsEffortLevel.md | 13 + ...nagedAgentsModelConfigParamsEffortUnion.md | 9 + .../ManagedAgentsModelConfigParamsSpeed.md | 13 + .../ManagedAgentsModelConfigSpeed.md | 13 + ...ntsModelOverloadedErrorRetryStatusUnion.md | 13 + .../ManagedAgentsModelOverloadedErrorType.md | 9 + ...tsModelRateLimitedErrorRetryStatusUnion.md | 13 + .../ManagedAgentsModelRateLimitedErrorType.md | 9 + ...ModelRequestFailedErrorRetryStatusUnion.md | 13 + ...anagedAgentsModelRequestFailedErrorType.md | 9 + .../ManagedAgentsMultiagentAgentUnion.md | 9 + .../ManagedAgentsMultiagentParamsType.md | 9 + ...dAgentsMultiagentRosterEntryParamsUnion.md | 9 + .../ManagedAgentsMultiagentSelfParamsType.md | 9 + .../ManagedAgentsMultiagentType.md | 9 + ...DisabledDeploymentPausedReasonErrorType.md | 9 + ...dAgentsOrganizationDisabledRunErrorType.md | 9 + ...agedAgentsOutcomeEvaluationResourceType.md | 9 + ...dAgentsPlainTextDocumentSourceMediaType.md | 11 + ...anagedAgentsPlainTextDocumentSourceType.md | 9 + .../ManagedAgentsPreconditionType.md | 9 + .../ManagedAgentsQoderSkillParamsType.md | 9 + .../ManagedAgentsQoderSkillType.md | 9 + ...adToolConfigParamsPermissionPolicyUnion.md | 9 + .../ManagedAgentsReadToolConfigParamsType.md | 9 + ...entsReadToolConfigPermissionPolicyUnion.md | 13 + .../ManagedAgentsRedactedBlockType.md | 9 + .../ManagedAgentsRefreshObjectStatus.md | 11 + .../ManagedAgentsRetryStatusExhaustedType.md | 9 + .../ManagedAgentsRetryStatusRetryingType.md | 9 + .../ManagedAgentsRetryStatusTerminalType.md | 9 + .../ManagedAgentsScheduleParamsType.md | 9 + ...ManagedAgentsScheduleTriggerContextType.md | 9 + .../type-aliases/ManagedAgentsScheduleType.md | 9 + .../ManagedAgentsSearchResultBlockType.md | 9 + .../ManagedAgentsSearchResultContentType.md | 9 + ...upportedDeploymentPausedReasonErrorType.md | 9 + ...fHostedResourcesUnsupportedRunErrorType.md | 9 + ...ManagedAgentsSendSessionEventsDataUnion.md | 9 + ...AgentsSendSessionEventsDataUnionContent.md | 9 + .../ManagedAgentsSessionActorType.md | 9 + .../ManagedAgentsSessionAgentSkillUnion.md | 9 + .../ManagedAgentsSessionAgentToolUnion.md | 9 + ...nagedAgentsSessionAgentToolUnionConfigs.md | 9 + .../ManagedAgentsSessionAgentType.md | 9 + ...dAgentsSessionAgentUpdateToolUnionParam.md | 9 + .../ManagedAgentsSessionBudgetReachedType.md | 9 + ...entsSessionCreationRejectedRunErrorType.md | 9 + .../ManagedAgentsSessionDeletedEventType.md | 9 + .../ManagedAgentsSessionEndTurnType.md | 9 + ...anagedAgentsSessionErrorEventErrorUnion.md | 9 + .../ManagedAgentsSessionErrorEventType.md | 9 + .../ManagedAgentsSessionEventUnion.md | 9 + .../ManagedAgentsSessionEventUnionContent.md | 9 + ...sSessionMultiagentCoordinatorAgentUnion.md | 13 + ...ionMultiagentCoordinatorAgentUnionModel.md | 48 + ...dAgentsSessionMultiagentCoordinatorType.md | 9 + ...gedAgentsSessionRateLimitedRunErrorType.md | 9 + .../ManagedAgentsSessionRequiresActionType.md | 9 + ...ManagedAgentsSessionResourceConfigUnion.md | 9 + ...NotFoundDeploymentPausedReasonErrorType.md | 9 + ...entsSessionResourceNotFoundRunErrorType.md | 9 + .../ManagedAgentsSessionResourceUnion.md | 9 + ...anagedAgentsSessionRetriesExhaustedType.md | 9 + .../ManagedAgentsSessionStatus.md | 11 + ...tsSessionStatusIdleEventStopReasonUnion.md | 15 + ...ManagedAgentsSessionStatusIdleEventType.md | 9 + ...AgentsSessionStatusRescheduledEventType.md | 9 + ...agedAgentsSessionStatusRunningEventType.md | 9 + ...dAgentsSessionStatusTerminatedEventType.md | 9 + ...nagedAgentsSessionThreadAgentSkillUnion.md | 9 + ...anagedAgentsSessionThreadAgentToolUnion.md | 9 + ...gentsSessionThreadAgentToolUnionConfigs.md | 9 + .../ManagedAgentsSessionThreadAgentType.md | 9 + .../ManagedAgentsSessionThreadAgentUnion.md | 9 + ...nagedAgentsSessionThreadAgentUnionModel.md | 43 + ...agedAgentsSessionThreadCreatedEventType.md | 9 + .../ManagedAgentsSessionThreadStatus.md | 11 + ...ionThreadStatusIdleEventStopReasonUnion.md | 15 + ...dAgentsSessionThreadStatusIdleEventType.md | 9 + ...SessionThreadStatusRescheduledEventType.md | 9 + ...entsSessionThreadStatusRunningEventType.md | 9 + ...sSessionThreadStatusTerminatedEventType.md | 9 + .../ManagedAgentsSessionThreadType.md | 9 + .../type-aliases/ManagedAgentsSessionType.md | 9 + .../ManagedAgentsSessionUpdatedEventType.md | 9 + .../ManagedAgentsSessionUsageEventType.md | 9 + ...NotFoundDeploymentPausedReasonErrorType.md | 9 + .../ManagedAgentsSkillNotFoundRunErrorType.md | 9 + .../ManagedAgentsSkillParamsUnion.md | 9 + ...nagedAgentsSpanModelRequestEndEventType.md | 9 + ...gedAgentsSpanModelRequestStartEventType.md | 9 + .../ManagedAgentsSpanModelUsageSpeed.md | 13 + ...AgentsSpanOutcomeEvaluationEndEventType.md | 9 + ...tsSpanOutcomeEvaluationOngoingEventType.md | 9 + ...entsSpanOutcomeEvaluationStartEventType.md | 9 + .../ManagedAgentsStartEventPreviewUnion.md | 9 + .../ManagedAgentsStartEventType.md | 9 + ...nagedAgentsStaticBearerAuthResponseType.md | 9 + ...nagedAgentsStaticBearerCreateParamsType.md | 9 + ...nagedAgentsStaticBearerUpdateParamsType.md | 9 + .../ManagedAgentsStreamSessionEventsUnion.md | 9 + ...edAgentsStreamSessionEventsUnionContent.md | 9 + ...gedAgentsStreamSessionThreadEventsUnion.md | 9 + ...tsStreamSessionThreadEventsUnionContent.md | 9 + .../ManagedAgentsSystemContentBlockType.md | 9 + ...nagedAgentsSystemMessageEventParamsType.md | 9 + .../ManagedAgentsSystemMessageEventType.md | 9 + .../ManagedAgentsTextBlockType.md | 9 + .../ManagedAgentsTextRubricParamsType.md | 9 + .../ManagedAgentsTextRubricType.md | 9 + ...edAgentsTokenEndpointAuthBasicParamType.md | 9 + ...gentsTokenEndpointAuthBasicResponseType.md | 9 + ...tsTokenEndpointAuthBasicUpdateParamType.md | 9 + ...gedAgentsTokenEndpointAuthNoneParamType.md | 9 + ...AgentsTokenEndpointAuthNoneResponseType.md | 9 + ...gedAgentsTokenEndpointAuthPostParamType.md | 9 + ...AgentsTokenEndpointAuthPostResponseType.md | 9 + ...ntsTokenEndpointAuthPostUpdateParamType.md | 9 + .../ManagedAgentsTriggerContextUnion.md | 9 + .../type-aliases/ManagedAgentsTriggerType.md | 11 + .../ManagedAgentsURLDocumentSourceType.md | 9 + .../ManagedAgentsURLImageSourceType.md | 9 + .../ManagedAgentsURLMCPServerParamsType.md | 9 + ...sUnknownDeploymentPausedReasonErrorType.md | 9 + ...nagedAgentsUnknownErrorRetryStatusUnion.md | 9 + .../ManagedAgentsUnknownErrorType.md | 9 + .../ManagedAgentsUnknownRunErrorType.md | 9 + ...estrictedCredentialNetworkingParamsType.md | 9 + ...trictedCredentialNetworkingResponseType.md | 9 + .../ManagedAgentsUserActorType.md | 9 + ...tsUserCustomToolResultEventContentUnion.md | 14 + ...CustomToolResultEventContentUnionSource.md | 14 + ...CustomToolResultEventParamsContentUnion.md | 9 + ...entsUserCustomToolResultEventParamsType.md | 9 + ...agedAgentsUserCustomToolResultEventType.md | 9 + ...UserDefineOutcomeEventParamsRubricUnion.md | 9 + ...dAgentsUserDefineOutcomeEventParamsType.md | 9 + ...AgentsUserDefineOutcomeEventRubricUnion.md | 13 + ...ManagedAgentsUserDefineOutcomeEventType.md | 9 + ...nagedAgentsUserInterruptEventParamsType.md | 9 + .../ManagedAgentsUserInterruptEventType.md | 9 + ...nagedAgentsUserMessageEventContentUnion.md | 9 + ...gentsUserMessageEventParamsContentUnion.md | 9 + ...ManagedAgentsUserMessageEventParamsType.md | 9 + .../ManagedAgentsUserMessageEventType.md | 9 + ...tsUserToolConfirmationEventParamsResult.md | 11 + ...entsUserToolConfirmationEventParamsType.md | 9 + ...edAgentsUserToolConfirmationEventResult.md | 11 + ...agedAgentsUserToolConfirmationEventType.md | 9 + ...edAgentsUserToolResultEventContentUnion.md | 14 + ...tsUserToolResultEventContentUnionSource.md | 9 + ...tsUserToolResultEventParamsContentUnion.md | 9 + ...agedAgentsUserToolResultEventParamsType.md | 9 + .../ManagedAgentsUserToolResultEventType.md | 9 + ...ArchivedDeploymentPausedReasonErrorType.md | 9 + .../ManagedAgentsVaultArchivedRunErrorType.md | 9 + ...NotFoundDeploymentPausedReasonErrorType.md | 9 + .../ManagedAgentsVaultNotFoundRunErrorType.md | 9 + .../type-aliases/ManagedAgentsVaultType.md | 9 + ...chToolConfigParamsPermissionPolicyUnion.md | 9 + ...nagedAgentsWebFetchToolConfigParamsType.md | 9 + ...WebFetchToolConfigPermissionPolicyUnion.md | 13 + ...chToolConfigParamsPermissionPolicyUnion.md | 9 + ...agedAgentsWebSearchToolConfigParamsType.md | 9 + ...ebSearchToolConfigPermissionPolicyUnion.md | 13 + ...ArchivedDeploymentPausedReasonErrorType.md | 9 + ...agedAgentsWorkspaceArchivedRunErrorType.md | 9 + ...teToolConfigParamsPermissionPolicyUnion.md | 9 + .../ManagedAgentsWriteToolConfigParamsType.md | 9 + ...ntsWriteToolConfigPermissionPolicyUnion.md | 13 + .../type-aliases/MemoryStoreCreateParams.md | 9 + .../MemoryStoreMemoryCreateParams.md | 9 + .../MemoryStoreMemoryRetrieveParams.md | 9 + .../MemoryStoreMemoryVersionRetrieveParams.md | 9 + .../type-aliases/MemoryStoreRetrieveParams.md | 9 + docs/api/managed/type-aliases/Model.md | 11 + .../OutputBehaviorCreateNewType.md | 9 + .../type-aliases/OutputBehaviorUnion.md | 9 + .../type-aliases/OutputBehaviorUnionParam.md | 9 + .../OutputBehaviorUpdateExistingType.md | 9 + .../type-aliases/PackagesParamsType.md | 11 + docs/api/managed/type-aliases/PackagesType.md | 11 + docs/api/managed/type-aliases/QoderBeta.md | 9 + .../RequestDocumentBlockSourceUnionParam.md | 9 + ...uestMCPToolResultBlockParamContentUnion.md | 9 + .../RequestToolAdditionBlockToolUnionParam.md | 9 + .../RequestToolRemovalBlockToolUnionParam.md | 9 + .../SelfHostedWorkHeartbeatResponseState.md | 11 + .../type-aliases/SelfHostedWorkState.md | 11 + .../ServerToolUseBlockParamCallerUnion.md | 9 + .../ServerToolUseBlockParamName.md | 9 + .../type-aliases/SessionCreateParams.md | 9 + .../SessionEventListParamsOrder.md | 12 + .../type-aliases/SessionListParamsOrder.md | 12 + .../SessionNewParamsAgentUnion.md | 9 + .../SessionNewParamsInitialEventUnion.md | 9 + .../SessionNewParamsResourceUnion.md | 9 + .../SessionResourceGetResponseUnion.md | 9 + .../SessionResourceRetrieveParams.md | 9 + .../SessionResourceUpdateResponseUnion.md | 9 + .../type-aliases/SessionRetrieveParams.md | 9 + .../SessionThreadRetrieveParams.md | 9 + .../managed/type-aliases/SkillCreateParams.md | 9 + .../type-aliases/SkillRetrieveParams.md | 9 + docs/api/managed/type-aliases/SkillSource.md | 34 + .../managed/type-aliases/SkillSourceType.md | 18 + .../type-aliases/SkillVersionCreateParams.md | 9 + .../SkillVersionRetrieveParams.md | 9 + .../type-aliases/TextCitationParamUnion.md | 9 + ...ecutionToolResultBlockParamContentUnion.md | 9 + ...eExecutionToolResultErrorParamErrorCode.md | 9 + ...deExecutionViewResultBlockParamFileType.md | 9 + .../ToolResultBlockParamContentUnion.md | 9 + ...lSearchToolResultBlockParamContentUnion.md | 9 + ...ToolSearchToolResultErrorParamErrorCode.md | 9 + .../ToolUseBlockParamCallerUnion.md | 9 + .../managed/type-aliases/VaultCreateParams.md | 9 + .../VaultCredentialCreateParams.md | 9 + .../VaultCredentialNewParamsAuthUnion.md | 9 + .../VaultCredentialRetrieveParams.md | 9 + .../VaultCredentialUpdateParamsAuthUnion.md | 9 + .../type-aliases/VaultRetrieveParams.md | 9 + ...WebFetchToolResultBlockParamCallerUnion.md | 9 + ...ebFetchToolResultBlockParamContentUnion.md | 9 + .../WebFetchToolResultErrorCode.md | 9 + ...ebSearchToolResultBlockParamCallerUnion.md | 9 + ...bSearchToolResultBlockParamContentUnion.md | 9 + .../WebSearchToolResultErrorCode.md | 9 + docs/metadata.yaml | 22 + package-lock.json | 273 ++++ package.json | 5 +- scripts/generate-docs.mjs | 177 +++ 1268 files changed, 48177 insertions(+), 2 deletions(-) create mode 100644 docs/api/README.md create mode 100644 docs/api/forward/README.md create mode 100644 docs/api/forward/classes/BatchTasks.md create mode 100644 docs/api/forward/classes/Batches.md create mode 100644 docs/api/forward/classes/ChannelPairings.md create mode 100644 docs/api/forward/classes/ChannelQRSessions.md create mode 100644 docs/api/forward/classes/Channels.md create mode 100644 docs/api/forward/classes/Environments.md create mode 100644 docs/api/forward/classes/Files.md create mode 100644 docs/api/forward/classes/Identities.md create mode 100644 docs/api/forward/classes/IdentityConfigs.md create mode 100644 docs/api/forward/classes/IdentityMemoryStores.md create mode 100644 docs/api/forward/classes/MemoryStoreMemories.md create mode 100644 docs/api/forward/classes/MemoryStoreMemoryVersions.md create mode 100644 docs/api/forward/classes/MemoryStores.md create mode 100644 docs/api/forward/classes/Models.md create mode 100644 docs/api/forward/classes/ScheduleRuns.md create mode 100644 docs/api/forward/classes/Schedules.md create mode 100644 docs/api/forward/classes/SessionEvents.md create mode 100644 docs/api/forward/classes/SessionResources.md create mode 100644 docs/api/forward/classes/SessionThreadEvents.md create mode 100644 docs/api/forward/classes/SessionThreads.md create mode 100644 docs/api/forward/classes/Sessions.md create mode 100644 docs/api/forward/classes/SkillVersions.md create mode 100644 docs/api/forward/classes/Skills.md create mode 100644 docs/api/forward/classes/Templates.md create mode 100644 docs/api/forward/classes/VaultCredentials.md create mode 100644 docs/api/forward/classes/Vaults.md create mode 100644 docs/api/forward/interfaces/Batch.md create mode 100644 docs/api/forward/interfaces/BatchCancelParams.md create mode 100644 docs/api/forward/interfaces/BatchFile.md create mode 100644 docs/api/forward/interfaces/BatchListParams.md create mode 100644 docs/api/forward/interfaces/BatchNewParams.md create mode 100644 docs/api/forward/interfaces/BatchRequestCounts.md create mode 100644 docs/api/forward/interfaces/BatchTask.md create mode 100644 docs/api/forward/interfaces/BatchTaskArtifactsItem.md create mode 100644 docs/api/forward/interfaces/BatchTaskError.md create mode 100644 docs/api/forward/interfaces/BatchTaskListParams.md create mode 100644 docs/api/forward/interfaces/BatchTaskUsage.md create mode 100644 docs/api/forward/interfaces/BatchUsage.md create mode 100644 docs/api/forward/interfaces/Channel.md create mode 100644 docs/api/forward/interfaces/ChannelChannelConfig.md create mode 100644 docs/api/forward/interfaces/ChannelChannelConfigResponseOptions.md create mode 100644 docs/api/forward/interfaces/ChannelIdentityResolution.md create mode 100644 docs/api/forward/interfaces/ChannelListParams.md create mode 100644 docs/api/forward/interfaces/ChannelNewParams.md create mode 100644 docs/api/forward/interfaces/ChannelPairing.md create mode 100644 docs/api/forward/interfaces/ChannelPairingNewParams.md create mode 100644 docs/api/forward/interfaces/ChannelQRSession.md create mode 100644 docs/api/forward/interfaces/ChannelQRSessionNewParams.md create mode 100644 docs/api/forward/interfaces/ChannelUpdateParams.md create mode 100644 docs/api/forward/interfaces/ContentBlock.md create mode 100644 docs/api/forward/interfaces/ContentBlockParam.md create mode 100644 docs/api/forward/interfaces/DeletedChannel.md create mode 100644 docs/api/forward/interfaces/DeletedChannelPairing.md create mode 100644 docs/api/forward/interfaces/DeletedIdentity.md create mode 100644 docs/api/forward/interfaces/DeletedMemory.md create mode 100644 docs/api/forward/interfaces/DeletedMemoryStore.md create mode 100644 docs/api/forward/interfaces/DeletedMemoryStoreMount.md create mode 100644 docs/api/forward/interfaces/DeletedSkillVersion.md create mode 100644 docs/api/forward/interfaces/EffectiveConfig.md create mode 100644 docs/api/forward/interfaces/EffectiveConfigAgent.md create mode 100644 docs/api/forward/interfaces/EffectiveConfigAgentToolsItem.md create mode 100644 docs/api/forward/interfaces/EffectiveConfigAgentToolsItemConfigsItem.md create mode 100644 docs/api/forward/interfaces/EffectiveConfigSession.md create mode 100644 docs/api/forward/interfaces/EffectiveConfigSessionResourcesItem.md create mode 100644 docs/api/forward/interfaces/Environment.md create mode 100644 docs/api/forward/interfaces/EnvironmentConfig.md create mode 100644 docs/api/forward/interfaces/EnvironmentConfigPackages.md create mode 100644 docs/api/forward/interfaces/EnvironmentListParams.md create mode 100644 docs/api/forward/interfaces/EnvironmentNewParams.md create mode 100644 docs/api/forward/interfaces/EnvironmentUpdateParams.md create mode 100644 docs/api/forward/interfaces/EnvironmentVariableOverride.md create mode 100644 docs/api/forward/interfaces/EnvironmentVariableOverrideParam.md create mode 100644 docs/api/forward/interfaces/FileListParams.md create mode 100644 docs/api/forward/interfaces/FileMetadata.md create mode 100644 docs/api/forward/interfaces/FileUploadParams.md create mode 100644 docs/api/forward/interfaces/GitHubRepository.md create mode 100644 docs/api/forward/interfaces/GitHubRepositoryParam.md create mode 100644 docs/api/forward/interfaces/Identity.md create mode 100644 docs/api/forward/interfaces/IdentityClearParams.md create mode 100644 docs/api/forward/interfaces/IdentityClearResponse.md create mode 100644 docs/api/forward/interfaces/IdentityClearResponseSummary.md create mode 100644 docs/api/forward/interfaces/IdentityConfig.md create mode 100644 docs/api/forward/interfaces/IdentityConfigListParams.md create mode 100644 docs/api/forward/interfaces/IdentityConfigSpec.md create mode 100644 docs/api/forward/interfaces/IdentityConfigSpecParam.md create mode 100644 docs/api/forward/interfaces/IdentityConfigUpsertParams.md create mode 100644 docs/api/forward/interfaces/IdentityListParams.md create mode 100644 docs/api/forward/interfaces/IdentityListTemplatesResponse.md create mode 100644 docs/api/forward/interfaces/IdentityMemoryStoreListResponse.md create mode 100644 docs/api/forward/interfaces/IdentityMemoryStoreMountParams.md create mode 100644 docs/api/forward/interfaces/IdentityNewParams.md create mode 100644 docs/api/forward/interfaces/IdentityStats.md create mode 100644 docs/api/forward/interfaces/IdentityTemplate.md create mode 100644 docs/api/forward/interfaces/IdentityUpdateParams.md create mode 100644 docs/api/forward/interfaces/ImageSource.md create mode 100644 docs/api/forward/interfaces/ImageSourceParam.md create mode 100644 docs/api/forward/interfaces/MCPServer.md create mode 100644 docs/api/forward/interfaces/MCPServerOverride.md create mode 100644 docs/api/forward/interfaces/MCPServerOverrideParam.md create mode 100644 docs/api/forward/interfaces/MCPServerParam.md create mode 100644 docs/api/forward/interfaces/Memory.md create mode 100644 docs/api/forward/interfaces/MemoryStore.md create mode 100644 docs/api/forward/interfaces/MemoryStoreListParams.md create mode 100644 docs/api/forward/interfaces/MemoryStoreMemoryListParams.md create mode 100644 docs/api/forward/interfaces/MemoryStoreMemoryNewParams.md create mode 100644 docs/api/forward/interfaces/MemoryStoreMemoryUpdateParams.md create mode 100644 docs/api/forward/interfaces/MemoryStoreMemoryVersionListParams.md create mode 100644 docs/api/forward/interfaces/MemoryStoreMount.md create mode 100644 docs/api/forward/interfaces/MemoryStoreNewParams.md create mode 100644 docs/api/forward/interfaces/MemoryStoreUpdateParams.md create mode 100644 docs/api/forward/interfaces/MemoryVersion.md create mode 100644 docs/api/forward/interfaces/Model.md create mode 100644 docs/api/forward/interfaces/ModelConfigObject.md create mode 100644 docs/api/forward/interfaces/ModelConfigParam.md create mode 100644 docs/api/forward/interfaces/ModelListResponse.md create mode 100644 docs/api/forward/interfaces/MultiagentConfig.md create mode 100644 docs/api/forward/interfaces/MultiagentConfigParam.md create mode 100644 docs/api/forward/interfaces/MultiagentEntry.md create mode 100644 docs/api/forward/interfaces/MultiagentEntryParam.md create mode 100644 docs/api/forward/interfaces/PermissionPolicy.md create mode 100644 docs/api/forward/interfaces/PermissionPolicyParam.md create mode 100644 docs/api/forward/interfaces/ResourceBinding.md create mode 100644 docs/api/forward/interfaces/ResourceBindingParam.md create mode 100644 docs/api/forward/interfaces/Schedule.md create mode 100644 docs/api/forward/interfaces/ScheduleArchiveManyParams.md create mode 100644 docs/api/forward/interfaces/ScheduleArchiveManyResponse.md create mode 100644 docs/api/forward/interfaces/ScheduleArchiveParams.md create mode 100644 docs/api/forward/interfaces/ScheduleExecution.md create mode 100644 docs/api/forward/interfaces/ScheduleInitialEventsItem.md create mode 100644 docs/api/forward/interfaces/ScheduleListParams.md create mode 100644 docs/api/forward/interfaces/ScheduleNewParams.md create mode 100644 docs/api/forward/interfaces/SchedulePauseParams.md create mode 100644 docs/api/forward/interfaces/SchedulePausedReason.md create mode 100644 docs/api/forward/interfaces/ScheduleRun.md create mode 100644 docs/api/forward/interfaces/ScheduleRunGetParams.md create mode 100644 docs/api/forward/interfaces/ScheduleRunListParams.md create mode 100644 docs/api/forward/interfaces/ScheduleRunParams.md create mode 100644 docs/api/forward/interfaces/ScheduleRunTriggerContext.md create mode 100644 docs/api/forward/interfaces/ScheduleSinksItem.md create mode 100644 docs/api/forward/interfaces/ScheduleSinksItemTarget.md create mode 100644 docs/api/forward/interfaces/ScheduleTriggerPolicy.md create mode 100644 docs/api/forward/interfaces/ScheduleUnpauseParams.md create mode 100644 docs/api/forward/interfaces/ScheduleUpdateParams.md create mode 100644 docs/api/forward/interfaces/Session.md create mode 100644 docs/api/forward/interfaces/SessionArchiveParams.md create mode 100644 docs/api/forward/interfaces/SessionCancelParams.md create mode 100644 docs/api/forward/interfaces/SessionConfig.md create mode 100644 docs/api/forward/interfaces/SessionEvent.md create mode 100644 docs/api/forward/interfaces/SessionEventListParams.md create mode 100644 docs/api/forward/interfaces/SessionEventParam.md create mode 100644 docs/api/forward/interfaces/SessionEventSendParams.md create mode 100644 docs/api/forward/interfaces/SessionEventSendResponse.md create mode 100644 docs/api/forward/interfaces/SessionEventStreamParams.md create mode 100644 docs/api/forward/interfaces/SessionListParams.md create mode 100644 docs/api/forward/interfaces/SessionNewParams.md create mode 100644 docs/api/forward/interfaces/SessionNewParamsConfigParam.md create mode 100644 docs/api/forward/interfaces/SessionResource.md create mode 100644 docs/api/forward/interfaces/SessionResourceAddParams.md create mode 100644 docs/api/forward/interfaces/SessionResourceSpec.md create mode 100644 docs/api/forward/interfaces/SessionResourceSpecParam.md create mode 100644 docs/api/forward/interfaces/SessionStats.md create mode 100644 docs/api/forward/interfaces/SessionTemplate.md create mode 100644 docs/api/forward/interfaces/SessionThread.md create mode 100644 docs/api/forward/interfaces/SessionThreadArchiveParams.md create mode 100644 docs/api/forward/interfaces/SessionThreadEventListParams.md create mode 100644 docs/api/forward/interfaces/SessionThreadEventStreamParams.md create mode 100644 docs/api/forward/interfaces/SessionThreadListParams.md create mode 100644 docs/api/forward/interfaces/SessionThreadStopReason.md create mode 100644 docs/api/forward/interfaces/SessionUpdateParams.md create mode 100644 docs/api/forward/interfaces/SessionUpdateParamsConfigParam.md create mode 100644 docs/api/forward/interfaces/SessionUsage.md create mode 100644 docs/api/forward/interfaces/Skill.md create mode 100644 docs/api/forward/interfaces/SkillBinding.md create mode 100644 docs/api/forward/interfaces/SkillBindingParam.md create mode 100644 docs/api/forward/interfaces/SkillGetParams.md create mode 100644 docs/api/forward/interfaces/SkillListParams.md create mode 100644 docs/api/forward/interfaces/SkillNewParams.md create mode 100644 docs/api/forward/interfaces/SkillOverride.md create mode 100644 docs/api/forward/interfaces/SkillOverrideParam.md create mode 100644 docs/api/forward/interfaces/SkillUpdateParams.md create mode 100644 docs/api/forward/interfaces/SkillVersion.md create mode 100644 docs/api/forward/interfaces/SkillVersionListParams.md create mode 100644 docs/api/forward/interfaces/SkillVersionNewParams.md create mode 100644 docs/api/forward/interfaces/SystemOverride.md create mode 100644 docs/api/forward/interfaces/SystemOverrideParam.md create mode 100644 docs/api/forward/interfaces/Template.md create mode 100644 docs/api/forward/interfaces/TemplateArchiveParams.md create mode 100644 docs/api/forward/interfaces/TemplateCloneParams.md create mode 100644 docs/api/forward/interfaces/TemplateListParams.md create mode 100644 docs/api/forward/interfaces/TemplateNewParams.md create mode 100644 docs/api/forward/interfaces/TemplateUpdateParams.md create mode 100644 docs/api/forward/interfaces/Tool.md create mode 100644 docs/api/forward/interfaces/ToolConfig.md create mode 100644 docs/api/forward/interfaces/ToolConfigParam.md create mode 100644 docs/api/forward/interfaces/ToolOverride.md create mode 100644 docs/api/forward/interfaces/ToolOverrideParam.md create mode 100644 docs/api/forward/interfaces/ToolParam.md create mode 100644 docs/api/forward/interfaces/Vault.md create mode 100644 docs/api/forward/interfaces/VaultCredential.md create mode 100644 docs/api/forward/interfaces/VaultCredentialAuth.md create mode 100644 docs/api/forward/interfaces/VaultCredentialListParams.md create mode 100644 docs/api/forward/interfaces/VaultCredentialNewParams.md create mode 100644 docs/api/forward/interfaces/VaultListParams.md create mode 100644 docs/api/forward/interfaces/VaultNewParams.md create mode 100644 docs/api/forward/type-aliases/BatchCreateParams.md create mode 100644 docs/api/forward/type-aliases/ChannelCreateParams.md create mode 100644 docs/api/forward/type-aliases/ChannelPairingCreateParams.md create mode 100644 docs/api/forward/type-aliases/ChannelQRSessionCreateParams.md create mode 100644 docs/api/forward/type-aliases/EnvironmentCreateParams.md create mode 100644 docs/api/forward/type-aliases/EnvironmentVariablesUnionParam.md create mode 100644 docs/api/forward/type-aliases/EventContentUnionParam.md create mode 100644 docs/api/forward/type-aliases/ForwardClientOptions.md create mode 100644 docs/api/forward/type-aliases/IdentityCreateParams.md create mode 100644 docs/api/forward/type-aliases/MemoryStoreCreateParams.md create mode 100644 docs/api/forward/type-aliases/MemoryStoreMemoryCreateParams.md create mode 100644 docs/api/forward/type-aliases/ModelConfig.md create mode 100644 docs/api/forward/type-aliases/ModelConfigUnionParam.md create mode 100644 docs/api/forward/type-aliases/ScheduleCreateParams.md create mode 100644 docs/api/forward/type-aliases/ScheduleRunRetrieveParams.md create mode 100644 docs/api/forward/type-aliases/SessionCreateParams.md create mode 100644 docs/api/forward/type-aliases/SkillCreateParams.md create mode 100644 docs/api/forward/type-aliases/SkillRetrieveParams.md create mode 100644 docs/api/forward/type-aliases/SkillVersionCreateParams.md create mode 100644 docs/api/forward/type-aliases/TemplateCreateParams.md create mode 100644 docs/api/forward/type-aliases/VaultCreateParams.md create mode 100644 docs/api/forward/type-aliases/VaultCredentialCreateParams.md create mode 100644 docs/api/index/README.md create mode 100644 docs/api/index/classes/APIClient.md create mode 100644 docs/api/index/classes/APIConnectionError.md create mode 100644 docs/api/index/classes/APIConnectionTimeoutError.md create mode 100644 docs/api/index/classes/APIError.md create mode 100644 docs/api/index/classes/APIPromise.md create mode 100644 docs/api/index/classes/APIUserAbortError.md create mode 100644 docs/api/index/classes/AuthenticationError.md create mode 100644 docs/api/index/classes/BadRequestError.md create mode 100644 docs/api/index/classes/ConflictError.md create mode 100644 docs/api/index/classes/ForwardClient.md create mode 100644 docs/api/index/classes/InternalServerError.md create mode 100644 docs/api/index/classes/ManagedClient.md create mode 100644 docs/api/index/classes/NotFoundError.md create mode 100644 docs/api/index/classes/PATCredential.md create mode 100644 docs/api/index/classes/Page.md create mode 100644 docs/api/index/classes/PagePromise.md create mode 100644 docs/api/index/classes/PermissionDeniedError.md create mode 100644 docs/api/index/classes/QoderError.md create mode 100644 docs/api/index/classes/RateLimitError.md create mode 100644 docs/api/index/classes/ResumableSessionEventStream.md create mode 100644 docs/api/index/classes/Stream.md create mode 100644 docs/api/index/classes/UnprocessableEntityError.md create mode 100644 docs/api/index/functions/decodeSSE.md create mode 100644 docs/api/index/functions/mergeHeaders.md create mode 100644 docs/api/index/functions/readEnv.md create mode 100644 docs/api/index/functions/stringifyQuery.md create mode 100644 docs/api/index/functions/toFile.md create mode 100644 docs/api/index/functions/toMultipartForm.md create mode 100644 docs/api/index/interfaces/APIRequestOptions.md create mode 100644 docs/api/index/interfaces/ClientOptions.md create mode 100644 docs/api/index/interfaces/Credential.md create mode 100644 docs/api/index/interfaces/PageResponse.md create mode 100644 docs/api/index/interfaces/RequestOptions.md create mode 100644 docs/api/index/interfaces/ServerSentEvent.md create mode 100644 docs/api/index/type-aliases/HeadersLike.md create mode 100644 docs/api/index/type-aliases/Middleware.md create mode 100644 docs/api/index/type-aliases/PaginationMode.md create mode 100644 docs/api/index/type-aliases/Uploadable.md create mode 100644 docs/api/index/variables/VERSION.md create mode 100644 docs/api/managed/README.md create mode 100644 docs/api/managed/classes/Agents.md create mode 100644 docs/api/managed/classes/AgentsVersions.md create mode 100644 docs/api/managed/classes/DeploymentRuns.md create mode 100644 docs/api/managed/classes/Deployments.md create mode 100644 docs/api/managed/classes/Dreams.md create mode 100644 docs/api/managed/classes/Environments.md create mode 100644 docs/api/managed/classes/EnvironmentsWork.md create mode 100644 docs/api/managed/classes/Files.md create mode 100644 docs/api/managed/classes/MemoryStores.md create mode 100644 docs/api/managed/classes/MemoryStoresMemories.md create mode 100644 docs/api/managed/classes/MemoryStoresMemoryVersions.md create mode 100644 docs/api/managed/classes/Models.md create mode 100644 docs/api/managed/classes/Sessions.md create mode 100644 docs/api/managed/classes/SessionsEvents.md create mode 100644 docs/api/managed/classes/SessionsResources.md create mode 100644 docs/api/managed/classes/SessionsThreads.md create mode 100644 docs/api/managed/classes/SessionsThreadsEvents.md create mode 100644 docs/api/managed/classes/Skills.md create mode 100644 docs/api/managed/classes/SkillsVersions.md create mode 100644 docs/api/managed/classes/Vaults.md create mode 100644 docs/api/managed/classes/VaultsCredentials.md create mode 100644 docs/api/managed/interfaces/AdvisorRedactedResultBlockParam.md create mode 100644 docs/api/managed/interfaces/AdvisorResultBlockParam.md create mode 100644 docs/api/managed/interfaces/AdvisorToolResultBlockParam.md create mode 100644 docs/api/managed/interfaces/AdvisorToolResultErrorParam.md create mode 100644 docs/api/managed/interfaces/AgentArchiveParams.md create mode 100644 docs/api/managed/interfaces/AgentGetParams.md create mode 100644 docs/api/managed/interfaces/AgentListParams.md create mode 100644 docs/api/managed/interfaces/AgentNewParams.md create mode 100644 docs/api/managed/interfaces/AgentUpdateParams.md create mode 100644 docs/api/managed/interfaces/AgentVersionListParams.md create mode 100644 docs/api/managed/interfaces/Base64ImageSourceParam.md create mode 100644 docs/api/managed/interfaces/Base64PDFSourceParam.md create mode 100644 docs/api/managed/interfaces/BashCodeExecutionOutputBlockParam.md create mode 100644 docs/api/managed/interfaces/BashCodeExecutionResultBlockParam.md create mode 100644 docs/api/managed/interfaces/BashCodeExecutionToolResultBlockParam.md create mode 100644 docs/api/managed/interfaces/BashCodeExecutionToolResultErrorParam.md create mode 100644 docs/api/managed/interfaces/BrowserStateBlockParam.md create mode 100644 docs/api/managed/interfaces/BrowserStateChangeDownloadCompletedParam.md create mode 100644 docs/api/managed/interfaces/BrowserStateChangeDownloadFailedParam.md create mode 100644 docs/api/managed/interfaces/BrowserStateChangeDownloadStartedParam.md create mode 100644 docs/api/managed/interfaces/BrowserStateChangeTabOpenedParam.md create mode 100644 docs/api/managed/interfaces/BrowserStateTabEntryParam.md create mode 100644 docs/api/managed/interfaces/CacheControlEphemeralParam.md create mode 100644 docs/api/managed/interfaces/CapabilitySupport.md create mode 100644 docs/api/managed/interfaces/CitationCharLocationParam.md create mode 100644 docs/api/managed/interfaces/CitationContentBlockLocationParam.md create mode 100644 docs/api/managed/interfaces/CitationPageLocationParam.md create mode 100644 docs/api/managed/interfaces/CitationSearchResultLocationParam.md create mode 100644 docs/api/managed/interfaces/CitationWebSearchResultLocationParam.md create mode 100644 docs/api/managed/interfaces/CitationsConfigParam.md create mode 100644 docs/api/managed/interfaces/CloudConfig.md create mode 100644 docs/api/managed/interfaces/CloudConfigParams.md create mode 100644 docs/api/managed/interfaces/CodeExecutionOutputBlockParam.md create mode 100644 docs/api/managed/interfaces/CodeExecutionResultBlockParam.md create mode 100644 docs/api/managed/interfaces/CodeExecutionToolResultBlockParam.md create mode 100644 docs/api/managed/interfaces/CodeExecutionToolResultErrorParam.md create mode 100644 docs/api/managed/interfaces/CompactionBlockParam.md create mode 100644 docs/api/managed/interfaces/ContainerUploadBlockParam.md create mode 100644 docs/api/managed/interfaces/ContentBlockSourceParam.md create mode 100644 docs/api/managed/interfaces/ContextManagementCapability.md create mode 100644 docs/api/managed/interfaces/DeletedFile.md create mode 100644 docs/api/managed/interfaces/DeletedSkill.md create mode 100644 docs/api/managed/interfaces/DeletedSkillVersion.md create mode 100644 docs/api/managed/interfaces/DeploymentArchiveParams.md create mode 100644 docs/api/managed/interfaces/DeploymentGetParams.md create mode 100644 docs/api/managed/interfaces/DeploymentListParams.md create mode 100644 docs/api/managed/interfaces/DeploymentNewParams.md create mode 100644 docs/api/managed/interfaces/DeploymentPauseParams.md create mode 100644 docs/api/managed/interfaces/DeploymentRunGetParams.md create mode 100644 docs/api/managed/interfaces/DeploymentRunListParams.md create mode 100644 docs/api/managed/interfaces/DeploymentRunParams.md create mode 100644 docs/api/managed/interfaces/DeploymentUnpauseParams.md create mode 100644 docs/api/managed/interfaces/DeploymentUpdateParams.md create mode 100644 docs/api/managed/interfaces/DirectCallerParam.md create mode 100644 docs/api/managed/interfaces/Dream.md create mode 100644 docs/api/managed/interfaces/DreamArchiveParams.md create mode 100644 docs/api/managed/interfaces/DreamCancelParams.md create mode 100644 docs/api/managed/interfaces/DreamError.md create mode 100644 docs/api/managed/interfaces/DreamGetParams.md create mode 100644 docs/api/managed/interfaces/DreamListParams.md create mode 100644 docs/api/managed/interfaces/DreamMemoryStoreInput.md create mode 100644 docs/api/managed/interfaces/DreamMemoryStoreInputParam.md create mode 100644 docs/api/managed/interfaces/DreamModelConfig.md create mode 100644 docs/api/managed/interfaces/DreamModelConfigParam.md create mode 100644 docs/api/managed/interfaces/DreamNewParams.md create mode 100644 docs/api/managed/interfaces/DreamOutput.md create mode 100644 docs/api/managed/interfaces/DreamSessionsInput.md create mode 100644 docs/api/managed/interfaces/DreamSessionsInputParam.md create mode 100644 docs/api/managed/interfaces/DreamUsage.md create mode 100644 docs/api/managed/interfaces/EffortCapability.md create mode 100644 docs/api/managed/interfaces/EncryptedCodeExecutionResultBlockParam.md create mode 100644 docs/api/managed/interfaces/Environment.md create mode 100644 docs/api/managed/interfaces/EnvironmentArchiveParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentDeleteParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentDeleteResponse.md create mode 100644 docs/api/managed/interfaces/EnvironmentGetParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentListParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentNewParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentUpdateParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentWorkAckParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentWorkGetParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentWorkHeartbeatParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentWorkListParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentWorkPollParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentWorkStatsParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentWorkStopParams.md create mode 100644 docs/api/managed/interfaces/EnvironmentWorkUpdateParams.md create mode 100644 docs/api/managed/interfaces/FallbackBlockParam.md create mode 100644 docs/api/managed/interfaces/FallbackInfoParam.md create mode 100644 docs/api/managed/interfaces/FileDeleteParams.md create mode 100644 docs/api/managed/interfaces/FileDocumentSourceParam.md create mode 100644 docs/api/managed/interfaces/FileDownloadParams.md create mode 100644 docs/api/managed/interfaces/FileGetMetadataParams.md create mode 100644 docs/api/managed/interfaces/FileImageSourceParam.md create mode 100644 docs/api/managed/interfaces/FileListParams.md create mode 100644 docs/api/managed/interfaces/FileMetadata.md create mode 100644 docs/api/managed/interfaces/FileScope.md create mode 100644 docs/api/managed/interfaces/FileUploadParams.md create mode 100644 docs/api/managed/interfaces/HealthCheckWorkData.md create mode 100644 docs/api/managed/interfaces/ImageBlockParam.md create mode 100644 docs/api/managed/interfaces/ImageTransformationsParam.md create mode 100644 docs/api/managed/interfaces/LimitedNetwork.md create mode 100644 docs/api/managed/interfaces/LimitedNetworkParams.md create mode 100644 docs/api/managed/interfaces/MCPToolUseBlockParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAPIActor.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAdvisor.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAdvisorParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentArchivedDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentArchivedRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentCustomToolUseEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentMCPToolResultEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentMCPToolUseEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentMessageEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentMessagePreview.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentReference.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentThinkingEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentThinkingPreview.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentThreadContextCompactedEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageReceivedEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageReceivedEventContentUnionSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageSentEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageSentEventContentUnionSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolConfigUnionPermissionPolicy.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolResultEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolUnionDefaultConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolUseEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401BashInput.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401EditInput.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401GlobInput.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401GrepInput.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401Params.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401ReadInput.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401WriteInput.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolsetDefaultConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentToolsetDefaultConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAgentWithOverridesParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAlwaysAllowPolicy.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAlwaysAllowPolicyParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAlwaysAskPolicy.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsAlwaysAskPolicyParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBase64DocumentSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBase64DocumentSourceParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBase64ImageSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBase64ImageSourceParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBashToolConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBashToolConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBillingError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBranchCheckout.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBranchCheckoutParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBudgetLimit.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsBudgetLimitParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCacheCreationUsage.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCommitCheckout.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCommitCheckoutParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCredential.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCredentialHostUnreachableError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCredentialValidation.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCustomSkill.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCustomSkillParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCustomTool.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCustomToolInputSchema.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCustomToolInputSchemaParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsCustomToolParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeleteSessionResource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeletedCredential.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeletedMemory.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeletedMemoryStore.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeletedSession.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeletedVault.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeltaContent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeltaEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeployment.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeploymentRun.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeploymentSystemMessageEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeploymentUserDefineOutcomeEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeploymentUserMessageEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDeploymentUserMessageEventContentUnionSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDocumentBlock.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsDocumentBlockParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEditToolConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEditToolConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortHigh.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortHighParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortLow.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortLowParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortMax.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortMaxParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortMedium.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortMediumParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortXhigh.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEffortXhighParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEnvironmentArchivedRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEnvironmentNotFoundRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableAuthResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableCreateParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableUpdateParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsErrorDeploymentPausedReason.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileDocumentSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileDocumentSourceParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileImageSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileImageSourceParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileNotFoundDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileNotFoundRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileResource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileResourceConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileResourceParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileRubric.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsFileRubricParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResourceConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResourceParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsGlobToolConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsGlobToolConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsGrepToolConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsGrepToolConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsImageBlock.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsImageBlockParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsInjectionLocationParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsInjectionLocationResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsInjectionLocationUpdateParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsLimitedCredentialNetworkingParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsLimitedCredentialNetworkingResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPAuthenticationFailedError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPConnectionFailedError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPEgressBlockedRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPOAuthAuthResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPOAuthCreateParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshUpdateParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPOAuthUpdateParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPProbe.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPServerURLDefinition.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPToolConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPToolConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPToolset.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPToolsetDefaultConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPToolsetDefaultConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMCPToolsetParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsManualDeploymentPausedReason.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsManualTriggerContext.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMemory.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMemoryPrefix.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMemoryStore.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMemoryStoreArchivedRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMemoryStoreResource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMemoryStoreResourceConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMemoryStoreResourceParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMemoryVersion.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsModelOverloadedError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsModelRateLimitedError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsModelRequestFailedError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMultiagent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMultiagentParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsMultiagentSelfParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsOrganizationDisabledDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsOrganizationDisabledRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsOutcomeEvaluationResource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsPlainTextDocumentSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsPlainTextDocumentSourceParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsPreconditionParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsQoderSkill.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsQoderSkillParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsReadToolConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsReadToolConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsRedactedBlock.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsRedactedBlockParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsRefreshHTTPResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsRefreshObject.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsRetryStatusExhausted.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsRetryStatusRetrying.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsRetryStatusTerminal.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSchedule.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsScheduleParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsScheduleTriggerContext.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSearchResultBlock.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSearchResultBlockParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSearchResultCitations.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSearchResultCitationsParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSearchResultContent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSearchResultContentParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSelfHostedResourcesUnsupportedRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSendSessionEvents.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsServerToolUsage.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsServiceAccountActor.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSession.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionActor.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionAgent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionAgentUpdateParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionBudgetReached.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionCreationRejectedRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionDeletedEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionEndTurn.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionErrorEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionErrorEventErrorUnionRetryStatus.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionEventUnionStopReason.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionEventUnionUsage.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionMultiagentCoordinator.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionRateLimitedRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionRequiresAction.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionResourceNotFoundRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionRetriesExhausted.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionStats.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionStatusIdleEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionStatusRescheduledEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionStatusRunningEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionStatusTerminatedEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThread.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadAgent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadCreatedEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadStats.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusIdleEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusRescheduledEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusRunningEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusTerminatedEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionThreadUsage.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionUpdatedEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionUsage.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionUsageEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSessionUsageSnapshot.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSkillNotFoundDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSkillNotFoundRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSpanModelRequestEndEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSpanModelRequestStartEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSpanModelUsage.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationEndEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationOngoingEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationStartEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsStartEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsStaticBearerAuthResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsStaticBearerCreateParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsStaticBearerUpdateParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsStreamSessionEventsUnionStopReason.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsStreamSessionEventsUnionUsage.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsStreamSessionThreadEventsUnionStopReason.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsStreamSessionThreadEventsUnionUsage.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSystemContentBlock.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSystemContentBlockParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSystemMessageEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsSystemMessageEventParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTextBlock.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTextBlockParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTextRubric.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTextRubricParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicUpdateParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthNoneParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthNoneResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostUpdateParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsURLDocumentSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsURLDocumentSourceParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsURLImageSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsURLImageSourceParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsURLMCPServerParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUnknownDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUnknownError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUnknownRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUnrestrictedCredentialNetworkingParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUnrestrictedCredentialNetworkingResponse.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserActor.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserCustomToolResultEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserCustomToolResultEventParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserDefineOutcomeEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserDefineOutcomeEventParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserInterruptEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserInterruptEventParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserLocation.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserLocationParam.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserMessageEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserMessageEventContentUnionSource.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserMessageEventParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserToolConfirmationEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserToolConfirmationEventParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserToolResultEvent.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsUserToolResultEventParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsVault.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsVaultArchivedDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsVaultArchivedRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsVaultNotFoundDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsVaultNotFoundRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsWebFetchToolConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsWebFetchToolConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsWebSearchToolConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsWebSearchToolConfigParams.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsWorkspaceArchivedRunError.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsWriteToolConfig.md create mode 100644 docs/api/managed/interfaces/ManagedAgentsWriteToolConfigParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreArchiveParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreDeleteParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreGetParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreListParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreMemoryDeleteParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreMemoryGetParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreMemoryListParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreMemoryNewParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreMemoryUpdateParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreMemoryVersionGetParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreMemoryVersionListParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreMemoryVersionRedactParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreNewParams.md create mode 100644 docs/api/managed/interfaces/MemoryStoreUpdateParams.md create mode 100644 docs/api/managed/interfaces/ModelCapabilities.md create mode 100644 docs/api/managed/interfaces/ModelInfo.md create mode 100644 docs/api/managed/interfaces/ModelListParams.md create mode 100644 docs/api/managed/interfaces/MonetaryAmount.md create mode 100644 docs/api/managed/interfaces/MonetaryAmountParam.md create mode 100644 docs/api/managed/interfaces/OutputBehaviorCreateNew.md create mode 100644 docs/api/managed/interfaces/OutputBehaviorCreateNewParam.md create mode 100644 docs/api/managed/interfaces/OutputBehaviorUpdateExisting.md create mode 100644 docs/api/managed/interfaces/OutputBehaviorUpdateExistingParam.md create mode 100644 docs/api/managed/interfaces/Packages.md create mode 100644 docs/api/managed/interfaces/PackagesParams.md create mode 100644 docs/api/managed/interfaces/PlainTextSourceParam.md create mode 100644 docs/api/managed/interfaces/RedactedThinkingBlockParam.md create mode 100644 docs/api/managed/interfaces/RequestDocumentBlockParam.md create mode 100644 docs/api/managed/interfaces/RequestMCPToolResultBlockParam.md create mode 100644 docs/api/managed/interfaces/RequestToolAdditionBlockParam.md create mode 100644 docs/api/managed/interfaces/RequestToolRemovalBlockParam.md create mode 100644 docs/api/managed/interfaces/SearchResultBlockParam.md create mode 100644 docs/api/managed/interfaces/SelfHostedConfig.md create mode 100644 docs/api/managed/interfaces/SelfHostedConfigParams.md create mode 100644 docs/api/managed/interfaces/SelfHostedWork.md create mode 100644 docs/api/managed/interfaces/SelfHostedWorkHeartbeatResponse.md create mode 100644 docs/api/managed/interfaces/SelfHostedWorkListResponse.md create mode 100644 docs/api/managed/interfaces/SelfHostedWorkQueueStats.md create mode 100644 docs/api/managed/interfaces/SelfHostedWorkStopRequestParam.md create mode 100644 docs/api/managed/interfaces/SelfHostedWorkUpdateRequestParam.md create mode 100644 docs/api/managed/interfaces/ServerToolCaller20260120Param.md create mode 100644 docs/api/managed/interfaces/ServerToolCallerParam.md create mode 100644 docs/api/managed/interfaces/ServerToolUseBlockParam.md create mode 100644 docs/api/managed/interfaces/SessionArchiveParams.md create mode 100644 docs/api/managed/interfaces/SessionDeleteParams.md create mode 100644 docs/api/managed/interfaces/SessionEventListParams.md create mode 100644 docs/api/managed/interfaces/SessionEventSendParams.md create mode 100644 docs/api/managed/interfaces/SessionEventStreamParams.md create mode 100644 docs/api/managed/interfaces/SessionGetParams.md create mode 100644 docs/api/managed/interfaces/SessionListParams.md create mode 100644 docs/api/managed/interfaces/SessionNewParams.md create mode 100644 docs/api/managed/interfaces/SessionResourceAddParams.md create mode 100644 docs/api/managed/interfaces/SessionResourceDeleteParams.md create mode 100644 docs/api/managed/interfaces/SessionResourceGetParams.md create mode 100644 docs/api/managed/interfaces/SessionResourceListParams.md create mode 100644 docs/api/managed/interfaces/SessionResourceUpdateParams.md create mode 100644 docs/api/managed/interfaces/SessionThreadArchiveParams.md create mode 100644 docs/api/managed/interfaces/SessionThreadEventListParams.md create mode 100644 docs/api/managed/interfaces/SessionThreadEventStreamParams.md create mode 100644 docs/api/managed/interfaces/SessionThreadGetParams.md create mode 100644 docs/api/managed/interfaces/SessionThreadListParams.md create mode 100644 docs/api/managed/interfaces/SessionUpdateParams.md create mode 100644 docs/api/managed/interfaces/SessionWorkData.md create mode 100644 docs/api/managed/interfaces/Skill.md create mode 100644 docs/api/managed/interfaces/SkillDeleteParams.md create mode 100644 docs/api/managed/interfaces/SkillGetParams.md create mode 100644 docs/api/managed/interfaces/SkillListParams.md create mode 100644 docs/api/managed/interfaces/SkillNewParams.md create mode 100644 docs/api/managed/interfaces/SkillVersion.md create mode 100644 docs/api/managed/interfaces/SkillVersionDeleteParams.md create mode 100644 docs/api/managed/interfaces/SkillVersionDownloadParams.md create mode 100644 docs/api/managed/interfaces/SkillVersionGetParams.md create mode 100644 docs/api/managed/interfaces/SkillVersionListParams.md create mode 100644 docs/api/managed/interfaces/SkillVersionNewParams.md create mode 100644 docs/api/managed/interfaces/TextBlockParam.md create mode 100644 docs/api/managed/interfaces/TextEditorCodeExecutionCreateResultBlockParam.md create mode 100644 docs/api/managed/interfaces/TextEditorCodeExecutionStrReplaceResultBlockParam.md create mode 100644 docs/api/managed/interfaces/TextEditorCodeExecutionToolResultBlockParam.md create mode 100644 docs/api/managed/interfaces/TextEditorCodeExecutionToolResultErrorParam.md create mode 100644 docs/api/managed/interfaces/TextEditorCodeExecutionViewResultBlockParam.md create mode 100644 docs/api/managed/interfaces/ThinkingBlockParam.md create mode 100644 docs/api/managed/interfaces/ThinkingCapability.md create mode 100644 docs/api/managed/interfaces/ThinkingTypes.md create mode 100644 docs/api/managed/interfaces/ToolChangeMCPToolReferenceParam.md create mode 100644 docs/api/managed/interfaces/ToolChangeMCPToolsetReferenceParam.md create mode 100644 docs/api/managed/interfaces/ToolChangeToolReferenceParam.md create mode 100644 docs/api/managed/interfaces/ToolReferenceBlockParam.md create mode 100644 docs/api/managed/interfaces/ToolResultBlockParam.md create mode 100644 docs/api/managed/interfaces/ToolSearchToolResultBlockParam.md create mode 100644 docs/api/managed/interfaces/ToolSearchToolResultErrorParam.md create mode 100644 docs/api/managed/interfaces/ToolSearchToolSearchResultBlockParam.md create mode 100644 docs/api/managed/interfaces/ToolUseBlockParam.md create mode 100644 docs/api/managed/interfaces/URLImageSourceParam.md create mode 100644 docs/api/managed/interfaces/URLPDFSourceParam.md create mode 100644 docs/api/managed/interfaces/UnrestrictedNetwork.md create mode 100644 docs/api/managed/interfaces/UnrestrictedNetworkParam.md create mode 100644 docs/api/managed/interfaces/VaultArchiveParams.md create mode 100644 docs/api/managed/interfaces/VaultCredentialArchiveParams.md create mode 100644 docs/api/managed/interfaces/VaultCredentialDeleteParams.md create mode 100644 docs/api/managed/interfaces/VaultCredentialGetParams.md create mode 100644 docs/api/managed/interfaces/VaultCredentialListParams.md create mode 100644 docs/api/managed/interfaces/VaultCredentialMCPOAuthValidateParams.md create mode 100644 docs/api/managed/interfaces/VaultCredentialNewParams.md create mode 100644 docs/api/managed/interfaces/VaultCredentialUpdateParams.md create mode 100644 docs/api/managed/interfaces/VaultDeleteParams.md create mode 100644 docs/api/managed/interfaces/VaultGetParams.md create mode 100644 docs/api/managed/interfaces/VaultListParams.md create mode 100644 docs/api/managed/interfaces/VaultNewParams.md create mode 100644 docs/api/managed/interfaces/WebFetchBlockParam.md create mode 100644 docs/api/managed/interfaces/WebFetchToolResultBlockParam.md create mode 100644 docs/api/managed/interfaces/WebFetchToolResultErrorBlockParam.md create mode 100644 docs/api/managed/interfaces/WebSearchResultBlockParam.md create mode 100644 docs/api/managed/interfaces/WebSearchToolRequestErrorParam.md create mode 100644 docs/api/managed/interfaces/WebSearchToolResultBlockParam.md create mode 100644 docs/api/managed/type-aliases/AdvisorToolResultBlockParamContentUnion.md create mode 100644 docs/api/managed/type-aliases/AdvisorToolResultErrorParamErrorCode.md create mode 100644 docs/api/managed/type-aliases/AgentCreateParams.md create mode 100644 docs/api/managed/type-aliases/AgentNewParamsToolUnion.md create mode 100644 docs/api/managed/type-aliases/AgentRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/AgentUpdateParamsToolUnion.md create mode 100644 docs/api/managed/type-aliases/Base64ImageSourceMediaType.md create mode 100644 docs/api/managed/type-aliases/BashCodeExecutionToolResultBlockParamContentUnion.md create mode 100644 docs/api/managed/type-aliases/BashCodeExecutionToolResultErrorParamErrorCode.md create mode 100644 docs/api/managed/type-aliases/BrowserStateChangeUnionParam.md create mode 100644 docs/api/managed/type-aliases/CacheControlEphemeralTTL.md create mode 100644 docs/api/managed/type-aliases/CloudConfigNetworkingUnion.md create mode 100644 docs/api/managed/type-aliases/CloudConfigParamsNetworkingUnion.md create mode 100644 docs/api/managed/type-aliases/CodeExecutionToolResultBlockParamContentUnion.md create mode 100644 docs/api/managed/type-aliases/CodeExecutionToolResultErrorCode.md create mode 100644 docs/api/managed/type-aliases/ContentBlockParamUnion.md create mode 100644 docs/api/managed/type-aliases/ContentBlockSourceContentUnionParam.md create mode 100644 docs/api/managed/type-aliases/Currency.md create mode 100644 docs/api/managed/type-aliases/DeletedFileType.md create mode 100644 docs/api/managed/type-aliases/DeploymentCreateParams.md create mode 100644 docs/api/managed/type-aliases/DeploymentNewParamsAgentUnion.md create mode 100644 docs/api/managed/type-aliases/DeploymentNewParamsResourceUnion.md create mode 100644 docs/api/managed/type-aliases/DeploymentRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/DeploymentRunRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/DeploymentUpdateParamsAgentUnion.md create mode 100644 docs/api/managed/type-aliases/DeploymentUpdateParamsResourceUnion.md create mode 100644 docs/api/managed/type-aliases/DreamCreateParams.md create mode 100644 docs/api/managed/type-aliases/DreamInputUnion.md create mode 100644 docs/api/managed/type-aliases/DreamInputUnionParam.md create mode 100644 docs/api/managed/type-aliases/DreamMemoryStoreInputType.md create mode 100644 docs/api/managed/type-aliases/DreamModelConfigParamSpeed.md create mode 100644 docs/api/managed/type-aliases/DreamModelConfigSpeed.md create mode 100644 docs/api/managed/type-aliases/DreamNewParamsModelUnion.md create mode 100644 docs/api/managed/type-aliases/DreamOutputType.md create mode 100644 docs/api/managed/type-aliases/DreamRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/DreamSessionsInputType.md create mode 100644 docs/api/managed/type-aliases/DreamStatus.md create mode 100644 docs/api/managed/type-aliases/DreamType.md create mode 100644 docs/api/managed/type-aliases/EnvironmentConfigUnion.md create mode 100644 docs/api/managed/type-aliases/EnvironmentCreateParams.md create mode 100644 docs/api/managed/type-aliases/EnvironmentDeleteResponseType.md create mode 100644 docs/api/managed/type-aliases/EnvironmentNewParamsConfigUnion.md create mode 100644 docs/api/managed/type-aliases/EnvironmentNewParamsScope.md create mode 100644 docs/api/managed/type-aliases/EnvironmentRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/EnvironmentScope.md create mode 100644 docs/api/managed/type-aliases/EnvironmentUpdateParamsConfigUnion.md create mode 100644 docs/api/managed/type-aliases/EnvironmentUpdateParamsScope.md create mode 100644 docs/api/managed/type-aliases/EnvironmentWorkRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/HealthCheckWorkDataType.md create mode 100644 docs/api/managed/type-aliases/ImageBlockParamSourceUnion.md create mode 100644 docs/api/managed/type-aliases/ImageTransformationsParamOversizedImage.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAPIActorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsActorUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAdvisorParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAdvisorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentArchivedDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentArchivedRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentCustomToolUseEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnionSource.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolUseEventEvaluatedPermission.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolUseEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentMessageEventContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentMessageEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentMessagePreviewType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentReferenceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentSkillUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentThinkingEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentThinkingPreviewType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentThreadContextCompactedEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageReceivedEventContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageReceivedEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageSentEventContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageSentEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolConfigParamsUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolConfigUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventContentUnionSource.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolUnionConfigs.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolUseEventEvaluatedPermission.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolUseEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolset20260401ParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolset20260401Type.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentWithOverridesParamsToolUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAgentWithOverridesParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAlwaysAllowPolicyType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsAlwaysAskPolicyType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsBase64DocumentSourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsBase64ImageSourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsBashToolConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsBashToolConfigParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsBashToolConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsBillingErrorRetryStatusUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsBillingErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsBranchCheckoutType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsBudgetLimitType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCommitCheckoutType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCredentialAuthUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCredentialHostUnreachableErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCredentialNetworkingParamsUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCredentialType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCredentialValidationStatus.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCredentialValidationType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCustomSkillParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCustomSkillType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCustomToolParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsCustomToolType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeleteSessionResourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeletedCredentialType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeletedMemoryStoreType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeletedMemoryType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeletedSessionType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeletedVaultType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeltaContentType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeltaEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeltaType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventParamsUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventUnionContent.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentPausedReasonErrorUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentPausedReasonUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentRunErrorUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentRunType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentStatus.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentSystemMessageEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentUserMessageEventContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDeploymentUserMessageEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDocumentBlockSourceUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDocumentBlockSourceUnionParam.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsDocumentBlockType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEditToolConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEditToolConfigParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEditToolConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEffortHighType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEffortLowType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEffortMaxType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEffortMediumType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEffortXhighType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEnvironmentArchivedRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEnvironmentNotFoundRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableAuthResponseType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableCreateParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableUpdateParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsErrorDeploymentPausedReasonType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsEventParamsUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsFileDocumentSourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsFileImageSourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsFileNotFoundDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsFileNotFoundRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsFileResourceConfigType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsFileResourceParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsFileResourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsFileRubricParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsFileRubricType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceCheckoutUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceConfigType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsImageBlockSourceUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsImageBlockSourceUnionParam.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsImageBlockType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsLimitedCredentialNetworkingParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsLimitedCredentialNetworkingResponseType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPAuthenticationFailedErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPConnectionFailedErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPEgressBlockedRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPOAuthAuthResponseType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPOAuthCreateParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPOAuthUpdateParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPServerURLDefinitionType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPToolConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPToolsetParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMCPToolsetType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsManualDeploymentPausedReasonType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsManualTriggerContextType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryListItemUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryPrefixType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryStoreArchivedRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceAccess.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceConfigAccess.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceConfigType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceParamAccess.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceParamType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryStoreType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryVersionOperation.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryVersionType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMemoryView.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModel.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelConfig.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelConfigEffortUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelConfigParams.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsEffortManagedAgentsEffortLevel.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsEffortUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsSpeed.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelConfigSpeed.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelOverloadedErrorRetryStatusUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelOverloadedErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelRateLimitedErrorRetryStatusUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelRateLimitedErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelRequestFailedErrorRetryStatusUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsModelRequestFailedErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMultiagentAgentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMultiagentParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMultiagentRosterEntryParamsUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMultiagentSelfParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsMultiagentType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsOrganizationDisabledRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsOutcomeEvaluationResourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsPlainTextDocumentSourceMediaType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsPlainTextDocumentSourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsPreconditionType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsQoderSkillParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsQoderSkillType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsReadToolConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsReadToolConfigParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsReadToolConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsRedactedBlockType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsRefreshObjectStatus.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsRetryStatusExhaustedType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsRetryStatusRetryingType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsRetryStatusTerminalType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsScheduleParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsScheduleTriggerContextType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsScheduleType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSearchResultBlockType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSearchResultContentType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSendSessionEventsDataUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSendSessionEventsDataUnionContent.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionActorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionAgentSkillUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionAgentToolUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionAgentToolUnionConfigs.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionAgentType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionAgentUpdateToolUnionParam.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionBudgetReachedType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionCreationRejectedRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionDeletedEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionEndTurnType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionErrorEventErrorUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionErrorEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionEventUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionEventUnionContent.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionRateLimitedRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionRequiresActionType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionResourceConfigUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionResourceNotFoundRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionResourceUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionRetriesExhaustedType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionStatus.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionStatusIdleEventStopReasonUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionStatusIdleEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionStatusRescheduledEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionStatusRunningEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionStatusTerminatedEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentSkillUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentToolUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentToolUnionConfigs.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentUnionModel.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadCreatedEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatus.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusIdleEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusRescheduledEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusRunningEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusTerminatedEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionThreadType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionUpdatedEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSessionUsageEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSkillNotFoundDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSkillNotFoundRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSkillParamsUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSpanModelRequestEndEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSpanModelRequestStartEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSpanModelUsageSpeed.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationEndEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationOngoingEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationStartEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsStartEventPreviewUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsStartEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsStaticBearerAuthResponseType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsStaticBearerCreateParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsStaticBearerUpdateParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsStreamSessionEventsUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsStreamSessionEventsUnionContent.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsStreamSessionThreadEventsUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsStreamSessionThreadEventsUnionContent.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSystemContentBlockType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSystemMessageEventParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsSystemMessageEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTextBlockType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTextRubricParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTextRubricType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicParamType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicResponseType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicUpdateParamType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthNoneParamType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthNoneResponseType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostParamType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostResponseType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostUpdateParamType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTriggerContextUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsTriggerType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsURLDocumentSourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsURLImageSourceType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsURLMCPServerParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUnknownDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUnknownErrorRetryStatusUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUnknownErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUnknownRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingResponseType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserActorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventContentUnionSource.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventParamsContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventParamsRubricUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventRubricUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserInterruptEventParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserInterruptEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserMessageEventContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserMessageEventParamsContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserMessageEventParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserMessageEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventParamsResult.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventResult.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventContentUnionSource.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventParamsContentUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsVaultArchivedDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsVaultArchivedRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsVaultNotFoundDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsVaultNotFoundRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsVaultType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWorkspaceArchivedRunErrorType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigParamsType.md create mode 100644 docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigPermissionPolicyUnion.md create mode 100644 docs/api/managed/type-aliases/MemoryStoreCreateParams.md create mode 100644 docs/api/managed/type-aliases/MemoryStoreMemoryCreateParams.md create mode 100644 docs/api/managed/type-aliases/MemoryStoreMemoryRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/MemoryStoreMemoryVersionRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/MemoryStoreRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/Model.md create mode 100644 docs/api/managed/type-aliases/OutputBehaviorCreateNewType.md create mode 100644 docs/api/managed/type-aliases/OutputBehaviorUnion.md create mode 100644 docs/api/managed/type-aliases/OutputBehaviorUnionParam.md create mode 100644 docs/api/managed/type-aliases/OutputBehaviorUpdateExistingType.md create mode 100644 docs/api/managed/type-aliases/PackagesParamsType.md create mode 100644 docs/api/managed/type-aliases/PackagesType.md create mode 100644 docs/api/managed/type-aliases/QoderBeta.md create mode 100644 docs/api/managed/type-aliases/RequestDocumentBlockSourceUnionParam.md create mode 100644 docs/api/managed/type-aliases/RequestMCPToolResultBlockParamContentUnion.md create mode 100644 docs/api/managed/type-aliases/RequestToolAdditionBlockToolUnionParam.md create mode 100644 docs/api/managed/type-aliases/RequestToolRemovalBlockToolUnionParam.md create mode 100644 docs/api/managed/type-aliases/SelfHostedWorkHeartbeatResponseState.md create mode 100644 docs/api/managed/type-aliases/SelfHostedWorkState.md create mode 100644 docs/api/managed/type-aliases/ServerToolUseBlockParamCallerUnion.md create mode 100644 docs/api/managed/type-aliases/ServerToolUseBlockParamName.md create mode 100644 docs/api/managed/type-aliases/SessionCreateParams.md create mode 100644 docs/api/managed/type-aliases/SessionEventListParamsOrder.md create mode 100644 docs/api/managed/type-aliases/SessionListParamsOrder.md create mode 100644 docs/api/managed/type-aliases/SessionNewParamsAgentUnion.md create mode 100644 docs/api/managed/type-aliases/SessionNewParamsInitialEventUnion.md create mode 100644 docs/api/managed/type-aliases/SessionNewParamsResourceUnion.md create mode 100644 docs/api/managed/type-aliases/SessionResourceGetResponseUnion.md create mode 100644 docs/api/managed/type-aliases/SessionResourceRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/SessionResourceUpdateResponseUnion.md create mode 100644 docs/api/managed/type-aliases/SessionRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/SessionThreadRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/SkillCreateParams.md create mode 100644 docs/api/managed/type-aliases/SkillRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/SkillSource.md create mode 100644 docs/api/managed/type-aliases/SkillSourceType.md create mode 100644 docs/api/managed/type-aliases/SkillVersionCreateParams.md create mode 100644 docs/api/managed/type-aliases/SkillVersionRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/TextCitationParamUnion.md create mode 100644 docs/api/managed/type-aliases/TextEditorCodeExecutionToolResultBlockParamContentUnion.md create mode 100644 docs/api/managed/type-aliases/TextEditorCodeExecutionToolResultErrorParamErrorCode.md create mode 100644 docs/api/managed/type-aliases/TextEditorCodeExecutionViewResultBlockParamFileType.md create mode 100644 docs/api/managed/type-aliases/ToolResultBlockParamContentUnion.md create mode 100644 docs/api/managed/type-aliases/ToolSearchToolResultBlockParamContentUnion.md create mode 100644 docs/api/managed/type-aliases/ToolSearchToolResultErrorParamErrorCode.md create mode 100644 docs/api/managed/type-aliases/ToolUseBlockParamCallerUnion.md create mode 100644 docs/api/managed/type-aliases/VaultCreateParams.md create mode 100644 docs/api/managed/type-aliases/VaultCredentialCreateParams.md create mode 100644 docs/api/managed/type-aliases/VaultCredentialNewParamsAuthUnion.md create mode 100644 docs/api/managed/type-aliases/VaultCredentialRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/VaultCredentialUpdateParamsAuthUnion.md create mode 100644 docs/api/managed/type-aliases/VaultRetrieveParams.md create mode 100644 docs/api/managed/type-aliases/WebFetchToolResultBlockParamCallerUnion.md create mode 100644 docs/api/managed/type-aliases/WebFetchToolResultBlockParamContentUnion.md create mode 100644 docs/api/managed/type-aliases/WebFetchToolResultErrorCode.md create mode 100644 docs/api/managed/type-aliases/WebSearchToolResultBlockParamCallerUnion.md create mode 100644 docs/api/managed/type-aliases/WebSearchToolResultBlockParamContentUnion.md create mode 100644 docs/api/managed/type-aliases/WebSearchToolResultErrorCode.md create mode 100644 docs/metadata.yaml create mode 100644 scripts/generate-docs.mjs diff --git a/Makefile b/Makefile index d298b12..37647fd 100644 --- a/Makefile +++ b/Makefile @@ -1,11 +1,14 @@ LIVE_ENV_FILE ?= .env.live .DEFAULT_GOAL := test -.PHONY: build test test-unit test-contract test-scenarios test-live test-live-managed test-live-all test-live-check test-e2e +.PHONY: build test test-unit test-contract test-scenarios test-live test-live-managed test-live-all test-live-check test-e2e docs build: npm run build +docs: + npm run docs + test: npm test diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 0000000..dfae781 --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,16 @@ +**qca-sdk** + +*** + +# qca-sdk + +## Modules + +- [index](index/README.md) +- [forward](forward/README.md) +- [managed](managed/README.md) + +## Related + +- [README](../../README.md) +- [Examples](../../examples) diff --git a/docs/api/forward/README.md b/docs/api/forward/README.md new file mode 100644 index 0000000..69d0d86 --- /dev/null +++ b/docs/api/forward/README.md @@ -0,0 +1,398 @@ +[**qca-sdk**](../README.md) + +*** + +[qca-sdk](../README.md) / forward + +# forward + +## Classes + +- [Batches](classes/Batches.md) +- [BatchTasks](classes/BatchTasks.md) +- [ChannelPairings](classes/ChannelPairings.md) +- [ChannelQRSessions](classes/ChannelQRSessions.md) +- [Channels](classes/Channels.md) +- [Environments](classes/Environments.md) +- [Files](classes/Files.md) +- [Identities](classes/Identities.md) +- [IdentityConfigs](classes/IdentityConfigs.md) +- [IdentityMemoryStores](classes/IdentityMemoryStores.md) +- [MemoryStoreMemories](classes/MemoryStoreMemories.md) +- [MemoryStoreMemoryVersions](classes/MemoryStoreMemoryVersions.md) +- [MemoryStores](classes/MemoryStores.md) +- [Models](classes/Models.md) +- [ScheduleRuns](classes/ScheduleRuns.md) +- [Schedules](classes/Schedules.md) +- [SessionEvents](classes/SessionEvents.md) +- [SessionResources](classes/SessionResources.md) +- [Sessions](classes/Sessions.md) +- [SessionThreadEvents](classes/SessionThreadEvents.md) +- [SessionThreads](classes/SessionThreads.md) +- [Skills](classes/Skills.md) +- [SkillVersions](classes/SkillVersions.md) +- [Templates](classes/Templates.md) +- [VaultCredentials](classes/VaultCredentials.md) +- [Vaults](classes/Vaults.md) + +## Interfaces + +- [Batch](interfaces/Batch.md) +- [BatchCancelParams](interfaces/BatchCancelParams.md) +- [BatchFile](interfaces/BatchFile.md) +- [BatchListParams](interfaces/BatchListParams.md) +- [BatchNewParams](interfaces/BatchNewParams.md) +- [BatchRequestCounts](interfaces/BatchRequestCounts.md) +- [BatchTask](interfaces/BatchTask.md) +- [BatchTaskArtifactsItem](interfaces/BatchTaskArtifactsItem.md) +- [BatchTaskError](interfaces/BatchTaskError.md) +- [BatchTaskListParams](interfaces/BatchTaskListParams.md) +- [BatchTaskUsage](interfaces/BatchTaskUsage.md) +- [BatchUsage](interfaces/BatchUsage.md) +- [Channel](interfaces/Channel.md) +- [ChannelChannelConfig](interfaces/ChannelChannelConfig.md) +- [ChannelChannelConfigResponseOptions](interfaces/ChannelChannelConfigResponseOptions.md) +- [ChannelIdentityResolution](interfaces/ChannelIdentityResolution.md) +- [ChannelListParams](interfaces/ChannelListParams.md) +- [ChannelNewParams](interfaces/ChannelNewParams.md) +- [ChannelPairing](interfaces/ChannelPairing.md) +- [ChannelPairingNewParams](interfaces/ChannelPairingNewParams.md) +- [ChannelQRSession](interfaces/ChannelQRSession.md) +- [ChannelQRSessionNewParams](interfaces/ChannelQRSessionNewParams.md) +- [ChannelUpdateParams](interfaces/ChannelUpdateParams.md) +- [ContentBlock](interfaces/ContentBlock.md) +- [ContentBlockParam](interfaces/ContentBlockParam.md) +- [DeletedChannel](interfaces/DeletedChannel.md) +- [DeletedChannelPairing](interfaces/DeletedChannelPairing.md) +- [DeletedIdentity](interfaces/DeletedIdentity.md) +- [DeletedMemory](interfaces/DeletedMemory.md) +- [DeletedMemoryStore](interfaces/DeletedMemoryStore.md) +- [DeletedMemoryStoreMount](interfaces/DeletedMemoryStoreMount.md) +- [DeletedSkillVersion](interfaces/DeletedSkillVersion.md) +- [EffectiveConfig](interfaces/EffectiveConfig.md) +- [EffectiveConfigAgent](interfaces/EffectiveConfigAgent.md) +- [EffectiveConfigAgentToolsItem](interfaces/EffectiveConfigAgentToolsItem.md) +- [EffectiveConfigAgentToolsItemConfigsItem](interfaces/EffectiveConfigAgentToolsItemConfigsItem.md) +- [EffectiveConfigSession](interfaces/EffectiveConfigSession.md) +- [EffectiveConfigSessionResourcesItem](interfaces/EffectiveConfigSessionResourcesItem.md) +- [Environment](interfaces/Environment.md) +- [EnvironmentConfig](interfaces/EnvironmentConfig.md) +- [EnvironmentConfigPackages](interfaces/EnvironmentConfigPackages.md) +- [EnvironmentListParams](interfaces/EnvironmentListParams.md) +- [EnvironmentNewParams](interfaces/EnvironmentNewParams.md) +- [EnvironmentUpdateParams](interfaces/EnvironmentUpdateParams.md) +- [EnvironmentVariableOverride](interfaces/EnvironmentVariableOverride.md) +- [EnvironmentVariableOverrideParam](interfaces/EnvironmentVariableOverrideParam.md) +- [FileListParams](interfaces/FileListParams.md) +- [FileMetadata](interfaces/FileMetadata.md) +- [FileUploadParams](interfaces/FileUploadParams.md) +- [GitHubRepository](interfaces/GitHubRepository.md) +- [GitHubRepositoryParam](interfaces/GitHubRepositoryParam.md) +- [Identity](interfaces/Identity.md) +- [IdentityClearParams](interfaces/IdentityClearParams.md) +- [IdentityClearResponse](interfaces/IdentityClearResponse.md) +- [IdentityClearResponseSummary](interfaces/IdentityClearResponseSummary.md) +- [IdentityConfig](interfaces/IdentityConfig.md) +- [IdentityConfigListParams](interfaces/IdentityConfigListParams.md) +- [IdentityConfigSpec](interfaces/IdentityConfigSpec.md) +- [IdentityConfigSpecParam](interfaces/IdentityConfigSpecParam.md) +- [IdentityConfigUpsertParams](interfaces/IdentityConfigUpsertParams.md) +- [IdentityListParams](interfaces/IdentityListParams.md) +- [IdentityListTemplatesResponse](interfaces/IdentityListTemplatesResponse.md) +- [IdentityMemoryStoreListResponse](interfaces/IdentityMemoryStoreListResponse.md) +- [IdentityMemoryStoreMountParams](interfaces/IdentityMemoryStoreMountParams.md) +- [IdentityNewParams](interfaces/IdentityNewParams.md) +- [IdentityStats](interfaces/IdentityStats.md) +- [IdentityTemplate](interfaces/IdentityTemplate.md) +- [IdentityUpdateParams](interfaces/IdentityUpdateParams.md) +- [ImageSource](interfaces/ImageSource.md) +- [ImageSourceParam](interfaces/ImageSourceParam.md) +- [MCPServer](interfaces/MCPServer.md) +- [MCPServerOverride](interfaces/MCPServerOverride.md) +- [MCPServerOverrideParam](interfaces/MCPServerOverrideParam.md) +- [MCPServerParam](interfaces/MCPServerParam.md) +- [Memory](interfaces/Memory.md) +- [MemoryStore](interfaces/MemoryStore.md) +- [MemoryStoreListParams](interfaces/MemoryStoreListParams.md) +- [MemoryStoreMemoryListParams](interfaces/MemoryStoreMemoryListParams.md) +- [MemoryStoreMemoryNewParams](interfaces/MemoryStoreMemoryNewParams.md) +- [MemoryStoreMemoryUpdateParams](interfaces/MemoryStoreMemoryUpdateParams.md) +- [MemoryStoreMemoryVersionListParams](interfaces/MemoryStoreMemoryVersionListParams.md) +- [MemoryStoreMount](interfaces/MemoryStoreMount.md) +- [MemoryStoreNewParams](interfaces/MemoryStoreNewParams.md) +- [MemoryStoreUpdateParams](interfaces/MemoryStoreUpdateParams.md) +- [MemoryVersion](interfaces/MemoryVersion.md) +- [Model](interfaces/Model.md) +- [ModelConfigObject](interfaces/ModelConfigObject.md) +- [ModelConfigParam](interfaces/ModelConfigParam.md) +- [ModelListResponse](interfaces/ModelListResponse.md) +- [MultiagentConfig](interfaces/MultiagentConfig.md) +- [MultiagentConfigParam](interfaces/MultiagentConfigParam.md) +- [MultiagentEntry](interfaces/MultiagentEntry.md) +- [MultiagentEntryParam](interfaces/MultiagentEntryParam.md) +- [PermissionPolicy](interfaces/PermissionPolicy.md) +- [PermissionPolicyParam](interfaces/PermissionPolicyParam.md) +- [ResourceBinding](interfaces/ResourceBinding.md) +- [ResourceBindingParam](interfaces/ResourceBindingParam.md) +- [Schedule](interfaces/Schedule.md) +- [ScheduleArchiveManyParams](interfaces/ScheduleArchiveManyParams.md) +- [ScheduleArchiveManyResponse](interfaces/ScheduleArchiveManyResponse.md) +- [ScheduleArchiveParams](interfaces/ScheduleArchiveParams.md) +- [ScheduleExecution](interfaces/ScheduleExecution.md) +- [ScheduleInitialEventsItem](interfaces/ScheduleInitialEventsItem.md) +- [ScheduleListParams](interfaces/ScheduleListParams.md) +- [ScheduleNewParams](interfaces/ScheduleNewParams.md) +- [SchedulePausedReason](interfaces/SchedulePausedReason.md) +- [SchedulePauseParams](interfaces/SchedulePauseParams.md) +- [ScheduleRun](interfaces/ScheduleRun.md) +- [ScheduleRunGetParams](interfaces/ScheduleRunGetParams.md) +- [ScheduleRunListParams](interfaces/ScheduleRunListParams.md) +- [ScheduleRunParams](interfaces/ScheduleRunParams.md) +- [ScheduleRunTriggerContext](interfaces/ScheduleRunTriggerContext.md) +- [ScheduleSinksItem](interfaces/ScheduleSinksItem.md) +- [ScheduleSinksItemTarget](interfaces/ScheduleSinksItemTarget.md) +- [ScheduleTriggerPolicy](interfaces/ScheduleTriggerPolicy.md) +- [ScheduleUnpauseParams](interfaces/ScheduleUnpauseParams.md) +- [ScheduleUpdateParams](interfaces/ScheduleUpdateParams.md) +- [Session](interfaces/Session.md) +- [SessionArchiveParams](interfaces/SessionArchiveParams.md) +- [SessionCancelParams](interfaces/SessionCancelParams.md) +- [SessionConfig](interfaces/SessionConfig.md) +- [SessionEvent](interfaces/SessionEvent.md) +- [SessionEventListParams](interfaces/SessionEventListParams.md) +- [SessionEventParam](interfaces/SessionEventParam.md) +- [SessionEventSendParams](interfaces/SessionEventSendParams.md) +- [SessionEventSendResponse](interfaces/SessionEventSendResponse.md) +- [SessionEventStreamParams](interfaces/SessionEventStreamParams.md) +- [SessionListParams](interfaces/SessionListParams.md) +- [SessionNewParams](interfaces/SessionNewParams.md) +- [SessionNewParamsConfigParam](interfaces/SessionNewParamsConfigParam.md) +- [SessionResource](interfaces/SessionResource.md) +- [SessionResourceAddParams](interfaces/SessionResourceAddParams.md) +- [SessionResourceSpec](interfaces/SessionResourceSpec.md) +- [SessionResourceSpecParam](interfaces/SessionResourceSpecParam.md) +- [SessionStats](interfaces/SessionStats.md) +- [SessionTemplate](interfaces/SessionTemplate.md) +- [SessionThread](interfaces/SessionThread.md) +- [SessionThreadArchiveParams](interfaces/SessionThreadArchiveParams.md) +- [SessionThreadEventListParams](interfaces/SessionThreadEventListParams.md) +- [SessionThreadEventStreamParams](interfaces/SessionThreadEventStreamParams.md) +- [SessionThreadListParams](interfaces/SessionThreadListParams.md) +- [SessionThreadStopReason](interfaces/SessionThreadStopReason.md) +- [SessionUpdateParams](interfaces/SessionUpdateParams.md) +- [SessionUpdateParamsConfigParam](interfaces/SessionUpdateParamsConfigParam.md) +- [SessionUsage](interfaces/SessionUsage.md) +- [Skill](interfaces/Skill.md) +- [SkillBinding](interfaces/SkillBinding.md) +- [SkillBindingParam](interfaces/SkillBindingParam.md) +- [SkillGetParams](interfaces/SkillGetParams.md) +- [SkillListParams](interfaces/SkillListParams.md) +- [SkillNewParams](interfaces/SkillNewParams.md) +- [SkillOverride](interfaces/SkillOverride.md) +- [SkillOverrideParam](interfaces/SkillOverrideParam.md) +- [SkillUpdateParams](interfaces/SkillUpdateParams.md) +- [SkillVersion](interfaces/SkillVersion.md) +- [SkillVersionListParams](interfaces/SkillVersionListParams.md) +- [SkillVersionNewParams](interfaces/SkillVersionNewParams.md) +- [SystemOverride](interfaces/SystemOverride.md) +- [SystemOverrideParam](interfaces/SystemOverrideParam.md) +- [Template](interfaces/Template.md) +- [TemplateArchiveParams](interfaces/TemplateArchiveParams.md) +- [TemplateCloneParams](interfaces/TemplateCloneParams.md) +- [TemplateListParams](interfaces/TemplateListParams.md) +- [TemplateNewParams](interfaces/TemplateNewParams.md) +- [TemplateUpdateParams](interfaces/TemplateUpdateParams.md) +- [Tool](interfaces/Tool.md) +- [ToolConfig](interfaces/ToolConfig.md) +- [ToolConfigParam](interfaces/ToolConfigParam.md) +- [ToolOverride](interfaces/ToolOverride.md) +- [ToolOverrideParam](interfaces/ToolOverrideParam.md) +- [ToolParam](interfaces/ToolParam.md) +- [Vault](interfaces/Vault.md) +- [VaultCredential](interfaces/VaultCredential.md) +- [VaultCredentialAuth](interfaces/VaultCredentialAuth.md) +- [VaultCredentialListParams](interfaces/VaultCredentialListParams.md) +- [VaultCredentialNewParams](interfaces/VaultCredentialNewParams.md) +- [VaultListParams](interfaces/VaultListParams.md) +- [VaultNewParams](interfaces/VaultNewParams.md) + +## Type Aliases + +- [BatchCreateParams](type-aliases/BatchCreateParams.md) +- [ChannelCreateParams](type-aliases/ChannelCreateParams.md) +- [ChannelPairingCreateParams](type-aliases/ChannelPairingCreateParams.md) +- [ChannelQRSessionCreateParams](type-aliases/ChannelQRSessionCreateParams.md) +- [EnvironmentCreateParams](type-aliases/EnvironmentCreateParams.md) +- [EnvironmentVariablesUnionParam](type-aliases/EnvironmentVariablesUnionParam.md) +- [EventContentUnionParam](type-aliases/EventContentUnionParam.md) +- [ForwardClientOptions](type-aliases/ForwardClientOptions.md) +- [IdentityCreateParams](type-aliases/IdentityCreateParams.md) +- [MemoryStoreCreateParams](type-aliases/MemoryStoreCreateParams.md) +- [MemoryStoreMemoryCreateParams](type-aliases/MemoryStoreMemoryCreateParams.md) +- [ModelConfig](type-aliases/ModelConfig.md) +- [ModelConfigUnionParam](type-aliases/ModelConfigUnionParam.md) +- [ScheduleCreateParams](type-aliases/ScheduleCreateParams.md) +- [ScheduleRunRetrieveParams](type-aliases/ScheduleRunRetrieveParams.md) +- [SessionCreateParams](type-aliases/SessionCreateParams.md) +- [SkillCreateParams](type-aliases/SkillCreateParams.md) +- [SkillRetrieveParams](type-aliases/SkillRetrieveParams.md) +- [SkillVersionCreateParams](type-aliases/SkillVersionCreateParams.md) +- [TemplateCreateParams](type-aliases/TemplateCreateParams.md) +- [VaultCreateParams](type-aliases/VaultCreateParams.md) +- [VaultCredentialCreateParams](type-aliases/VaultCredentialCreateParams.md) + +## References + +### APIConnectionError + +Re-exports [APIConnectionError](../index/classes/APIConnectionError.md) + +*** + +### APIConnectionTimeoutError + +Re-exports [APIConnectionTimeoutError](../index/classes/APIConnectionTimeoutError.md) + +*** + +### APIError + +Re-exports [APIError](../index/classes/APIError.md) + +*** + +### APIPromise + +Re-exports [APIPromise](../index/classes/APIPromise.md) + +*** + +### APIUserAbortError + +Re-exports [APIUserAbortError](../index/classes/APIUserAbortError.md) + +*** + +### AuthenticationError + +Re-exports [AuthenticationError](../index/classes/AuthenticationError.md) + +*** + +### BadRequestError + +Re-exports [BadRequestError](../index/classes/BadRequestError.md) + +*** + +### ClientOptions + +Re-exports [ClientOptions](../index/interfaces/ClientOptions.md) + +*** + +### ConflictError + +Re-exports [ConflictError](../index/classes/ConflictError.md) + +*** + +### Credential + +Re-exports [Credential](../index/interfaces/Credential.md) + +*** + +### default + +Renames and re-exports [ForwardClient](../index/classes/ForwardClient.md) + +*** + +### ForwardClient + +Re-exports [ForwardClient](../index/classes/ForwardClient.md) + +*** + +### InternalServerError + +Re-exports [InternalServerError](../index/classes/InternalServerError.md) + +*** + +### NotFoundError + +Re-exports [NotFoundError](../index/classes/NotFoundError.md) + +*** + +### Page + +Re-exports [Page](../index/classes/Page.md) + +*** + +### PagePromise + +Re-exports [PagePromise](../index/classes/PagePromise.md) + +*** + +### PATCredential + +Re-exports [PATCredential](../index/classes/PATCredential.md) + +*** + +### PermissionDeniedError + +Re-exports [PermissionDeniedError](../index/classes/PermissionDeniedError.md) + +*** + +### QoderError + +Re-exports [QoderError](../index/classes/QoderError.md) + +*** + +### RateLimitError + +Re-exports [RateLimitError](../index/classes/RateLimitError.md) + +*** + +### RequestOptions + +Re-exports [RequestOptions](../index/interfaces/RequestOptions.md) + +*** + +### ResumableSessionEventStream + +Re-exports [ResumableSessionEventStream](../index/classes/ResumableSessionEventStream.md) + +*** + +### Stream + +Re-exports [Stream](../index/classes/Stream.md) + +*** + +### toFile + +Re-exports [toFile](../index/functions/toFile.md) + +*** + +### UnprocessableEntityError + +Re-exports [UnprocessableEntityError](../index/classes/UnprocessableEntityError.md) + +*** + +### Uploadable + +Re-exports [Uploadable](../index/type-aliases/Uploadable.md) diff --git a/docs/api/forward/classes/BatchTasks.md b/docs/api/forward/classes/BatchTasks.md new file mode 100644 index 0000000..725ce1c --- /dev/null +++ b/docs/api/forward/classes/BatchTasks.md @@ -0,0 +1,71 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchTasks + +# Class: BatchTasks + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new BatchTasks**(`_client`): `BatchTasks` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`BatchTasks` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`batchID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`BatchTask`](../interfaces/BatchTask.md)\> + +查询 Batch 子任务. + +#### Parameters + +##### batchID + +`string` + +##### params? + +[`BatchTaskListParams`](../interfaces/BatchTaskListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`BatchTask`](../interfaces/BatchTask.md)\> + +#### Operation + +listBatchTasks diff --git a/docs/api/forward/classes/Batches.md b/docs/api/forward/classes/Batches.md new file mode 100644 index 0000000..e13aa09 --- /dev/null +++ b/docs/api/forward/classes/Batches.md @@ -0,0 +1,207 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Batches + +# Class: Batches + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Batches**(`_client`): `Batches` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Batches` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### tasks + +> `readonly` **tasks**: [`BatchTasks`](BatchTasks.md) + +## Methods + +### cancel() + +> **cancel**(`batchID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Batch`](../interfaces/Batch.md)\> + +取消 Batch. + +#### Parameters + +##### batchID + +`string` + +##### params? + +[`BatchCancelParams`](../interfaces/BatchCancelParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Batch`](../interfaces/Batch.md)\> + +#### Operation + +cancelBatch + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Batch`](../interfaces/Batch.md)\> + +创建 Batch. + +#### Parameters + +##### params + +[`BatchNewParams`](../interfaces/BatchNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Batch`](../interfaces/Batch.md)\> + +#### Operation + +createBatch + +*** + +### getError() + +> **getError**(`batchID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`BatchFile`](../interfaces/BatchFile.md)\> + +获取错误文件. + +#### Parameters + +##### batchID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`BatchFile`](../interfaces/BatchFile.md)\> + +#### Operation + +getBatchError + +*** + +### getOutput() + +> **getOutput**(`batchID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`BatchFile`](../interfaces/BatchFile.md)\> + +获取输出文件. + +#### Parameters + +##### batchID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`BatchFile`](../interfaces/BatchFile.md)\> + +#### Operation + +getBatchOutput + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Batch`](../interfaces/Batch.md)\> + +列出 Batches. + +#### Parameters + +##### params? + +[`BatchListParams`](../interfaces/BatchListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Batch`](../interfaces/Batch.md)\> + +#### Operation + +listBatches + +*** + +### retrieve() + +> **retrieve**(`batchID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Batch`](../interfaces/Batch.md)\> + +查询 Batch 详情. + +#### Parameters + +##### batchID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Batch`](../interfaces/Batch.md)\> + +#### Operation + +getBatch diff --git a/docs/api/forward/classes/ChannelPairings.md b/docs/api/forward/classes/ChannelPairings.md new file mode 100644 index 0000000..9a3f0ed --- /dev/null +++ b/docs/api/forward/classes/ChannelPairings.md @@ -0,0 +1,93 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelPairings + +# Class: ChannelPairings + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new ChannelPairings**(`_client`): `ChannelPairings` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`ChannelPairings` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ChannelPairing`](../interfaces/ChannelPairing.md)\> + +完成 Channel 配对. + +#### Parameters + +##### params + +[`ChannelPairingNewParams`](../interfaces/ChannelPairingNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ChannelPairing`](../interfaces/ChannelPairing.md)\> + +#### Operation + +pairChannel + +*** + +### delete() + +> **delete**(`pairingID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedChannelPairing`](../interfaces/DeletedChannelPairing.md)\> + +解除 Channel 配对. + +#### Parameters + +##### pairingID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedChannelPairing`](../interfaces/DeletedChannelPairing.md)\> + +#### Operation + +unpairChannel diff --git a/docs/api/forward/classes/ChannelQRSessions.md b/docs/api/forward/classes/ChannelQRSessions.md new file mode 100644 index 0000000..d8bde16 --- /dev/null +++ b/docs/api/forward/classes/ChannelQRSessions.md @@ -0,0 +1,97 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelQRSessions + +# Class: ChannelQRSessions + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new ChannelQRSessions**(`_client`): `ChannelQRSessions` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`ChannelQRSessions` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### create() + +> **create**(`channelID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ChannelQRSession`](../interfaces/ChannelQRSession.md)\> + +创建 Channel QR Session. + +#### Parameters + +##### channelID + +`string` + +##### params? + +[`ChannelQRSessionNewParams`](../interfaces/ChannelQRSessionNewParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ChannelQRSession`](../interfaces/ChannelQRSession.md)\> + +#### Operation + +createChannelQrSession + +*** + +### retrieve() + +> **retrieve**(`sessionKey`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ChannelQRSession`](../interfaces/ChannelQRSession.md)\> + +获取 Channel QR Session. + +#### Parameters + +##### sessionKey + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ChannelQRSession`](../interfaces/ChannelQRSession.md)\> + +#### Operation + +getChannelQrSession diff --git a/docs/api/forward/classes/Channels.md b/docs/api/forward/classes/Channels.md new file mode 100644 index 0000000..9e881b9 --- /dev/null +++ b/docs/api/forward/classes/Channels.md @@ -0,0 +1,181 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Channels + +# Class: Channels + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Channels**(`_client`): `Channels` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Channels` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### qrSessions + +> `readonly` **qrSessions**: [`ChannelQRSessions`](ChannelQRSessions.md) + +## Methods + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Channel`](../interfaces/Channel.md)\> + +创建 Channel. + +#### Parameters + +##### params + +[`ChannelNewParams`](../interfaces/ChannelNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Channel`](../interfaces/Channel.md)\> + +#### Operation + +createChannel + +*** + +### delete() + +> **delete**(`channelID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedChannel`](../interfaces/DeletedChannel.md)\> + +删除 Channel. + +#### Parameters + +##### channelID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedChannel`](../interfaces/DeletedChannel.md)\> + +#### Operation + +deleteChannel + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Channel`](../interfaces/Channel.md)\> + +列出 Channels. + +#### Parameters + +##### params? + +[`ChannelListParams`](../interfaces/ChannelListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Channel`](../interfaces/Channel.md)\> + +#### Operation + +listChannels + +*** + +### retrieve() + +> **retrieve**(`channelID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Channel`](../interfaces/Channel.md)\> + +获取 Channel. + +#### Parameters + +##### channelID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Channel`](../interfaces/Channel.md)\> + +#### Operation + +getChannel + +*** + +### update() + +> **update**(`channelID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Channel`](../interfaces/Channel.md)\> + +更新 Channel. + +#### Parameters + +##### channelID + +`string` + +##### params? + +[`ChannelUpdateParams`](../interfaces/ChannelUpdateParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Channel`](../interfaces/Channel.md)\> + +#### Operation + +updateChannel diff --git a/docs/api/forward/classes/Environments.md b/docs/api/forward/classes/Environments.md new file mode 100644 index 0000000..b98e9b2 --- /dev/null +++ b/docs/api/forward/classes/Environments.md @@ -0,0 +1,201 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Environments + +# Class: Environments + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Environments**(`_client`): `Environments` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Environments` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### archive() + +> **archive**(`id`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +Archive an environment retained by historical sessions or tool calls. + +#### Parameters + +##### id + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +#### Operation + +archiveEnvironment + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +创建 Environment. + +#### Parameters + +##### params + +[`EnvironmentNewParams`](../interfaces/EnvironmentNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +#### Operation + +createEnvironment + +*** + +### delete() + +> **delete**(`id`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +删除 Environment. + +#### Parameters + +##### id + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +#### Operation + +deleteEnvironment + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +列出 Environment. + +#### Parameters + +##### params? + +[`EnvironmentListParams`](../interfaces/EnvironmentListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +#### Operation + +listEnvironment + +*** + +### retrieve() + +> **retrieve**(`id`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +查询 Environment. + +#### Parameters + +##### id + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +#### Operation + +getEnvironment + +*** + +### update() + +> **update**(`id`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +修改 Environment. + +#### Parameters + +##### id + +`string` + +##### params? + +[`EnvironmentUpdateParams`](../interfaces/EnvironmentUpdateParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +#### Operation + +updateEnvironment diff --git a/docs/api/forward/classes/Files.md b/docs/api/forward/classes/Files.md new file mode 100644 index 0000000..c572314 --- /dev/null +++ b/docs/api/forward/classes/Files.md @@ -0,0 +1,171 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Files + +# Class: Files + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Files**(`_client`): `Files` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Files` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### delete() + +> **delete**(`fileID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +删除 File. + +#### Parameters + +##### fileID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +#### Operation + +deleteFile + +*** + +### download() + +> **download**(`fileID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<`Response`\> + +下载 File. + +#### Parameters + +##### fileID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<`Response`\> + +#### Operation + +downloadFile + +*** + +### getMetadata() + +> **getMetadata**(`fileID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +查询 File. + +#### Parameters + +##### fileID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +#### Operation + +getFile + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +列出 File. + +#### Parameters + +##### params? + +[`FileListParams`](../interfaces/FileListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +#### Operation + +listFile + +*** + +### upload() + +> **upload**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +上传 File. + +#### Parameters + +##### params + +[`FileUploadParams`](../interfaces/FileUploadParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +#### Operation + +uploadFile diff --git a/docs/api/forward/classes/Identities.md b/docs/api/forward/classes/Identities.md new file mode 100644 index 0000000..6ad67e4 --- /dev/null +++ b/docs/api/forward/classes/Identities.md @@ -0,0 +1,339 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Identities + +# Class: Identities + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Identities**(`_client`): `Identities` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Identities` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### configs + +> `readonly` **configs**: [`IdentityConfigs`](IdentityConfigs.md) + +*** + +### memoryStores + +> `readonly` **memoryStores**: [`IdentityMemoryStores`](IdentityMemoryStores.md) + +## Methods + +### clear() + +> **clear**(`identityID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityClearResponse`](../interfaces/IdentityClearResponse.md)\> + +清理 Identity. + +#### Parameters + +##### identityID + +`string` + +##### params? + +[`IdentityClearParams`](../interfaces/IdentityClearParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityClearResponse`](../interfaces/IdentityClearResponse.md)\> + +#### Operation + +clearIdentity + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +创建 Identity. + +#### Parameters + +##### params + +[`IdentityNewParams`](../interfaces/IdentityNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +#### Operation + +createIdentity + +*** + +### delete() + +> **delete**(`identityID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedIdentity`](../interfaces/DeletedIdentity.md)\> + +删除 Identity. + +#### Parameters + +##### identityID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedIdentity`](../interfaces/DeletedIdentity.md)\> + +#### Operation + +deleteIdentity + +*** + +### disable() + +> **disable**(`identityID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +停用 Identity. + +#### Parameters + +##### identityID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +#### Operation + +disableIdentity + +*** + +### enable() + +> **enable**(`identityID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +启用 Identity. + +#### Parameters + +##### identityID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +#### Operation + +enableIdentity + +*** + +### ensureAdmin() + +> **ensureAdmin**(`options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +确保管理员 Identity. + +#### Parameters + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +#### Operation + +ensureAdminIdentity + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +列出 Identities. + +#### Parameters + +##### params? + +[`IdentityListParams`](../interfaces/IdentityListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +#### Operation + +listIdentities + +*** + +### listTemplates() + +> **listTemplates**(`identityID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityListTemplatesResponse`](../interfaces/IdentityListTemplatesResponse.md)\> + +列出 Identity 使用的 Template. + +#### Parameters + +##### identityID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityListTemplatesResponse`](../interfaces/IdentityListTemplatesResponse.md)\> + +#### Operation + +listIdentityAgents + +*** + +### retrieve() + +> **retrieve**(`identityID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +获取 Identity. + +#### Parameters + +##### identityID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +#### Operation + +getIdentity + +*** + +### stats() + +> **stats**(`options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityStats`](../interfaces/IdentityStats.md)\> + +获取 Identity 统计. + +#### Parameters + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityStats`](../interfaces/IdentityStats.md)\> + +#### Operation + +getIdentityStats + +*** + +### update() + +> **update**(`identityID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +更新 Identity. + +#### Parameters + +##### identityID + +`string` + +##### params? + +[`IdentityUpdateParams`](../interfaces/IdentityUpdateParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Identity`](../interfaces/Identity.md)\> + +#### Operation + +updateIdentity diff --git a/docs/api/forward/classes/IdentityConfigs.md b/docs/api/forward/classes/IdentityConfigs.md new file mode 100644 index 0000000..65fef97 --- /dev/null +++ b/docs/api/forward/classes/IdentityConfigs.md @@ -0,0 +1,165 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityConfigs + +# Class: IdentityConfigs + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new IdentityConfigs**(`_client`): `IdentityConfigs` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`IdentityConfigs` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### getEffective() + +> **getEffective**(`identityID`, `templateID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`EffectiveConfig`](../interfaces/EffectiveConfig.md)\> + +获取 Effective Config. + +#### Parameters + +##### identityID + +`string` + +##### templateID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`EffectiveConfig`](../interfaces/EffectiveConfig.md)\> + +#### Operation + +getEffectiveConfig + +*** + +### list() + +> **list**(`identityID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`IdentityConfig`](../interfaces/IdentityConfig.md)\> + +列出 Identity Configs. + +#### Parameters + +##### identityID + +`string` + +##### params? + +[`IdentityConfigListParams`](../interfaces/IdentityConfigListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`IdentityConfig`](../interfaces/IdentityConfig.md)\> + +#### Operation + +listIdentityConfigs + +*** + +### retrieve() + +> **retrieve**(`identityID`, `templateID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityConfig`](../interfaces/IdentityConfig.md)\> + +获取 Identity Config. + +#### Parameters + +##### identityID + +`string` + +##### templateID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityConfig`](../interfaces/IdentityConfig.md)\> + +#### Operation + +getIdentityConfig + +*** + +### upsert() + +> **upsert**(`identityID`, `templateID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityConfig`](../interfaces/IdentityConfig.md)\> + +创建或更新 Identity Config. + +#### Parameters + +##### identityID + +`string` + +##### templateID + +`string` + +##### params + +[`IdentityConfigUpsertParams`](../interfaces/IdentityConfigUpsertParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityConfig`](../interfaces/IdentityConfig.md)\> + +#### Operation + +upsertIdentityConfig diff --git a/docs/api/forward/classes/IdentityMemoryStores.md b/docs/api/forward/classes/IdentityMemoryStores.md new file mode 100644 index 0000000..fd855b3 --- /dev/null +++ b/docs/api/forward/classes/IdentityMemoryStores.md @@ -0,0 +1,139 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityMemoryStores + +# Class: IdentityMemoryStores + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new IdentityMemoryStores**(`_client`): `IdentityMemoryStores` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`IdentityMemoryStores` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### detach() + +> **detach**(`identityID`, `templateID`, `memoryStoreID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedMemoryStoreMount`](../interfaces/DeletedMemoryStoreMount.md)\> + +解绑 Identity 上的 Memory Store. + +#### Parameters + +##### identityID + +`string` + +##### templateID + +`string` + +##### memoryStoreID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedMemoryStoreMount`](../interfaces/DeletedMemoryStoreMount.md)\> + +#### Operation + +detachMemoryStore + +*** + +### list() + +> **list**(`identityID`, `templateID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityMemoryStoreListResponse`](../interfaces/IdentityMemoryStoreListResponse.md)\> + +列出 Identity 上的 Memory Store 挂载. + +#### Parameters + +##### identityID + +`string` + +##### templateID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`IdentityMemoryStoreListResponse`](../interfaces/IdentityMemoryStoreListResponse.md)\> + +#### Operation + +listMemoryStoreMounts + +*** + +### mount() + +> **mount**(`identityID`, `templateID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStoreMount`](../interfaces/MemoryStoreMount.md)\> + +挂载 Memory Store 到 Identity. + +#### Parameters + +##### identityID + +`string` + +##### templateID + +`string` + +##### params + +[`IdentityMemoryStoreMountParams`](../interfaces/IdentityMemoryStoreMountParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStoreMount`](../interfaces/MemoryStoreMount.md)\> + +#### Operation + +mountMemoryStore diff --git a/docs/api/forward/classes/MemoryStoreMemories.md b/docs/api/forward/classes/MemoryStoreMemories.md new file mode 100644 index 0000000..b0ba15b --- /dev/null +++ b/docs/api/forward/classes/MemoryStoreMemories.md @@ -0,0 +1,195 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreMemories + +# Class: MemoryStoreMemories + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new MemoryStoreMemories**(`_client`): `MemoryStoreMemories` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`MemoryStoreMemories` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### create() + +> **create**(`memoryStoreID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Memory`](../interfaces/Memory.md)\> + +创建 Memory. + +#### Parameters + +##### memoryStoreID + +`string` + +##### params + +[`MemoryStoreMemoryNewParams`](../interfaces/MemoryStoreMemoryNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Memory`](../interfaces/Memory.md)\> + +#### Operation + +createMemoryStoreMemory + +*** + +### delete() + +> **delete**(`memoryStoreID`, `memoryID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedMemory`](../interfaces/DeletedMemory.md)\> + +删除 Memory. + +#### Parameters + +##### memoryStoreID + +`string` + +##### memoryID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedMemory`](../interfaces/DeletedMemory.md)\> + +#### Operation + +deleteMemoryStoreMemory + +*** + +### list() + +> **list**(`memoryStoreID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Memory`](../interfaces/Memory.md)\> + +列出 Memory. + +#### Parameters + +##### memoryStoreID + +`string` + +##### params? + +[`MemoryStoreMemoryListParams`](../interfaces/MemoryStoreMemoryListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Memory`](../interfaces/Memory.md)\> + +#### Operation + +listMemoryStoreMemoryMemories + +*** + +### retrieve() + +> **retrieve**(`memoryStoreID`, `memoryID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Memory`](../interfaces/Memory.md)\> + +查询 Memory. + +#### Parameters + +##### memoryStoreID + +`string` + +##### memoryID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Memory`](../interfaces/Memory.md)\> + +#### Operation + +getMemoryStoreMemory + +*** + +### update() + +> **update**(`memoryStoreID`, `memoryID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Memory`](../interfaces/Memory.md)\> + +更新 Memory. + +#### Parameters + +##### memoryStoreID + +`string` + +##### memoryID + +`string` + +##### params + +[`MemoryStoreMemoryUpdateParams`](../interfaces/MemoryStoreMemoryUpdateParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Memory`](../interfaces/Memory.md)\> + +#### Operation + +updateMemoryStoreMemory diff --git a/docs/api/forward/classes/MemoryStoreMemoryVersions.md b/docs/api/forward/classes/MemoryStoreMemoryVersions.md new file mode 100644 index 0000000..bc3702a --- /dev/null +++ b/docs/api/forward/classes/MemoryStoreMemoryVersions.md @@ -0,0 +1,131 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreMemoryVersions + +# Class: MemoryStoreMemoryVersions + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new MemoryStoreMemoryVersions**(`_client`): `MemoryStoreMemoryVersions` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`MemoryStoreMemoryVersions` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`memoryStoreID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`MemoryVersion`](../interfaces/MemoryVersion.md)\> + +列出 Memory 版本. + +#### Parameters + +##### memoryStoreID + +`string` + +##### params? + +[`MemoryStoreMemoryVersionListParams`](../interfaces/MemoryStoreMemoryVersionListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`MemoryVersion`](../interfaces/MemoryVersion.md)\> + +#### Operation + +listMemoryStoreMemoryVersion + +*** + +### redact() + +> **redact**(`memoryStoreID`, `memoryVersionID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryVersion`](../interfaces/MemoryVersion.md)\> + +Redact Memory 版本. + +#### Parameters + +##### memoryStoreID + +`string` + +##### memoryVersionID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryVersion`](../interfaces/MemoryVersion.md)\> + +#### Operation + +redactMemoryStoreMemoryVersion + +*** + +### retrieve() + +> **retrieve**(`memoryStoreID`, `memoryVersionID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryVersion`](../interfaces/MemoryVersion.md)\> + +查询 Memory 版本. + +#### Parameters + +##### memoryStoreID + +`string` + +##### memoryVersionID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryVersion`](../interfaces/MemoryVersion.md)\> + +#### Operation + +getMemoryStoreMemoryVersion diff --git a/docs/api/forward/classes/MemoryStores.md b/docs/api/forward/classes/MemoryStores.md new file mode 100644 index 0000000..944b352 --- /dev/null +++ b/docs/api/forward/classes/MemoryStores.md @@ -0,0 +1,213 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStores + +# Class: MemoryStores + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new MemoryStores**(`_client`): `MemoryStores` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`MemoryStores` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### memories + +> `readonly` **memories**: [`MemoryStoreMemories`](MemoryStoreMemories.md) + +*** + +### memoryVersions + +> `readonly` **memoryVersions**: [`MemoryStoreMemoryVersions`](MemoryStoreMemoryVersions.md) + +## Methods + +### archive() + +> **archive**(`memoryStoreID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +归档 Memory Store. + +#### Parameters + +##### memoryStoreID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +#### Operation + +archiveMemoryStore + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +创建 Memory Store. + +#### Parameters + +##### params + +[`MemoryStoreNewParams`](../interfaces/MemoryStoreNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +#### Operation + +createMemoryStore + +*** + +### delete() + +> **delete**(`memoryStoreID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedMemoryStore`](../interfaces/DeletedMemoryStore.md)\> + +删除 Memory Store. + +#### Parameters + +##### memoryStoreID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedMemoryStore`](../interfaces/DeletedMemoryStore.md)\> + +#### Operation + +deleteMemoryStore + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +列出 Memory Store. + +#### Parameters + +##### params? + +[`MemoryStoreListParams`](../interfaces/MemoryStoreListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +#### Operation + +listMemoryStore + +*** + +### retrieve() + +> **retrieve**(`memoryStoreID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +查询 Memory Store. + +#### Parameters + +##### memoryStoreID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +#### Operation + +getMemoryStore + +*** + +### update() + +> **update**(`memoryStoreID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +更新 Memory Store. + +#### Parameters + +##### memoryStoreID + +`string` + +##### params? + +[`MemoryStoreUpdateParams`](../interfaces/MemoryStoreUpdateParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`MemoryStore`](../interfaces/MemoryStore.md)\> + +#### Operation + +updateMemoryStore diff --git a/docs/api/forward/classes/Models.md b/docs/api/forward/classes/Models.md new file mode 100644 index 0000000..6376167 --- /dev/null +++ b/docs/api/forward/classes/Models.md @@ -0,0 +1,63 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Models + +# Class: Models + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Models**(`_client`): `Models` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Models` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ModelListResponse`](../interfaces/ModelListResponse.md)\> + +列出模型. + +#### Parameters + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ModelListResponse`](../interfaces/ModelListResponse.md)\> + +#### Operation + +listModels diff --git a/docs/api/forward/classes/ScheduleRuns.md b/docs/api/forward/classes/ScheduleRuns.md new file mode 100644 index 0000000..3f32d48 --- /dev/null +++ b/docs/api/forward/classes/ScheduleRuns.md @@ -0,0 +1,97 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleRuns + +# Class: ScheduleRuns + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new ScheduleRuns**(`_client`): `ScheduleRuns` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`ScheduleRuns` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`params`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ScheduleRun`](../interfaces/ScheduleRun.md)\> + +列出 Schedule Runs. + +#### Parameters + +##### params + +[`ScheduleRunListParams`](../interfaces/ScheduleRunListParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ScheduleRun`](../interfaces/ScheduleRun.md)\> + +#### Operation + +listScheduleRuns + +*** + +### retrieve() + +> **retrieve**(`runID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ScheduleRun`](../interfaces/ScheduleRun.md)\> + +获取 Schedule Run. + +#### Parameters + +##### runID + +`string` + +##### params? + +[`ScheduleRunGetParams`](../interfaces/ScheduleRunGetParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ScheduleRun`](../interfaces/ScheduleRun.md)\> + +#### Operation + +getScheduleRun diff --git a/docs/api/forward/classes/Schedules.md b/docs/api/forward/classes/Schedules.md new file mode 100644 index 0000000..df0e3d7 --- /dev/null +++ b/docs/api/forward/classes/Schedules.md @@ -0,0 +1,295 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Schedules + +# Class: Schedules + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Schedules**(`_client`): `Schedules` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Schedules` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### archive() + +> **archive**(`scheduleID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +归档 Schedule. + +#### Parameters + +##### scheduleID + +`string` + +##### params? + +[`ScheduleArchiveParams`](../interfaces/ScheduleArchiveParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +#### Operation + +archiveSchedule + +*** + +### archiveMany() + +> **archiveMany**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ScheduleArchiveManyResponse`](../interfaces/ScheduleArchiveManyResponse.md)\> + +批量归档 Schedules. + +#### Parameters + +##### params + +[`ScheduleArchiveManyParams`](../interfaces/ScheduleArchiveManyParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ScheduleArchiveManyResponse`](../interfaces/ScheduleArchiveManyResponse.md)\> + +#### Operation + +archiveSchedules + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +创建 Schedule. + +#### Parameters + +##### params + +[`ScheduleNewParams`](../interfaces/ScheduleNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +#### Operation + +createSchedule + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +列出 Schedules. + +#### Parameters + +##### params? + +[`ScheduleListParams`](../interfaces/ScheduleListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +#### Operation + +listSchedules + +*** + +### pause() + +> **pause**(`scheduleID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +暂停 Schedule. + +#### Parameters + +##### scheduleID + +`string` + +##### params? + +[`SchedulePauseParams`](../interfaces/SchedulePauseParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +#### Operation + +pauseSchedule + +*** + +### retrieve() + +> **retrieve**(`scheduleID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +获取 Schedule. + +#### Parameters + +##### scheduleID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +#### Operation + +getSchedule + +*** + +### run() + +> **run**(`scheduleID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ScheduleRun`](../interfaces/ScheduleRun.md)\> + +运行 Schedule. + +#### Parameters + +##### scheduleID + +`string` + +##### params? + +[`ScheduleRunParams`](../interfaces/ScheduleRunParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ScheduleRun`](../interfaces/ScheduleRun.md)\> + +#### Operation + +runSchedule + +*** + +### unpause() + +> **unpause**(`scheduleID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +恢复 Schedule. + +#### Parameters + +##### scheduleID + +`string` + +##### params? + +[`ScheduleUnpauseParams`](../interfaces/ScheduleUnpauseParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +#### Operation + +unpauseSchedule + +*** + +### update() + +> **update**(`scheduleID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +更新 Schedule. + +#### Parameters + +##### scheduleID + +`string` + +##### params? + +[`ScheduleUpdateParams`](../interfaces/ScheduleUpdateParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Schedule`](../interfaces/Schedule.md)\> + +#### Operation + +updateSchedule diff --git a/docs/api/forward/classes/SessionEvents.md b/docs/api/forward/classes/SessionEvents.md new file mode 100644 index 0000000..eb7f237 --- /dev/null +++ b/docs/api/forward/classes/SessionEvents.md @@ -0,0 +1,157 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionEvents + +# Class: SessionEvents + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SessionEvents**(`_client`): `SessionEvents` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SessionEvents` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`sessionID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\> + +列出 Session Events. + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionEventListParams`](../interfaces/SessionEventListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\> + +#### Operation + +listSessionEvents + +*** + +### resumableStream() + +> **resumableStream**(`sessionID`, `params?`, `options?`): [`ResumableSessionEventStream`](../../index/classes/ResumableSessionEventStream.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\> + +Subscribe to Session Events and reconnect from the latest delivered SSE frame. + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionEventStreamParams`](../interfaces/SessionEventStreamParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`ResumableSessionEventStream`](../../index/classes/ResumableSessionEventStream.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\> + +*** + +### send() + +> **send**(`sessionID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionEventSendResponse`](../interfaces/SessionEventSendResponse.md)\> + +发送 Session Events. + +#### Parameters + +##### sessionID + +`string` + +##### params + +[`SessionEventSendParams`](../interfaces/SessionEventSendParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionEventSendResponse`](../interfaces/SessionEventSendResponse.md)\> + +#### Operation + +sendSessionEvents + +*** + +### streamEvents() + +> **streamEvents**(`sessionID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Stream`](../../index/classes/Stream.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\>\> + +订阅 Session Event Stream. + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionEventStreamParams`](../interfaces/SessionEventStreamParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Stream`](../../index/classes/Stream.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\>\> + +#### Operation + +streamSessionEvents diff --git a/docs/api/forward/classes/SessionResources.md b/docs/api/forward/classes/SessionResources.md new file mode 100644 index 0000000..522fcc3 --- /dev/null +++ b/docs/api/forward/classes/SessionResources.md @@ -0,0 +1,71 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionResources + +# Class: SessionResources + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SessionResources**(`_client`): `SessionResources` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SessionResources` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### add() + +> **add**(`sessionID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionResource`](../interfaces/SessionResource.md)\> + +添加 Session 资源. + +#### Parameters + +##### sessionID + +`string` + +##### params + +[`SessionResourceAddParams`](../interfaces/SessionResourceAddParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionResource`](../interfaces/SessionResource.md)\> + +#### Operation + +addSessionResource diff --git a/docs/api/forward/classes/SessionThreadEvents.md b/docs/api/forward/classes/SessionThreadEvents.md new file mode 100644 index 0000000..9cb7a09 --- /dev/null +++ b/docs/api/forward/classes/SessionThreadEvents.md @@ -0,0 +1,109 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionThreadEvents + +# Class: SessionThreadEvents + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SessionThreadEvents**(`_client`): `SessionThreadEvents` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SessionThreadEvents` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`sessionID`, `threadID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\> + +列出 Session Thread Events. + +#### Parameters + +##### sessionID + +`string` + +##### threadID + +`string` + +##### params? + +[`SessionThreadEventListParams`](../interfaces/SessionThreadEventListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\> + +#### Operation + +listSessionThreadEvents + +*** + +### streamEvents() + +> **streamEvents**(`sessionID`, `threadID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Stream`](../../index/classes/Stream.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\>\> + +订阅 Session Thread Event Stream. + +#### Parameters + +##### sessionID + +`string` + +##### threadID + +`string` + +##### params? + +[`SessionThreadEventStreamParams`](../interfaces/SessionThreadEventStreamParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Stream`](../../index/classes/Stream.md)\<[`SessionEvent`](../interfaces/SessionEvent.md)\>\> + +#### Operation + +streamSessionThreadEvents diff --git a/docs/api/forward/classes/SessionThreads.md b/docs/api/forward/classes/SessionThreads.md new file mode 100644 index 0000000..386aa9e --- /dev/null +++ b/docs/api/forward/classes/SessionThreads.md @@ -0,0 +1,141 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionThreads + +# Class: SessionThreads + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SessionThreads**(`_client`): `SessionThreads` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SessionThreads` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### events + +> `readonly` **events**: [`SessionThreadEvents`](SessionThreadEvents.md) + +## Methods + +### archive() + +> **archive**(`sessionID`, `threadID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionThread`](../interfaces/SessionThread.md)\> + +归档 Session Thread. + +#### Parameters + +##### sessionID + +`string` + +##### threadID + +`string` + +##### params? + +[`SessionThreadArchiveParams`](../interfaces/SessionThreadArchiveParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionThread`](../interfaces/SessionThread.md)\> + +#### Operation + +archiveSessionThread + +*** + +### list() + +> **list**(`sessionID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`SessionThread`](../interfaces/SessionThread.md)\> + +列出 Session Threads. + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionThreadListParams`](../interfaces/SessionThreadListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`SessionThread`](../interfaces/SessionThread.md)\> + +#### Operation + +listSessionThreads + +*** + +### retrieve() + +> **retrieve**(`sessionID`, `threadID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionThread`](../interfaces/SessionThread.md)\> + +获取 Session Thread. + +#### Parameters + +##### sessionID + +`string` + +##### threadID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionThread`](../interfaces/SessionThread.md)\> + +#### Operation + +getSessionThread diff --git a/docs/api/forward/classes/Sessions.md b/docs/api/forward/classes/Sessions.md new file mode 100644 index 0000000..6d8222f --- /dev/null +++ b/docs/api/forward/classes/Sessions.md @@ -0,0 +1,227 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Sessions + +# Class: Sessions + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Sessions**(`_client`): `Sessions` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Sessions` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### events + +> `readonly` **events**: [`SessionEvents`](SessionEvents.md) + +*** + +### resources + +> `readonly` **resources**: [`SessionResources`](SessionResources.md) + +*** + +### threads + +> `readonly` **threads**: [`SessionThreads`](SessionThreads.md) + +## Methods + +### archive() + +> **archive**(`sessionID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +归档 Session. + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionArchiveParams`](../interfaces/SessionArchiveParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +#### Operation + +archiveSession + +*** + +### cancel() + +> **cancel**(`sessionID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +取消当前 Turn. + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionCancelParams`](../interfaces/SessionCancelParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +#### Operation + +cancelSession + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +创建 Session. + +#### Parameters + +##### params + +[`SessionNewParams`](../interfaces/SessionNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +#### Operation + +createSession + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Session`](../interfaces/Session.md)\> + +列出 Sessions. + +#### Parameters + +##### params? + +[`SessionListParams`](../interfaces/SessionListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Session`](../interfaces/Session.md)\> + +#### Operation + +listSessions + +*** + +### retrieve() + +> **retrieve**(`sessionID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +获取 Session. + +#### Parameters + +##### sessionID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +#### Operation + +getSession + +*** + +### update() + +> **update**(`sessionID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +更新 Session. + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionUpdateParams`](../interfaces/SessionUpdateParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Session`](../interfaces/Session.md)\> + +#### Operation + +updateSession diff --git a/docs/api/forward/classes/SkillVersions.md b/docs/api/forward/classes/SkillVersions.md new file mode 100644 index 0000000..ea9c447 --- /dev/null +++ b/docs/api/forward/classes/SkillVersions.md @@ -0,0 +1,191 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillVersions + +# Class: SkillVersions + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SkillVersions**(`_client`): `SkillVersions` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SkillVersions` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### create() + +> **create**(`id`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +创建 Skill 版本. + +#### Parameters + +##### id + +`string` + +##### params + +[`SkillVersionNewParams`](../interfaces/SkillVersionNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +#### Operation + +createSkillVersion + +*** + +### delete() + +> **delete**(`id`, `version`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedSkillVersion`](../interfaces/DeletedSkillVersion.md)\> + +删除 Skill 版本. + +#### Parameters + +##### id + +`string` + +##### version + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedSkillVersion`](../interfaces/DeletedSkillVersion.md)\> + +#### Operation + +deleteSkillVersion + +*** + +### download() + +> **download**(`id`, `version`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<`Response`\> + +下载 Skill 版本内容. + +#### Parameters + +##### id + +`string` + +##### version + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<`Response`\> + +#### Operation + +downloadSkillVersion + +*** + +### list() + +> **list**(`id`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +列出 Skill 版本. + +#### Parameters + +##### id + +`string` + +##### params? + +[`SkillVersionListParams`](../interfaces/SkillVersionListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +#### Operation + +listSkillVersion + +*** + +### retrieve() + +> **retrieve**(`id`, `version`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +查询 Skill 版本. + +#### Parameters + +##### id + +`string` + +##### version + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +#### Operation + +getSkillVersion diff --git a/docs/api/forward/classes/Skills.md b/docs/api/forward/classes/Skills.md new file mode 100644 index 0000000..767d183 --- /dev/null +++ b/docs/api/forward/classes/Skills.md @@ -0,0 +1,185 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Skills + +# Class: Skills + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Skills**(`_client`): `Skills` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Skills` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### versions + +> `readonly` **versions**: [`SkillVersions`](SkillVersions.md) + +## Methods + +### create() + +> **create**(`params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +创建 Skill. + +#### Parameters + +##### params? + +[`SkillNewParams`](../interfaces/SkillNewParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +#### Operation + +createSkill + +*** + +### delete() + +> **delete**(`id`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +删除 Skill. + +#### Parameters + +##### id + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +#### Operation + +deleteSkill + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +列出 Skill. + +#### Parameters + +##### params? + +[`SkillListParams`](../interfaces/SkillListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +#### Operation + +listSkill + +*** + +### retrieve() + +> **retrieve**(`id`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +查询 Skill. + +#### Parameters + +##### id + +`string` + +##### params? + +[`SkillGetParams`](../interfaces/SkillGetParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +#### Operation + +getSkill + +*** + +### update() + +> **update**(`id`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +修改 Skill. + +#### Parameters + +##### id + +`string` + +##### params? + +[`SkillUpdateParams`](../interfaces/SkillUpdateParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +#### Operation + +updateSkill diff --git a/docs/api/forward/classes/Templates.md b/docs/api/forward/classes/Templates.md new file mode 100644 index 0000000..3b41180 --- /dev/null +++ b/docs/api/forward/classes/Templates.md @@ -0,0 +1,209 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Templates + +# Class: Templates + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Templates**(`_client`): `Templates` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Templates` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### archive() + +> **archive**(`templateID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +归档 Template. + +#### Parameters + +##### templateID + +`string` + +##### params? + +[`TemplateArchiveParams`](../interfaces/TemplateArchiveParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +#### Operation + +archiveTemplate + +*** + +### clone() + +> **clone**(`templateID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +克隆 Template. + +#### Parameters + +##### templateID + +`string` + +##### params? + +[`TemplateCloneParams`](../interfaces/TemplateCloneParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +#### Operation + +cloneTemplate + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +创建 Template. + +#### Parameters + +##### params + +[`TemplateNewParams`](../interfaces/TemplateNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +#### Operation + +createTemplate + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Template`](../interfaces/Template.md)\> + +列出 Templates. + +#### Parameters + +##### params? + +[`TemplateListParams`](../interfaces/TemplateListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Template`](../interfaces/Template.md)\> + +#### Operation + +listTemplates + +*** + +### retrieve() + +> **retrieve**(`templateID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +获取 Template. + +#### Parameters + +##### templateID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +#### Operation + +getTemplate + +*** + +### update() + +> **update**(`templateID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +更新 Template. + +#### Parameters + +##### templateID + +`string` + +##### params? + +[`TemplateUpdateParams`](../interfaces/TemplateUpdateParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Template`](../interfaces/Template.md)\> + +#### Operation + +updateTemplate diff --git a/docs/api/forward/classes/VaultCredentials.md b/docs/api/forward/classes/VaultCredentials.md new file mode 100644 index 0000000..f809afb --- /dev/null +++ b/docs/api/forward/classes/VaultCredentials.md @@ -0,0 +1,161 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / VaultCredentials + +# Class: VaultCredentials + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new VaultCredentials**(`_client`): `VaultCredentials` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`VaultCredentials` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### create() + +> **create**(`id`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`VaultCredential`](../interfaces/VaultCredential.md)\> + +创建 Credential. + +#### Parameters + +##### id + +`string` + +##### params + +[`VaultCredentialNewParams`](../interfaces/VaultCredentialNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`VaultCredential`](../interfaces/VaultCredential.md)\> + +#### Operation + +createVaultCredential + +*** + +### delete() + +> **delete**(`id`, `credID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +删除 Credential. + +#### Parameters + +##### id + +`string` + +##### credID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +#### Operation + +deleteVaultCredential + +*** + +### list() + +> **list**(`id`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`VaultCredential`](../interfaces/VaultCredential.md)\> + +列出 Credential. + +#### Parameters + +##### id + +`string` + +##### params? + +[`VaultCredentialListParams`](../interfaces/VaultCredentialListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`VaultCredential`](../interfaces/VaultCredential.md)\> + +#### Operation + +listVaultCredential + +*** + +### retrieve() + +> **retrieve**(`id`, `credID`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`VaultCredential`](../interfaces/VaultCredential.md)\> + +查询 Credential. + +#### Parameters + +##### id + +`string` + +##### credID + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`VaultCredential`](../interfaces/VaultCredential.md)\> + +#### Operation + +getVaultCredential diff --git a/docs/api/forward/classes/Vaults.md b/docs/api/forward/classes/Vaults.md new file mode 100644 index 0000000..df86ba5 --- /dev/null +++ b/docs/api/forward/classes/Vaults.md @@ -0,0 +1,151 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Vaults + +# Class: Vaults + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Vaults**(`_client`): `Vaults` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Vaults` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### credentials + +> `readonly` **credentials**: [`VaultCredentials`](VaultCredentials.md) + +## Methods + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Vault`](../interfaces/Vault.md)\> + +创建 Vault. + +#### Parameters + +##### params + +[`VaultNewParams`](../interfaces/VaultNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Vault`](../interfaces/Vault.md)\> + +#### Operation + +createVault + +*** + +### delete() + +> **delete**(`id`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +删除 Vault. + +#### Parameters + +##### id + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<`void`\> + +#### Operation + +deleteVault + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Vault`](../interfaces/Vault.md)\> + +列出 Vault. + +#### Parameters + +##### params? + +[`VaultListParams`](../interfaces/VaultListParams.md) = `{}` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Vault`](../interfaces/Vault.md)\> + +#### Operation + +listVault + +*** + +### retrieve() + +> **retrieve**(`id`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Vault`](../interfaces/Vault.md)\> + +查询 Vault. + +#### Parameters + +##### id + +`string` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Vault`](../interfaces/Vault.md)\> + +#### Operation + +getVault diff --git a/docs/api/forward/interfaces/Batch.md b/docs/api/forward/interfaces/Batch.md new file mode 100644 index 0000000..2b8421c --- /dev/null +++ b/docs/api/forward/interfaces/Batch.md @@ -0,0 +1,173 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Batch + +# Interface: Batch + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### cancelled + +> **cancelled**: `number` + +因取消而终止的行数。 + +*** + +### completed + +> **completed**: `number` + +执行成功的行数。 + +*** + +### completion\_window + +> **completion\_window**: `string` + +完成窗口：`24h`、`48h`、`72h`。 + +*** + +### created\_at + +> **created\_at**: `string` + +创建时间，RFC 3339。 + +*** + +### error\_file\_id + +> **error\_file\_id**: `string` + +失败行结果文件 ID；无失败行时省略。 + +*** + +### error\_message + +> **error\_message**: `string` + +Batch 级错误描述；仅 `failed` 状态出现。 + +*** + +### expired + +> **expired**: `number` + +因过期而终止的行数。 + +*** + +### expires\_at + +> **expires\_at**: `string` + +过期时间，`created_at` + `completion_window`。 + +*** + +### failed + +> **failed**: `number` + +永久失败的行数（含校验失败）。 + +*** + +### id + +> **id**: `string` + +Batch ID，前缀 `batch_`。 + +*** + +### input\_file\_id + +> **input\_file\_id**: `string` + +输入 JSONL 文件 ID。 + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +调用方业务元数据。 + +*** + +### object + +> **object**: `string` + +固定为 `batch`。 + +*** + +### output\_file\_id + +> **output\_file\_id**: `string` + +成功结果文件 ID；未完成或未生成时省略。 + +*** + +### pending + +> **pending**: `number` + +等待执行的行数。 + +*** + +### request\_counts + +> **request\_counts**: [`BatchRequestCounts`](BatchRequestCounts.md) + +任务计数聚合。 + +*** + +### running + +> **running**: `number` + +正在执行的行数。 + +*** + +### status + +> **status**: `string` + +Batch 状态，见状态说明。 + +*** + +### total + +> **total**: `number` + +总行数（含校验失败行）。 + +*** + +### usage + +> **usage**: [`BatchUsage`](BatchUsage.md) \| `null` + +创建响应为 `null`；后续 Batch 详情、列表和取消响应中，至少一个子任务已有合法 CAS Session 用量时返回 Credit 汇总。 diff --git a/docs/api/forward/interfaces/BatchCancelParams.md b/docs/api/forward/interfaces/BatchCancelParams.md new file mode 100644 index 0000000..2a435b3 --- /dev/null +++ b/docs/api/forward/interfaces/BatchCancelParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchCancelParams + +# Interface: BatchCancelParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/BatchFile.md b/docs/api/forward/interfaces/BatchFile.md new file mode 100644 index 0000000..df99bad --- /dev/null +++ b/docs/api/forward/interfaces/BatchFile.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchFile + +# Interface: BatchFile + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### expires\_at + +> **expires\_at**: `string` + +链接过期时间，RFC 3339，需在此之前完成下载。 + +*** + +### url + +> **url**: `string` + +OSS 预签名下载链接，含 `Expires` / `OSSAccessKeyId` / `Signature` 及 `response-content-disposition`，下载文件名为 `batch--output.jsonl`。 diff --git a/docs/api/forward/interfaces/BatchListParams.md b/docs/api/forward/interfaces/BatchListParams.md new file mode 100644 index 0000000..00d3c02 --- /dev/null +++ b/docs/api/forward/interfaces/BatchListParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchListParams + +# Interface: BatchListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### status? + +> `optional` **status?**: `string` \| `null` + +按状态过滤。 diff --git a/docs/api/forward/interfaces/BatchNewParams.md b/docs/api/forward/interfaces/BatchNewParams.md new file mode 100644 index 0000000..250b8f1 --- /dev/null +++ b/docs/api/forward/interfaces/BatchNewParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchNewParams + +# Interface: BatchNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### completion\_window + +> **completion\_window**: `string` + +完成窗口：`24h`、`48h`、`72h`。超时后 Batch 自动进入 `expired` 状态。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### input\_file\_id + +> **input\_file\_id**: `string` + +通过 Files API 上传的 JSONL 文件 ID。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +调用方业务元数据，最多 16 个 key；value 可为任意 JSON 类型；整体序列化后 ≤ 2KB，key ≤ 64 字符，且不得包含 NUL（U+0000）。 diff --git a/docs/api/forward/interfaces/BatchRequestCounts.md b/docs/api/forward/interfaces/BatchRequestCounts.md new file mode 100644 index 0000000..ed20cef --- /dev/null +++ b/docs/api/forward/interfaces/BatchRequestCounts.md @@ -0,0 +1,55 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchRequestCounts + +# Interface: BatchRequestCounts + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### cancelled + +> **cancelled**: `number` + +*** + +### completed + +> **completed**: `number` + +*** + +### expired + +> **expired**: `number` + +*** + +### failed + +> **failed**: `number` + +*** + +### pending + +> **pending**: `number` + +*** + +### running + +> **running**: `number` + +*** + +### total + +> **total**: `number` diff --git a/docs/api/forward/interfaces/BatchTask.md b/docs/api/forward/interfaces/BatchTask.md new file mode 100644 index 0000000..a7b2d12 --- /dev/null +++ b/docs/api/forward/interfaces/BatchTask.md @@ -0,0 +1,61 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchTask + +# Interface: BatchTask + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### artifacts + +> **artifacts**: [`BatchTaskArtifactsItem`](BatchTaskArtifactsItem.md)[] + +*** + +### completed\_at + +> **completed\_at**: `string` + +*** + +### custom\_id + +> **custom\_id**: `string` + +*** + +### error + +> **error**: [`BatchTaskError`](BatchTaskError.md) + +*** + +### output\_summary + +> **output\_summary**: `string` + +*** + +### started\_at + +> **started\_at**: `string` + +*** + +### status + +> **status**: `string` + +*** + +### usage + +> **usage**: [`BatchTaskUsage`](BatchTaskUsage.md) diff --git a/docs/api/forward/interfaces/BatchTaskArtifactsItem.md b/docs/api/forward/interfaces/BatchTaskArtifactsItem.md new file mode 100644 index 0000000..d9d550e --- /dev/null +++ b/docs/api/forward/interfaces/BatchTaskArtifactsItem.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchTaskArtifactsItem + +# Interface: BatchTaskArtifactsItem + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content\_type + +> **content\_type**: `string` + +*** + +### file\_id + +> **file\_id**: `string` + +*** + +### name + +> **name**: `string` + +*** + +### size + +> **size**: `number` diff --git a/docs/api/forward/interfaces/BatchTaskError.md b/docs/api/forward/interfaces/BatchTaskError.md new file mode 100644 index 0000000..e24038f --- /dev/null +++ b/docs/api/forward/interfaces/BatchTaskError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchTaskError + +# Interface: BatchTaskError + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### code + +> **code**: `string` + +*** + +### message + +> **message**: `string` diff --git a/docs/api/forward/interfaces/BatchTaskListParams.md b/docs/api/forward/interfaces/BatchTaskListParams.md new file mode 100644 index 0000000..b95ceae --- /dev/null +++ b/docs/api/forward/interfaces/BatchTaskListParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchTaskListParams + +# Interface: BatchTaskListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标，传上一页响应的 `last_id`；游标必须属于当前 Batch。 + +*** + +### custom\_id? + +> `optional` **custom\_id?**: `string` \| `null` + +按调用方任务标识精确过滤，仅支持单值；未命中返回空列表。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### status? + +> `optional` **status?**: `string` \| `null` + +按任务状态过滤：`pending`、`running`、`completed`、`failed`、`cancelled`、`expired`。 diff --git a/docs/api/forward/interfaces/BatchTaskUsage.md b/docs/api/forward/interfaces/BatchTaskUsage.md new file mode 100644 index 0000000..9759034 --- /dev/null +++ b/docs/api/forward/interfaces/BatchTaskUsage.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchTaskUsage + +# Interface: BatchTaskUsage + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### total\_credits + +> **total\_credits**: `number` diff --git a/docs/api/forward/interfaces/BatchUsage.md b/docs/api/forward/interfaces/BatchUsage.md new file mode 100644 index 0000000..f0d5332 --- /dev/null +++ b/docs/api/forward/interfaces/BatchUsage.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchUsage + +# Interface: BatchUsage + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### total\_credits + +> **total\_credits**: `number` diff --git a/docs/api/forward/interfaces/Channel.md b/docs/api/forward/interfaces/Channel.md new file mode 100644 index 0000000..a6c67c9 --- /dev/null +++ b/docs/api/forward/interfaces/Channel.md @@ -0,0 +1,99 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Channel + +# Interface: Channel + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### binding\_status + +> **binding\_status**: `string` + +`unbound`、`bound` 或 `expired`。 + +*** + +### channel\_config + +> **channel\_config**: [`ChannelChannelConfig`](ChannelChannelConfig.md) + +*** + +### channel\_type + +> **channel\_type**: `string` + +外部渠道类型。 + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### enabled + +> **enabled**: `boolean` + +人工启停开关。 + +*** + +### id + +> **id**: `string` + +Channel ID，示例前缀 `channel_`。 + +*** + +### identity\_id + +> **identity\_id**: `string` \| `null` + +`fixed` 模式为绑定的 Forward Identity ID；`pairing` 模式为 `null`。 + +*** + +### identity\_resolution + +> **identity\_resolution**: [`ChannelIdentityResolution`](ChannelIdentityResolution.md) + +*** + +### name + +> **name**: `string` + +*** + +### template\_id + +> **template\_id**: `string` \| `null` + +`fixed` 模式为绑定的 Forward Template ID；`pairing` 模式为 `null`。 + +*** + +### type + +> **type**: `string` + +固定为 `channel`。 + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/forward/interfaces/ChannelChannelConfig.md b/docs/api/forward/interfaces/ChannelChannelConfig.md new file mode 100644 index 0000000..f4d4664 --- /dev/null +++ b/docs/api/forward/interfaces/ChannelChannelConfig.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelChannelConfig + +# Interface: ChannelChannelConfig + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### response\_options + +> **response\_options**: [`ChannelChannelConfigResponseOptions`](ChannelChannelConfigResponseOptions.md) diff --git a/docs/api/forward/interfaces/ChannelChannelConfigResponseOptions.md b/docs/api/forward/interfaces/ChannelChannelConfigResponseOptions.md new file mode 100644 index 0000000..4b483e0 --- /dev/null +++ b/docs/api/forward/interfaces/ChannelChannelConfigResponseOptions.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelChannelConfigResponseOptions + +# Interface: ChannelChannelConfigResponseOptions + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### include\_thinking + +> **include\_thinking**: `boolean` + +*** + +### include\_tool\_calls + +> **include\_tool\_calls**: `boolean` diff --git a/docs/api/forward/interfaces/ChannelIdentityResolution.md b/docs/api/forward/interfaces/ChannelIdentityResolution.md new file mode 100644 index 0000000..0b43e9a --- /dev/null +++ b/docs/api/forward/interfaces/ChannelIdentityResolution.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelIdentityResolution + +# Interface: ChannelIdentityResolution + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### mode + +> **mode**: `string` diff --git a/docs/api/forward/interfaces/ChannelListParams.md b/docs/api/forward/interfaces/ChannelListParams.md new file mode 100644 index 0000000..f970a31 --- /dev/null +++ b/docs/api/forward/interfaces/ChannelListParams.md @@ -0,0 +1,77 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelListParams + +# Interface: ChannelListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标。 + +*** + +### binding\_status? + +> `optional` **binding\_status?**: `string` \| `null` + +按 `unbound`、`bound` 或 `expired` 过滤。 + +*** + +### channel\_type? + +> `optional` **channel\_type?**: `string` \| `null` + +按 `wechat`、`wecom`、`feishu`、`dingtalk` 或 `teams`（Global）过滤。 + +*** + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +按人工启停状态过滤。 + +*** + +### identity\_id? + +> `optional` **identity\_id?**: `string` \| `null` + +按 Forward Identity ID 过滤。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### template\_id? + +> `optional` **template\_id?**: `string` \| `null` + +按 Forward Template ID 过滤。 diff --git a/docs/api/forward/interfaces/ChannelNewParams.md b/docs/api/forward/interfaces/ChannelNewParams.md new file mode 100644 index 0000000..9e1e9a3 --- /dev/null +++ b/docs/api/forward/interfaces/ChannelNewParams.md @@ -0,0 +1,73 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelNewParams + +# Interface: ChannelNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### channel\_config? + +> `optional` **channel\_config?**: `Record`\<`string`, `unknown`\> \| `null` + +*** + +### channel\_type + +> **channel\_type**: `string` + +渠道类型，当前支持 `wechat`、`wecom`、`feishu`、`dingtalk` 和 `teams`（Global）。 + +*** + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +人工启停开关，默认 `true`。传 `false` 可创建后暂不处理上行消息。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### identity\_id? + +> `optional` **identity\_id?**: `string` \| `null` + +`fixed` 模式必填；`pairing` 模式不传。 + +*** + +### identity\_resolution? + +> `optional` **identity\_resolution?**: `Record`\<`string`, `unknown`\> \| `null` + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +Channel 展示名。 + +*** + +### template\_id? + +> `optional` **template\_id?**: `string` \| `null` + +`fixed` 模式必填；`pairing` 模式不传。 diff --git a/docs/api/forward/interfaces/ChannelPairing.md b/docs/api/forward/interfaces/ChannelPairing.md new file mode 100644 index 0000000..805be1c --- /dev/null +++ b/docs/api/forward/interfaces/ChannelPairing.md @@ -0,0 +1,69 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelPairing + +# Interface: ChannelPairing + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### channel\_id + +> **channel\_id**: `string` + +Channel ID。 + +*** + +### id + +> **id**: `string` + +Pairing ID，解除配对时使用。 + +*** + +### identity\_id + +> **identity\_id**: `string` + +已绑定的 Forward Identity ID。 + +*** + +### paired\_at + +> **paired\_at**: `string` + +配对完成时间。 + +*** + +### status + +> **status**: `string` + +配对成功时为 `active`。 + +*** + +### template\_id + +> **template\_id**: `string` + +已绑定的 Forward Template ID。 + +*** + +### type + +> **type**: `string` + +固定为 `channel_pairing`。 diff --git a/docs/api/forward/interfaces/ChannelPairingNewParams.md b/docs/api/forward/interfaces/ChannelPairingNewParams.md new file mode 100644 index 0000000..a54e58d --- /dev/null +++ b/docs/api/forward/interfaces/ChannelPairingNewParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelPairingNewParams + +# Interface: ChannelPairingNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### code + +> **code**: `string` + +Channel 消息中显示的 6 位配对码。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +由客户端生成的唯一幂等键，用于安全重试同一次配对请求。 + +*** + +### identity\_id + +> **identity\_id**: `string` + +要绑定的 Forward Identity ID。 + +*** + +### template\_id + +> **template\_id**: `string` + +要绑定的 Forward Template ID。 diff --git a/docs/api/forward/interfaces/ChannelQRSession.md b/docs/api/forward/interfaces/ChannelQRSession.md new file mode 100644 index 0000000..87b2893 --- /dev/null +++ b/docs/api/forward/interfaces/ChannelQRSession.md @@ -0,0 +1,85 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelQRSession + +# Interface: ChannelQRSession + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### channel\_id + +> **channel\_id**: `string` + +关联的 Channel ID。 + +*** + +### channel\_type + +> **channel\_type**: `string` + +`wechat`、`feishu`、`dingtalk` 或 `wecom`。 + +*** + +### err\_code + +> **err\_code**: `string` + +null|失败时的渠道错误码。 + +*** + +### err\_msg + +> **err\_msg**: `string` + +null|失败时的渠道错误信息。 + +*** + +### expires\_at + +> **expires\_at**: `string` + +过期时间。 + +*** + +### qr\_code\_content + +> **qr\_code\_content**: `string` + +二维码原始内容，通常是三方授权 URL。 + +*** + +### qr\_code\_image\_base64 + +> **qr\_code\_image\_base64**: `string` + +服务端生成的二维码图片。 + +*** + +### session\_key + +> **session\_key**: `string` + +用于轮询状态的不透明 QR session key。 + +*** + +### status + +> **status**: `string` + +初始状态，通常为 `waiting`。 diff --git a/docs/api/forward/interfaces/ChannelQRSessionNewParams.md b/docs/api/forward/interfaces/ChannelQRSessionNewParams.md new file mode 100644 index 0000000..dc3a07b --- /dev/null +++ b/docs/api/forward/interfaces/ChannelQRSessionNewParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelQRSessionNewParams + +# Interface: ChannelQRSessionNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/ChannelUpdateParams.md b/docs/api/forward/interfaces/ChannelUpdateParams.md new file mode 100644 index 0000000..452810d --- /dev/null +++ b/docs/api/forward/interfaces/ChannelUpdateParams.md @@ -0,0 +1,59 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelUpdateParams + +# Interface: ChannelUpdateParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### channel\_config? + +> `optional` **channel\_config?**: `Record`\<`string`, `unknown`\> \| `null` + +*** + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +人工启停开关。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### identity\_id? + +> `optional` **identity\_id?**: `string` \| `null` + +`fixed` 模式下新的 Forward Identity ID。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +Channel 展示名。 + +*** + +### template\_id? + +> `optional` **template\_id?**: `string` \| `null` + +`fixed` 模式下新的 Forward Template ID。 diff --git a/docs/api/forward/interfaces/ContentBlock.md b/docs/api/forward/interfaces/ContentBlock.md new file mode 100644 index 0000000..27add1e --- /dev/null +++ b/docs/api/forward/interfaces/ContentBlock.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ContentBlock + +# Interface: ContentBlock + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### source + +> **source**: [`ImageSource`](ImageSource.md) + +*** + +### text + +> **text**: `string` + +*** + +### thinking + +> **thinking**: `string` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/ContentBlockParam.md b/docs/api/forward/interfaces/ContentBlockParam.md new file mode 100644 index 0000000..0dd0723 --- /dev/null +++ b/docs/api/forward/interfaces/ContentBlockParam.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ContentBlockParam + +# Interface: ContentBlockParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### source? + +> `optional` **source?**: [`ImageSourceParam`](ImageSourceParam.md) \| `null` + +*** + +### text? + +> `optional` **text?**: `string` \| `null` + +*** + +### thinking? + +> `optional` **thinking?**: `string` \| `null` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/DeletedChannel.md b/docs/api/forward/interfaces/DeletedChannel.md new file mode 100644 index 0000000..a922a60 --- /dev/null +++ b/docs/api/forward/interfaces/DeletedChannel.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / DeletedChannel + +# Interface: DeletedChannel + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### deleted + +> **deleted**: `boolean` + +是否删除成功，成功时恒为 `true`。 + +*** + +### id + +> **id**: `string` + +被删除的 Channel ID。 diff --git a/docs/api/forward/interfaces/DeletedChannelPairing.md b/docs/api/forward/interfaces/DeletedChannelPairing.md new file mode 100644 index 0000000..142142b --- /dev/null +++ b/docs/api/forward/interfaces/DeletedChannelPairing.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / DeletedChannelPairing + +# Interface: DeletedChannelPairing + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### deleted + +> **deleted**: `boolean` + +是否已解除，成功时为 `true`。 + +*** + +### id + +> **id**: `string` + +Pairing ID。 diff --git a/docs/api/forward/interfaces/DeletedIdentity.md b/docs/api/forward/interfaces/DeletedIdentity.md new file mode 100644 index 0000000..5ff43f5 --- /dev/null +++ b/docs/api/forward/interfaces/DeletedIdentity.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / DeletedIdentity + +# Interface: DeletedIdentity + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### deleted + +> **deleted**: `boolean` + +是否已完成删除。成功响应为 `true`。 + +*** + +### id + +> **id**: `string` + +被删除的 Identity ID。 diff --git a/docs/api/forward/interfaces/DeletedMemory.md b/docs/api/forward/interfaces/DeletedMemory.md new file mode 100644 index 0000000..47f3e25 --- /dev/null +++ b/docs/api/forward/interfaces/DeletedMemory.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / DeletedMemory + +# Interface: DeletedMemory + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### deleted + +> **deleted**: `boolean` + +是否已删除。 + +*** + +### id + +> **id**: `string` + +被删除的 Memory ID。 + +*** + +### type + +> **type**: `string` + +固定为 `memory_deleted`。 diff --git a/docs/api/forward/interfaces/DeletedMemoryStore.md b/docs/api/forward/interfaces/DeletedMemoryStore.md new file mode 100644 index 0000000..9dae03a --- /dev/null +++ b/docs/api/forward/interfaces/DeletedMemoryStore.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / DeletedMemoryStore + +# Interface: DeletedMemoryStore + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### deleted + +> **deleted**: `boolean` + +是否已删除。 + +*** + +### id + +> **id**: `string` + +被删除的 Memory Store ID。 + +*** + +### type + +> **type**: `string` + +固定为 `memory_store_deleted`。 diff --git a/docs/api/forward/interfaces/DeletedMemoryStoreMount.md b/docs/api/forward/interfaces/DeletedMemoryStoreMount.md new file mode 100644 index 0000000..9ea43c9 --- /dev/null +++ b/docs/api/forward/interfaces/DeletedMemoryStoreMount.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / DeletedMemoryStoreMount + +# Interface: DeletedMemoryStoreMount + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### deleted + +> **deleted**: `boolean` + +挂载关系是否已解除。 + +*** + +### id + +> **id**: `string` + +被解绑的 Memory Store ID。 + +*** + +### type + +> **type**: `string` + +固定为 `memory_store_binding_deleted`。与删除 Store 的 `memory_store_deleted` 区分：本接口只解除挂载关系，Store 本体仍然存在。 diff --git a/docs/api/forward/interfaces/DeletedSkillVersion.md b/docs/api/forward/interfaces/DeletedSkillVersion.md new file mode 100644 index 0000000..eec97c2 --- /dev/null +++ b/docs/api/forward/interfaces/DeletedSkillVersion.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / DeletedSkillVersion + +# Interface: DeletedSkillVersion + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### deleted + +> **deleted**: `boolean` + +固定值 `true` + +*** + +### id + +> **id**: `string` + +被删除的版本号。 + +*** + +### type + +> **type**: `string` + +固定值 `"skill_version_deleted"` diff --git a/docs/api/forward/interfaces/EffectiveConfig.md b/docs/api/forward/interfaces/EffectiveConfig.md new file mode 100644 index 0000000..47d7229 --- /dev/null +++ b/docs/api/forward/interfaces/EffectiveConfig.md @@ -0,0 +1,79 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EffectiveConfig + +# Interface: EffectiveConfig + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### agent + +> **agent**: [`EffectiveConfigAgent`](EffectiveConfigAgent.md) + +编译后的 Agent 配置。 + +*** + +### agent\_effective\_hash + +> **agent\_effective\_hash**: `string` + +Agent 部分编译结果 hash。 + +*** + +### effective\_hash + +> **effective\_hash**: `string` + +完整有效配置 hash。 + +*** + +### id + +> **id**: `string` + +*** + +### identity\_id + +> **identity\_id**: `string` + +*** + +### session + +> **session**: [`EffectiveConfigSession`](EffectiveConfigSession.md) + +编译后的 Session 默认配置。 + +*** + +### session\_effective\_hash + +> **session\_effective\_hash**: `string` + +Session 部分编译结果 hash。 + +*** + +### template\_id + +> **template\_id**: `string` + +*** + +### type + +> **type**: `string` + +固定为 `effective_spec`。 diff --git a/docs/api/forward/interfaces/EffectiveConfigAgent.md b/docs/api/forward/interfaces/EffectiveConfigAgent.md new file mode 100644 index 0000000..fc2a3aa --- /dev/null +++ b/docs/api/forward/interfaces/EffectiveConfigAgent.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EffectiveConfigAgent + +# Interface: EffectiveConfigAgent + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### mcp\_servers + +> **mcp\_servers**: `Record`\<`string`, `unknown`\>[] + +*** + +### model + +> **model**: [`ModelConfig`](../type-aliases/ModelConfig.md) + +*** + +### skills + +> **skills**: `Record`\<`string`, `unknown`\>[] + +*** + +### system + +> **system**: `string` + +*** + +### tools + +> **tools**: [`EffectiveConfigAgentToolsItem`](EffectiveConfigAgentToolsItem.md)[] diff --git a/docs/api/forward/interfaces/EffectiveConfigAgentToolsItem.md b/docs/api/forward/interfaces/EffectiveConfigAgentToolsItem.md new file mode 100644 index 0000000..4dc0f4e --- /dev/null +++ b/docs/api/forward/interfaces/EffectiveConfigAgentToolsItem.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EffectiveConfigAgentToolsItem + +# Interface: EffectiveConfigAgentToolsItem + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### configs + +> **configs**: [`EffectiveConfigAgentToolsItemConfigsItem`](EffectiveConfigAgentToolsItemConfigsItem.md)[] + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/EffectiveConfigAgentToolsItemConfigsItem.md b/docs/api/forward/interfaces/EffectiveConfigAgentToolsItemConfigsItem.md new file mode 100644 index 0000000..67fa4a5 --- /dev/null +++ b/docs/api/forward/interfaces/EffectiveConfigAgentToolsItemConfigsItem.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EffectiveConfigAgentToolsItemConfigsItem + +# Interface: EffectiveConfigAgentToolsItemConfigsItem + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### name + +> **name**: `string` diff --git a/docs/api/forward/interfaces/EffectiveConfigSession.md b/docs/api/forward/interfaces/EffectiveConfigSession.md new file mode 100644 index 0000000..61ede5f --- /dev/null +++ b/docs/api/forward/interfaces/EffectiveConfigSession.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EffectiveConfigSession + +# Interface: EffectiveConfigSession + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### environment\_id + +> **environment\_id**: `string` + +*** + +### environment\_variables + +> **environment\_variables**: `Record`\<`string`, `string`\> + +*** + +### resources + +> **resources**: [`EffectiveConfigSessionResourcesItem`](EffectiveConfigSessionResourcesItem.md)[] + +*** + +### vault\_ids + +> **vault\_ids**: `string`[] diff --git a/docs/api/forward/interfaces/EffectiveConfigSessionResourcesItem.md b/docs/api/forward/interfaces/EffectiveConfigSessionResourcesItem.md new file mode 100644 index 0000000..de412f2 --- /dev/null +++ b/docs/api/forward/interfaces/EffectiveConfigSessionResourcesItem.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EffectiveConfigSessionResourcesItem + +# Interface: EffectiveConfigSessionResourcesItem + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### file\_id + +> **file\_id**: `string` + +*** + +### mount\_path + +> **mount\_path**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### url + +> **url**: `string` diff --git a/docs/api/forward/interfaces/Environment.md b/docs/api/forward/interfaces/Environment.md new file mode 100644 index 0000000..5dbf4e5 --- /dev/null +++ b/docs/api/forward/interfaces/Environment.md @@ -0,0 +1,73 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Environment + +# Interface: Environment + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### archived\_at + +> **archived\_at**: `string` \| `null` + +*** + +### config + +> **config**: [`EnvironmentConfig`](EnvironmentConfig.md) + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### description + +> **description**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### identity\_id + +> **identity\_id**: `string` \| `null` + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +*** + +### name + +> **name**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/forward/interfaces/EnvironmentConfig.md b/docs/api/forward/interfaces/EnvironmentConfig.md new file mode 100644 index 0000000..d7da122 --- /dev/null +++ b/docs/api/forward/interfaces/EnvironmentConfig.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EnvironmentConfig + +# Interface: EnvironmentConfig + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### packages + +> **packages**: [`EnvironmentConfigPackages`](EnvironmentConfigPackages.md) + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/EnvironmentConfigPackages.md b/docs/api/forward/interfaces/EnvironmentConfigPackages.md new file mode 100644 index 0000000..1d663f7 --- /dev/null +++ b/docs/api/forward/interfaces/EnvironmentConfigPackages.md @@ -0,0 +1,55 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EnvironmentConfigPackages + +# Interface: EnvironmentConfigPackages + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### apt + +> **apt**: `string`[] + +*** + +### cargo + +> **cargo**: `string`[] + +*** + +### gem + +> **gem**: `string`[] + +*** + +### go + +> **go**: `string`[] + +*** + +### npm + +> **npm**: `string`[] + +*** + +### pip + +> **pip**: `string`[] + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/EnvironmentListParams.md b/docs/api/forward/interfaces/EnvironmentListParams.md new file mode 100644 index 0000000..cb7aea7 --- /dev/null +++ b/docs/api/forward/interfaces/EnvironmentListParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EnvironmentListParams + +# Interface: EnvironmentListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标；与 `page`、`before_id` 互斥。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标；与 `page`、`after_id` 互斥。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### page? + +> `optional` **page?**: `string` \| `null` + +分页游标（推荐使用），取值来自上一页响应的 `next_page`；与 `after_id`、`before_id` 互斥。 diff --git a/docs/api/forward/interfaces/EnvironmentNewParams.md b/docs/api/forward/interfaces/EnvironmentNewParams.md new file mode 100644 index 0000000..df27262 --- /dev/null +++ b/docs/api/forward/interfaces/EnvironmentNewParams.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EnvironmentNewParams + +# Interface: EnvironmentNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### config? + +> `optional` **config?**: `Record`\<`string`, `unknown`\> \| `null` + +Environment 运行时配置对象；省略时默认使用 `{"type":"cloud"}`。显式传入时不能为 `null` 或空对象。字段详见 schemas。 + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +描述。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +建议创建请求携带。相同 key 和相同请求可安全重试。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +[Environment metadata](./schemas.md#environment-metadata)；省略时为 `{}`，显式传入时不能为 `null`。 + +*** + +### name + +> **name**: `string` + +Environment 名称；去除首尾空白后不能为空。 diff --git a/docs/api/forward/interfaces/EnvironmentUpdateParams.md b/docs/api/forward/interfaces/EnvironmentUpdateParams.md new file mode 100644 index 0000000..69ebaac --- /dev/null +++ b/docs/api/forward/interfaces/EnvironmentUpdateParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EnvironmentUpdateParams + +# Interface: EnvironmentUpdateParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### config? + +> `optional` **config?**: `Record`\<`string`, `unknown`\> \| `null` + +新配置；传入时不能为 `null`，显式 `null` 返回 400。字段详见 schemas。 + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +新描述。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +要合并的 [Environment metadata](./schemas.md#environment-metadata)；传入时不能为 `null`，显式 `null` 返回 400。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +新名称。 diff --git a/docs/api/forward/interfaces/EnvironmentVariableOverride.md b/docs/api/forward/interfaces/EnvironmentVariableOverride.md new file mode 100644 index 0000000..d18babd --- /dev/null +++ b/docs/api/forward/interfaces/EnvironmentVariableOverride.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EnvironmentVariableOverride + +# Interface: EnvironmentVariableOverride + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### op + +> **op**: `string` + +*** + +### value + +> **value**: `string` diff --git a/docs/api/forward/interfaces/EnvironmentVariableOverrideParam.md b/docs/api/forward/interfaces/EnvironmentVariableOverrideParam.md new file mode 100644 index 0000000..13bfb79 --- /dev/null +++ b/docs/api/forward/interfaces/EnvironmentVariableOverrideParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EnvironmentVariableOverrideParam + +# Interface: EnvironmentVariableOverrideParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### op + +> **op**: `string` + +*** + +### value? + +> `optional` **value?**: `string` \| `null` diff --git a/docs/api/forward/interfaces/FileListParams.md b/docs/api/forward/interfaces/FileListParams.md new file mode 100644 index 0000000..3ab8471 --- /dev/null +++ b/docs/api/forward/interfaces/FileListParams.md @@ -0,0 +1,61 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / FileListParams + +# Interface: FileListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标；与 `page`、`before_id` 互斥。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标；与 `page`、`after_id` 互斥。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +按文件名搜索。 + +*** + +### page? + +> `optional` **page?**: `string` \| `null` + +分页游标（推荐使用），取值来自上一页响应的 `next_page`；与 `after_id`、`before_id` 互斥。 + +*** + +### scope\_id? + +> `optional` **scope\_id?**: `string` \| `null` + +按资源作用域 ID 过滤，常用于 Session 资源文件查询。传入时不要同时使用 `before_id` 或 `after_id`；当前游标参数在该过滤模式下不生效。 diff --git a/docs/api/forward/interfaces/FileMetadata.md b/docs/api/forward/interfaces/FileMetadata.md new file mode 100644 index 0000000..3ed5e05 --- /dev/null +++ b/docs/api/forward/interfaces/FileMetadata.md @@ -0,0 +1,101 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / FileMetadata + +# Interface: FileMetadata + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### created\_at + +> **created\_at**: `string` + +创建时间，RFC 3339 格式。 + +*** + +### downloadable + +> **downloadable**: `boolean` + +是否可下载。 + +*** + +### filename + +> **filename**: `string` + +文件名。 + +*** + +### id + +> **id**: `string` + +File ID。 + +*** + +### identity\_id + +> **identity\_id**: `string` \| `null` + +Forward 归属身份。 + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +文件元数据。 + +*** + +### mime\_type + +> **mime\_type**: `string` + +MIME 类型。 + +*** + +### scope + +> **scope**: `Record`\<`string`, `unknown`\> \| `null` + +文件关联的资源作用域，如 Session。 + +*** + +### size\_bytes + +> **size\_bytes**: `number` + +文件大小，单位为 byte。 + +*** + +### type + +> **type**: `string` + +固定为 `file`。 + +*** + +### updated\_at + +> **updated\_at**: `string` + +最后更新时间，RFC 3339 格式。 diff --git a/docs/api/forward/interfaces/FileUploadParams.md b/docs/api/forward/interfaces/FileUploadParams.md new file mode 100644 index 0000000..8ddeef7 --- /dev/null +++ b/docs/api/forward/interfaces/FileUploadParams.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / FileUploadParams + +# Interface: FileUploadParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### file + +> **file**: [`Uploadable`](../../index/type-aliases/Uploadable.md) + +待上传文件内容。支持类型见[支持上传的文件类型](./schemas.md#支持上传的文件类型)。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +可选创建请求幂等键。传入时相同 key 只能用于相同请求；不传时不提供本地幂等重放保护。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +元数据对象；`created_by` 为保留字段，不可传入（传入返回 400）。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +文件展示名，未传时使用 multipart 文件名；规范化后长度为 1-255 bytes。 + +*** + +### purpose? + +> `optional` **purpose?**: `string` \| `null` + +文件用途，默认 `user_upload`；作为 Batch 输入文件时必须传 `session_resource`。 diff --git a/docs/api/forward/interfaces/GitHubRepository.md b/docs/api/forward/interfaces/GitHubRepository.md new file mode 100644 index 0000000..50ca00c --- /dev/null +++ b/docs/api/forward/interfaces/GitHubRepository.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / GitHubRepository + +# Interface: GitHubRepository + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### mount\_path + +> **mount\_path**: `string` + +*** + +### url + +> **url**: `string` diff --git a/docs/api/forward/interfaces/GitHubRepositoryParam.md b/docs/api/forward/interfaces/GitHubRepositoryParam.md new file mode 100644 index 0000000..95ab1ed --- /dev/null +++ b/docs/api/forward/interfaces/GitHubRepositoryParam.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / GitHubRepositoryParam + +# Interface: GitHubRepositoryParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### authorization\_token? + +> `optional` **authorization\_token?**: `string` \| `null` + +*** + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +*** + +### mount\_path? + +> `optional` **mount\_path?**: `string` \| `null` + +*** + +### url? + +> `optional` **url?**: `string` \| `null` diff --git a/docs/api/forward/interfaces/Identity.md b/docs/api/forward/interfaces/Identity.md new file mode 100644 index 0000000..3bde833 --- /dev/null +++ b/docs/api/forward/interfaces/Identity.md @@ -0,0 +1,77 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Identity + +# Interface: Identity + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### created\_at + +> **created\_at**: `string` + +创建时间，RFC 3339 格式。 + +*** + +### enabled + +> **enabled**: `boolean` + +是否允许继续使用该 Identity。 + +*** + +### external\_id + +> **external\_id**: `string` + +集成方系统中的终端用户 ID。 + +*** + +### id + +> **id**: `string` + +Forward Identity ID，建议前缀 `idn_`。 + +*** + +### identity\_type + +> **identity\_type**: `string` + +Identity 类型。普通 Identity 返回 `normal`。 + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +业务元数据。 + +*** + +### name + +> **name**: `string` + +Identity 展示名。 + +*** + +### updated\_at + +> **updated\_at**: `string` + +最近更新时间，RFC 3339 格式。 diff --git a/docs/api/forward/interfaces/IdentityClearParams.md b/docs/api/forward/interfaces/IdentityClearParams.md new file mode 100644 index 0000000..fdd46c2 --- /dev/null +++ b/docs/api/forward/interfaces/IdentityClearParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityClearParams + +# Interface: IdentityClearParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### reason? + +> `optional` **reason?**: `string` \| `null` + +清理原因，仅用于记录调用意图。 diff --git a/docs/api/forward/interfaces/IdentityClearResponse.md b/docs/api/forward/interfaces/IdentityClearResponse.md new file mode 100644 index 0000000..e1a8c4f --- /dev/null +++ b/docs/api/forward/interfaces/IdentityClearResponse.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityClearResponse + +# Interface: IdentityClearResponse + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### completed\_at + +> **completed\_at**: `string` + +Forward 侧清理完成时间，使用 RFC 3339 格式。 + +*** + +### identity\_id + +> **identity\_id**: `string` + +被清理的 Identity ID。 + +*** + +### status + +> **status**: `string` + +清理状态，成功时为 `completed`。 + +*** + +### summary + +> **summary**: [`IdentityClearResponseSummary`](IdentityClearResponseSummary.md) diff --git a/docs/api/forward/interfaces/IdentityClearResponseSummary.md b/docs/api/forward/interfaces/IdentityClearResponseSummary.md new file mode 100644 index 0000000..ee74d56 --- /dev/null +++ b/docs/api/forward/interfaces/IdentityClearResponseSummary.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityClearResponseSummary + +# Interface: IdentityClearResponseSummary + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### identity\_configs\_archived + +> **identity\_configs\_archived**: `number` + +*** + +### identity\_owned\_resources\_archived + +> **identity\_owned\_resources\_archived**: `number` + +*** + +### resource\_bindings\_archived + +> **resource\_bindings\_archived**: `number` + +*** + +### schedule\_runs\_skipped + +> **schedule\_runs\_skipped**: `number` + +*** + +### schedules\_archived + +> **schedules\_archived**: `number` + +*** + +### sessions\_archived + +> **sessions\_archived**: `number` diff --git a/docs/api/forward/interfaces/IdentityConfig.md b/docs/api/forward/interfaces/IdentityConfig.md new file mode 100644 index 0000000..3f7467f --- /dev/null +++ b/docs/api/forward/interfaces/IdentityConfig.md @@ -0,0 +1,89 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityConfig + +# Interface: IdentityConfig + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### created\_at + +> **created\_at**: `string` + +*** + +### effective\_hash + +> **effective\_hash**: `string` + +编译后的 Effective Config hash。 + +*** + +### id + +> **id**: `string` + +*** + +### identity\_config + +> **identity\_config**: [`IdentityConfigSpec`](IdentityConfigSpec.md) + +*** + +### identity\_id + +> **identity\_id**: `string` + +Forward Identity ID。 + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +业务元数据。 + +*** + +### name + +> **name**: `string` + +*** + +### status + +> **status**: `string` + +*** + +### template\_id + +> **template\_id**: `string` + +Forward Template ID。 + +*** + +### type + +> **type**: `string` + +固定为 `config`。 + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/forward/interfaces/IdentityConfigListParams.md b/docs/api/forward/interfaces/IdentityConfigListParams.md new file mode 100644 index 0000000..db07e73 --- /dev/null +++ b/docs/api/forward/interfaces/IdentityConfigListParams.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityConfigListParams + +# Interface: IdentityConfigListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +来自上一页响应 `last_id` 的向后游标。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +来自上一页响应 `first_id` 的向前游标。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### status? + +> `optional` **status?**: `string` \| `null` + +按 `active` 或 `archived` 过滤。 + +*** + +### template\_id? + +> `optional` **template\_id?**: `string` \| `null` + +按 Forward Template ID 过滤。 diff --git a/docs/api/forward/interfaces/IdentityConfigSpec.md b/docs/api/forward/interfaces/IdentityConfigSpec.md new file mode 100644 index 0000000..8814053 --- /dev/null +++ b/docs/api/forward/interfaces/IdentityConfigSpec.md @@ -0,0 +1,79 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityConfigSpec + +# Interface: IdentityConfigSpec + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### agent\_metadata + +> **agent\_metadata**: `Record`\<`string`, `unknown`\> + +*** + +### environment\_variables + +> **environment\_variables**: `Record`\<`string`, [`EnvironmentVariableOverride`](EnvironmentVariableOverride.md)\> + +*** + +### files + +> **files**: `Record`\<`string`, [`ResourceBinding`](ResourceBinding.md)\> + +*** + +### github\_repositories + +> **github\_repositories**: `Record`\<`string`, [`GitHubRepository`](GitHubRepository.md)\> + +*** + +### mcp\_servers + +> **mcp\_servers**: `Record`\<`string`, [`MCPServerOverride`](MCPServerOverride.md)\> + +*** + +### model + +> **model**: [`ModelConfig`](../type-aliases/ModelConfig.md) + +*** + +### skills + +> **skills**: `Record`\<`string`, [`SkillOverride`](SkillOverride.md)\> + +*** + +### system + +> **system**: [`SystemOverride`](SystemOverride.md) + +*** + +### tools + +> **tools**: `Record`\<`string`, [`ToolOverride`](ToolOverride.md)\> + +*** + +### toolsets + +> **toolsets**: `Record`\<`string`, `unknown`\> + +*** + +### vaults + +> **vaults**: `Record`\<`string`, [`ResourceBinding`](ResourceBinding.md)\> diff --git a/docs/api/forward/interfaces/IdentityConfigSpecParam.md b/docs/api/forward/interfaces/IdentityConfigSpecParam.md new file mode 100644 index 0000000..10ca89e --- /dev/null +++ b/docs/api/forward/interfaces/IdentityConfigSpecParam.md @@ -0,0 +1,79 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityConfigSpecParam + +# Interface: IdentityConfigSpecParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### agent\_metadata? + +> `optional` **agent\_metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +*** + +### environment\_variables? + +> `optional` **environment\_variables?**: `Record`\<`string`, [`EnvironmentVariableOverrideParam`](EnvironmentVariableOverrideParam.md)\> \| `null` + +*** + +### files? + +> `optional` **files?**: `Record`\<`string`, [`ResourceBindingParam`](ResourceBindingParam.md)\> \| `null` + +*** + +### github\_repositories? + +> `optional` **github\_repositories?**: `Record`\<`string`, [`GitHubRepositoryParam`](GitHubRepositoryParam.md)\> \| `null` + +*** + +### mcp\_servers? + +> `optional` **mcp\_servers?**: `Record`\<`string`, [`MCPServerOverrideParam`](MCPServerOverrideParam.md)\> \| `null` + +*** + +### model? + +> `optional` **model?**: [`ModelConfigUnionParam`](../type-aliases/ModelConfigUnionParam.md) + +*** + +### skills? + +> `optional` **skills?**: `Record`\<`string`, [`SkillOverrideParam`](SkillOverrideParam.md)\> \| `null` + +*** + +### system? + +> `optional` **system?**: [`SystemOverrideParam`](SystemOverrideParam.md) \| `null` + +*** + +### tools? + +> `optional` **tools?**: `Record`\<`string`, [`ToolOverrideParam`](ToolOverrideParam.md)\> \| `null` + +*** + +### toolsets? + +> `optional` **toolsets?**: `Record`\<`string`, `unknown`\> \| `null` + +*** + +### vaults? + +> `optional` **vaults?**: `Record`\<`string`, [`ResourceBindingParam`](ResourceBindingParam.md)\> \| `null` diff --git a/docs/api/forward/interfaces/IdentityConfigUpsertParams.md b/docs/api/forward/interfaces/IdentityConfigUpsertParams.md new file mode 100644 index 0000000..3e3bbdd --- /dev/null +++ b/docs/api/forward/interfaces/IdentityConfigUpsertParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityConfigUpsertParams + +# Interface: IdentityConfigUpsertParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### identity\_config + +> **identity\_config**: [`IdentityConfigSpecParam`](IdentityConfigSpecParam.md) + +用户级覆盖配置。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +业务元数据；传入时整体替换已有 metadata。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +Config 展示名。 diff --git a/docs/api/forward/interfaces/IdentityListParams.md b/docs/api/forward/interfaces/IdentityListParams.md new file mode 100644 index 0000000..f17b444 --- /dev/null +++ b/docs/api/forward/interfaces/IdentityListParams.md @@ -0,0 +1,69 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityListParams + +# Interface: IdentityListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标，不能与 `before_id` 同用。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标，不能与 `after_id` 同用。 + +*** + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +按是否启用过滤；非布尔值返回 400。 + +*** + +### external\_id? + +> `optional` **external\_id?**: `string` \| `null` + +按集成方终端用户 ID 过滤。 + +*** + +### identity\_ids? + +> `optional` **identity\_ids?**: `string`[] \| `null` + +按多个 Identity ID 过滤；支持逗号分隔或重复 query 参数，去重后最多 100 个。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100；超过上限时按最大值处理。 + +*** + +### search? + +> `optional` **search?**: `string` \| `null` + +匹配 Identity ID、名称或外部 ID。 diff --git a/docs/api/forward/interfaces/IdentityListTemplatesResponse.md b/docs/api/forward/interfaces/IdentityListTemplatesResponse.md new file mode 100644 index 0000000..b9c29e8 --- /dev/null +++ b/docs/api/forward/interfaces/IdentityListTemplatesResponse.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityListTemplatesResponse + +# Interface: IdentityListTemplatesResponse + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### data + +> **data**: [`IdentityTemplate`](IdentityTemplate.md)[] diff --git a/docs/api/forward/interfaces/IdentityMemoryStoreListResponse.md b/docs/api/forward/interfaces/IdentityMemoryStoreListResponse.md new file mode 100644 index 0000000..aa6a453 --- /dev/null +++ b/docs/api/forward/interfaces/IdentityMemoryStoreListResponse.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityMemoryStoreListResponse + +# Interface: IdentityMemoryStoreListResponse + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### data + +> **data**: [`MemoryStoreMount`](MemoryStoreMount.md)[] + +*** + +### has\_more + +> **has\_more**: `boolean` diff --git a/docs/api/forward/interfaces/IdentityMemoryStoreMountParams.md b/docs/api/forward/interfaces/IdentityMemoryStoreMountParams.md new file mode 100644 index 0000000..6f26ed7 --- /dev/null +++ b/docs/api/forward/interfaces/IdentityMemoryStoreMountParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityMemoryStoreMountParams + +# Interface: IdentityMemoryStoreMountParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +要挂载的 Memory Store ID（`memstore_...`）。必须是当前调用方可见的 active Store。 diff --git a/docs/api/forward/interfaces/IdentityNewParams.md b/docs/api/forward/interfaces/IdentityNewParams.md new file mode 100644 index 0000000..1e1d80b --- /dev/null +++ b/docs/api/forward/interfaces/IdentityNewParams.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityNewParams + +# Interface: IdentityNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +是否启用该 Identity，默认 `true`。 + +*** + +### external\_id + +> **external\_id**: `string` + +集成方系统中的终端用户 ID，不能是空串或纯空白。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +业务元数据，建议最多 16 个 key。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +展示名，传入时不能是空串或纯空白。 diff --git a/docs/api/forward/interfaces/IdentityStats.md b/docs/api/forward/interfaces/IdentityStats.md new file mode 100644 index 0000000..bd7d407 --- /dev/null +++ b/docs/api/forward/interfaces/IdentityStats.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityStats + +# Interface: IdentityStats + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### active\_identities + +> **active\_identities**: `number` + +最近活跃的 Identity 数量。 + +*** + +### total\_agents + +> **total\_agents**: `number` + +当前账号使用过的 Template 总数。 + +*** + +### total\_identities + +> **total\_identities**: `number` + +当前账号的 Identity 总数。 + +*** + +### total\_sessions + +> **total\_sessions**: `number` + +当前账号的 Session 总数。 diff --git a/docs/api/forward/interfaces/IdentityTemplate.md b/docs/api/forward/interfaces/IdentityTemplate.md new file mode 100644 index 0000000..912b7fb --- /dev/null +++ b/docs/api/forward/interfaces/IdentityTemplate.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityTemplate + +# Interface: IdentityTemplate + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### last\_active\_at + +> **last\_active\_at**: `string` + +*** + +### session\_count + +> **session\_count**: `number` + +*** + +### template\_id + +> **template\_id**: `string` + +*** + +### template\_name + +> **template\_name**: `string` diff --git a/docs/api/forward/interfaces/IdentityUpdateParams.md b/docs/api/forward/interfaces/IdentityUpdateParams.md new file mode 100644 index 0000000..6f3d5ca --- /dev/null +++ b/docs/api/forward/interfaces/IdentityUpdateParams.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityUpdateParams + +# Interface: IdentityUpdateParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +更新 Identity 是否可用。 + +*** + +### external\_id? + +> `optional` **external\_id?**: `string` \| `null` + +替换原有终端用户 ID。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +合并更新业务元数据；空字符串 value 删除对应 key。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +替换展示名。 diff --git a/docs/api/forward/interfaces/ImageSource.md b/docs/api/forward/interfaces/ImageSource.md new file mode 100644 index 0000000..b134e63 --- /dev/null +++ b/docs/api/forward/interfaces/ImageSource.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ImageSource + +# Interface: ImageSource + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### data + +> **data**: `string` + +*** + +### file\_id + +> **file\_id**: `string` + +*** + +### media\_type + +> **media\_type**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### url + +> **url**: `string` diff --git a/docs/api/forward/interfaces/ImageSourceParam.md b/docs/api/forward/interfaces/ImageSourceParam.md new file mode 100644 index 0000000..fd186c4 --- /dev/null +++ b/docs/api/forward/interfaces/ImageSourceParam.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ImageSourceParam + +# Interface: ImageSourceParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### data? + +> `optional` **data?**: `string` \| `null` + +*** + +### file\_id? + +> `optional` **file\_id?**: `string` \| `null` + +*** + +### media\_type? + +> `optional` **media\_type?**: `string` \| `null` + +*** + +### type + +> **type**: `string` + +*** + +### url? + +> `optional` **url?**: `string` \| `null` diff --git a/docs/api/forward/interfaces/MCPServer.md b/docs/api/forward/interfaces/MCPServer.md new file mode 100644 index 0000000..d53a41d --- /dev/null +++ b/docs/api/forward/interfaces/MCPServer.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MCPServer + +# Interface: MCPServer + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### name + +> **name**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### url + +> **url**: `string` diff --git a/docs/api/forward/interfaces/MCPServerOverride.md b/docs/api/forward/interfaces/MCPServerOverride.md new file mode 100644 index 0000000..05bac05 --- /dev/null +++ b/docs/api/forward/interfaces/MCPServerOverride.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MCPServerOverride + +# Interface: MCPServerOverride + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### type + +> **type**: `string` + +*** + +### url + +> **url**: `string` diff --git a/docs/api/forward/interfaces/MCPServerOverrideParam.md b/docs/api/forward/interfaces/MCPServerOverrideParam.md new file mode 100644 index 0000000..52fa274 --- /dev/null +++ b/docs/api/forward/interfaces/MCPServerOverrideParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MCPServerOverrideParam + +# Interface: MCPServerOverrideParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +*** + +### type? + +> `optional` **type?**: `string` \| `null` + +*** + +### url? + +> `optional` **url?**: `string` \| `null` diff --git a/docs/api/forward/interfaces/MCPServerParam.md b/docs/api/forward/interfaces/MCPServerParam.md new file mode 100644 index 0000000..13e0d3f --- /dev/null +++ b/docs/api/forward/interfaces/MCPServerParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MCPServerParam + +# Interface: MCPServerParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### name + +> **name**: `string` + +*** + +### type? + +> `optional` **type?**: `string` \| `null` + +*** + +### url + +> **url**: `string` diff --git a/docs/api/forward/interfaces/Memory.md b/docs/api/forward/interfaces/Memory.md new file mode 100644 index 0000000..24e1477 --- /dev/null +++ b/docs/api/forward/interfaces/Memory.md @@ -0,0 +1,73 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Memory + +# Interface: Memory + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content + +> **content**: `string` + +*** + +### content\_sha256 + +> **content\_sha256**: `string` + +*** + +### content\_size\_bytes + +> **content\_size\_bytes**: `number` + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +*** + +### path + +> **path**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/forward/interfaces/MemoryStore.md b/docs/api/forward/interfaces/MemoryStore.md new file mode 100644 index 0000000..bf720e9 --- /dev/null +++ b/docs/api/forward/interfaces/MemoryStore.md @@ -0,0 +1,97 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStore + +# Interface: MemoryStore + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### archived\_at + +> **archived\_at**: `string` \| `null` + +*** + +### binding\_info + +> **binding\_info**: `Record`\<`string`, `number`\> + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### description + +> **description**: `string` + +*** + +### entry\_count + +> **entry\_count**: `number` + +*** + +### id + +> **id**: `string` + +*** + +### identity\_id + +> **identity\_id**: `string` \| `null` + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +*** + +### name + +> **name**: `string` + +*** + +### status + +> **status**: `string` + +*** + +### system\_managed + +> **system\_managed**: `boolean` + +*** + +### total\_size + +> **total\_size**: `number` + +*** + +### type + +> **type**: `string` + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/forward/interfaces/MemoryStoreListParams.md b/docs/api/forward/interfaces/MemoryStoreListParams.md new file mode 100644 index 0000000..d5d783d --- /dev/null +++ b/docs/api/forward/interfaces/MemoryStoreListParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreListParams + +# Interface: MemoryStoreListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标，与 `before_id` 互斥。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标，与 `after_id` 互斥。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +每页返回数量上限，1..100，默认 20。 + +*** + +### system\_managed? + +> `optional` **system\_managed?**: `boolean` \| `null` + +三态过滤：`true` 只返回系统默认库；`false` 只返回用户创建的库；不传不过滤。 diff --git a/docs/api/forward/interfaces/MemoryStoreMemoryListParams.md b/docs/api/forward/interfaces/MemoryStoreMemoryListParams.md new file mode 100644 index 0000000..5cb391b --- /dev/null +++ b/docs/api/forward/interfaces/MemoryStoreMemoryListParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreMemoryListParams + +# Interface: MemoryStoreMemoryListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标，与 `before_id` 互斥。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标，与 `after_id` 互斥。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +每页返回数量上限，1..100，默认 20。 + +*** + +### path\_prefix? + +> `optional` **path\_prefix?**: `string` \| `null` + +按 `path` 前缀过滤。**这是纯字符串前缀匹配，不是目录语义** —— `path_prefix=a/b` 也会命中 `a/bc.md`。 diff --git a/docs/api/forward/interfaces/MemoryStoreMemoryNewParams.md b/docs/api/forward/interfaces/MemoryStoreMemoryNewParams.md new file mode 100644 index 0000000..67675bf --- /dev/null +++ b/docs/api/forward/interfaces/MemoryStoreMemoryNewParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreMemoryNewParams + +# Interface: MemoryStoreMemoryNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content + +> **content**: `string` + +UTF-8 明文内容，非 base64；原始字节 ≤100 KiB。约束详见 [content 约束](../MemoryStore数据结构.md#content-约束)。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +键值元数据，值必须为字符串。最多 **16** 个键。约束详见 [Memory metadata 约束](../MemoryStore数据结构.md#memory-metadata-约束)。 + +*** + +### path + +> **path**: `string` + +库内相对路径，大小写敏感。约束详见 [path 规则](../MemoryStore数据结构.md#path-规则)。 diff --git a/docs/api/forward/interfaces/MemoryStoreMemoryUpdateParams.md b/docs/api/forward/interfaces/MemoryStoreMemoryUpdateParams.md new file mode 100644 index 0000000..e16e032 --- /dev/null +++ b/docs/api/forward/interfaces/MemoryStoreMemoryUpdateParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreMemoryUpdateParams + +# Interface: MemoryStoreMemoryUpdateParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content + +> **content**: `string` + +新内容，UTF-8 明文；原始字节 ≤100 KiB。约束详见 [content 约束](../MemoryStore数据结构.md#content-约束)。 + +*** + +### content\_sha256? + +> `optional` **content\_sha256?**: `string` \| `null` + +期望的当前内容 SHA-256，用于乐观并发控制。不一致时返回 `409`。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +新元数据，**整体替换**当前 metadata（非合并）。未传入时保持原 metadata 不变。约束详见 [Memory metadata 约束](../MemoryStore数据结构.md#memory-metadata-约束)。 diff --git a/docs/api/forward/interfaces/MemoryStoreMemoryVersionListParams.md b/docs/api/forward/interfaces/MemoryStoreMemoryVersionListParams.md new file mode 100644 index 0000000..ea515ec --- /dev/null +++ b/docs/api/forward/interfaces/MemoryStoreMemoryVersionListParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreMemoryVersionListParams + +# Interface: MemoryStoreMemoryVersionListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标，与 `before_id` 互斥。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标，与 `after_id` 互斥。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +每页返回数量上限，1..100，默认 20。 + +*** + +### memory\_id? + +> `optional` **memory\_id?**: `string` \| `null` + +只返回该 memory（`mem_...`）的版本，用于查看单条记忆的变更历史。 diff --git a/docs/api/forward/interfaces/MemoryStoreMount.md b/docs/api/forward/interfaces/MemoryStoreMount.md new file mode 100644 index 0000000..a2628f1 --- /dev/null +++ b/docs/api/forward/interfaces/MemoryStoreMount.md @@ -0,0 +1,67 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreMount + +# Interface: MemoryStoreMount + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### access + +> **access**: `string` + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### entry\_count + +> **entry\_count**: `number` + +*** + +### identity\_id + +> **identity\_id**: `string` + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### name + +> **name**: `string` + +*** + +### status + +> **status**: `string` + +*** + +### system\_managed + +> **system\_managed**: `boolean` + +*** + +### template\_id + +> **template\_id**: `string` diff --git a/docs/api/forward/interfaces/MemoryStoreNewParams.md b/docs/api/forward/interfaces/MemoryStoreNewParams.md new file mode 100644 index 0000000..c1fcd81 --- /dev/null +++ b/docs/api/forward/interfaces/MemoryStoreNewParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreNewParams + +# Interface: MemoryStoreNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### description? + +> `optional` **description?**: `string` \| `null` + +自由文本描述。不允许非打印控制字符。 + +*** + +### idempotency\_key + +> **idempotency\_key**: `string` + +创建请求幂等键。相同 key 只能用于相同请求体；不传返回 `400`。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +键值元数据，值必须为字符串。最多 **15** 个键；键 1..64 字符；值 ≤512 字符。`created_by` 是 Forward 保留键，服务端自动写入 `"forward"`；调用方传入 `created_by` 会返回 `400 invalid_request_error`。详见 [Store metadata 约束](./MemoryStore数据结构.md#store-metadata-约束)。 + +*** + +### name + +> **name**: `string` + +Store 展示名，非空。不允许非打印控制字符（`U+0000`–`U+001F`、`U+007F`），换行 `\n`、回车 `\r`、制表 `\t` 除外。 diff --git a/docs/api/forward/interfaces/MemoryStoreUpdateParams.md b/docs/api/forward/interfaces/MemoryStoreUpdateParams.md new file mode 100644 index 0000000..fe20e4e --- /dev/null +++ b/docs/api/forward/interfaces/MemoryStoreUpdateParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreUpdateParams + +# Interface: MemoryStoreUpdateParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### description? + +> `optional` **description?**: `string` \| `null` + +新描述。传入时不含非打印控制字符。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +新元数据，**整体替换**当前 metadata（非合并）。约束详见 [Store metadata 约束](./MemoryStore数据结构.md#store-metadata-约束)。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +新名称。传入时非空且不含非打印控制字符。 diff --git a/docs/api/forward/interfaces/MemoryVersion.md b/docs/api/forward/interfaces/MemoryVersion.md new file mode 100644 index 0000000..68da44f --- /dev/null +++ b/docs/api/forward/interfaces/MemoryVersion.md @@ -0,0 +1,85 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryVersion + +# Interface: MemoryVersion + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content + +> **content**: `unknown` + +*** + +### content\_sha256 + +> **content\_sha256**: `string` + +*** + +### content\_size\_bytes + +> **content\_size\_bytes**: `number` + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### memory\_id + +> **memory\_id**: `string` + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### operation + +> **operation**: `string` + +*** + +### path + +> **path**: `string` + +*** + +### redacted + +> **redacted**: `boolean` + +*** + +### redacted\_at + +> **redacted\_at**: `string` \| `null` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/Model.md b/docs/api/forward/interfaces/Model.md new file mode 100644 index 0000000..e936c02 --- /dev/null +++ b/docs/api/forward/interfaces/Model.md @@ -0,0 +1,91 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Model + +# Interface: Model + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### available\_context\_windows + +> **available\_context\_windows**: `number`[] + +*** + +### default\_context\_window + +> **default\_context\_window**: `number` + +*** + +### default\_effort + +> **default\_effort**: `string` + +*** + +### display\_name + +> **display\_name**: `string` + +*** + +### efforts + +> **efforts**: `string`[] + +*** + +### id + +> **id**: `string` + +*** + +### is\_enabled + +> **is\_enabled**: `boolean` + +*** + +### is\_new + +> **is\_new**: `boolean` + +*** + +### is\_vl + +> **is\_vl**: `boolean` + +*** + +### max\_input\_tokens + +> **max\_input\_tokens**: `number` + +*** + +### price\_factor + +> **price\_factor**: `number` + +*** + +### speed + +> **speed**: `string`[] + +*** + +### support\_disable\_reasoning + +> **support\_disable\_reasoning**: `boolean` diff --git a/docs/api/forward/interfaces/ModelConfigObject.md b/docs/api/forward/interfaces/ModelConfigObject.md new file mode 100644 index 0000000..0a7f44b --- /dev/null +++ b/docs/api/forward/interfaces/ModelConfigObject.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ModelConfigObject + +# Interface: ModelConfigObject + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### context\_window + +> **context\_window**: `number` + +*** + +### effort + +> **effort**: `string` + +*** + +### id + +> **id**: `string` diff --git a/docs/api/forward/interfaces/ModelConfigParam.md b/docs/api/forward/interfaces/ModelConfigParam.md new file mode 100644 index 0000000..7cf164d --- /dev/null +++ b/docs/api/forward/interfaces/ModelConfigParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ModelConfigParam + +# Interface: ModelConfigParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### context\_window? + +> `optional` **context\_window?**: `number` \| `null` + +*** + +### effort? + +> `optional` **effort?**: `string` \| `null` + +*** + +### id + +> **id**: `string` diff --git a/docs/api/forward/interfaces/ModelListResponse.md b/docs/api/forward/interfaces/ModelListResponse.md new file mode 100644 index 0000000..bbf11e2 --- /dev/null +++ b/docs/api/forward/interfaces/ModelListResponse.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ModelListResponse + +# Interface: ModelListResponse + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### data + +> **data**: [`Model`](Model.md)[] + +*** + +### has\_more + +> **has\_more**: `boolean` diff --git a/docs/api/forward/interfaces/MultiagentConfig.md b/docs/api/forward/interfaces/MultiagentConfig.md new file mode 100644 index 0000000..7b06845 --- /dev/null +++ b/docs/api/forward/interfaces/MultiagentConfig.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MultiagentConfig + +# Interface: MultiagentConfig + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### agents + +> **agents**: [`MultiagentEntry`](MultiagentEntry.md)[] + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/MultiagentConfigParam.md b/docs/api/forward/interfaces/MultiagentConfigParam.md new file mode 100644 index 0000000..839c604 --- /dev/null +++ b/docs/api/forward/interfaces/MultiagentConfigParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MultiagentConfigParam + +# Interface: MultiagentConfigParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### agents + +> **agents**: [`MultiagentEntryParam`](MultiagentEntryParam.md)[] + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/MultiagentEntry.md b/docs/api/forward/interfaces/MultiagentEntry.md new file mode 100644 index 0000000..507c22c --- /dev/null +++ b/docs/api/forward/interfaces/MultiagentEntry.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MultiagentEntry + +# Interface: MultiagentEntry + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### name + +> **name**: `string` + +*** + +### template\_id + +> **template\_id**: `string` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/MultiagentEntryParam.md b/docs/api/forward/interfaces/MultiagentEntryParam.md new file mode 100644 index 0000000..c9f9e81 --- /dev/null +++ b/docs/api/forward/interfaces/MultiagentEntryParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MultiagentEntryParam + +# Interface: MultiagentEntryParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### name? + +> `optional` **name?**: `string` \| `null` + +*** + +### template\_id? + +> `optional` **template\_id?**: `string` \| `null` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/PermissionPolicy.md b/docs/api/forward/interfaces/PermissionPolicy.md new file mode 100644 index 0000000..6bc0168 --- /dev/null +++ b/docs/api/forward/interfaces/PermissionPolicy.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / PermissionPolicy + +# Interface: PermissionPolicy + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/PermissionPolicyParam.md b/docs/api/forward/interfaces/PermissionPolicyParam.md new file mode 100644 index 0000000..3870848 --- /dev/null +++ b/docs/api/forward/interfaces/PermissionPolicyParam.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / PermissionPolicyParam + +# Interface: PermissionPolicyParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/ResourceBinding.md b/docs/api/forward/interfaces/ResourceBinding.md new file mode 100644 index 0000000..18a1f19 --- /dev/null +++ b/docs/api/forward/interfaces/ResourceBinding.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ResourceBinding + +# Interface: ResourceBinding + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled + +> **enabled**: `boolean` diff --git a/docs/api/forward/interfaces/ResourceBindingParam.md b/docs/api/forward/interfaces/ResourceBindingParam.md new file mode 100644 index 0000000..966c430 --- /dev/null +++ b/docs/api/forward/interfaces/ResourceBindingParam.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ResourceBindingParam + +# Interface: ResourceBindingParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` diff --git a/docs/api/forward/interfaces/Schedule.md b/docs/api/forward/interfaces/Schedule.md new file mode 100644 index 0000000..843c0bf --- /dev/null +++ b/docs/api/forward/interfaces/Schedule.md @@ -0,0 +1,109 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Schedule + +# Interface: Schedule + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### archived\_at + +> **archived\_at**: `string` + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### description + +> **description**: `string` + +*** + +### environment\_id + +> **environment\_id**: `string` + +*** + +### execution + +> **execution**: [`ScheduleExecution`](ScheduleExecution.md) + +*** + +### id + +> **id**: `string` + +*** + +### identity\_id + +> **identity\_id**: `string` + +*** + +### initial\_events + +> **initial\_events**: [`ScheduleInitialEventsItem`](ScheduleInitialEventsItem.md)[] + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +*** + +### name + +> **name**: `string` + +*** + +### paused\_reason + +> **paused\_reason**: [`SchedulePausedReason`](SchedulePausedReason.md) + +*** + +### sinks + +> **sinks**: [`ScheduleSinksItem`](ScheduleSinksItem.md)[] + +*** + +### status + +> **status**: `string` + +*** + +### template\_id + +> **template\_id**: `string` + +*** + +### trigger\_policy + +> **trigger\_policy**: [`ScheduleTriggerPolicy`](ScheduleTriggerPolicy.md) + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/forward/interfaces/ScheduleArchiveManyParams.md b/docs/api/forward/interfaces/ScheduleArchiveManyParams.md new file mode 100644 index 0000000..746703c --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleArchiveManyParams.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleArchiveManyParams + +# Interface: ScheduleArchiveManyParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键；相同 owner、路径和请求体可安全重放。 + +*** + +### schedule\_ids + +> **schedule\_ids**: `string`[] + +去重后必须包含 1～50 个非空 Schedule ID。 diff --git a/docs/api/forward/interfaces/ScheduleArchiveManyResponse.md b/docs/api/forward/interfaces/ScheduleArchiveManyResponse.md new file mode 100644 index 0000000..fe096f9 --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleArchiveManyResponse.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleArchiveManyResponse + +# Interface: ScheduleArchiveManyResponse + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### archived\_count + +> **archived\_count**: `number` + +本次从未归档状态变为已归档的 Schedule 数量；已经归档的目标不重复计数。 diff --git a/docs/api/forward/interfaces/ScheduleArchiveParams.md b/docs/api/forward/interfaces/ScheduleArchiveParams.md new file mode 100644 index 0000000..4b9273f --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleArchiveParams + +# Interface: ScheduleArchiveParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/ScheduleExecution.md b/docs/api/forward/interfaces/ScheduleExecution.md new file mode 100644 index 0000000..87eeddb --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleExecution.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleExecution + +# Interface: ScheduleExecution + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### max\_attempts + +> **max\_attempts**: `number` + +*** + +### max\_concurrent\_runs + +> **max\_concurrent\_runs**: `number` + +*** + +### session\_mode + +> **session\_mode**: `string` + +*** + +### timeout\_ms + +> **timeout\_ms**: `number` diff --git a/docs/api/forward/interfaces/ScheduleInitialEventsItem.md b/docs/api/forward/interfaces/ScheduleInitialEventsItem.md new file mode 100644 index 0000000..3ce1d17 --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleInitialEventsItem.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleInitialEventsItem + +# Interface: ScheduleInitialEventsItem + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content + +> **content**: `string` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/ScheduleListParams.md b/docs/api/forward/interfaces/ScheduleListParams.md new file mode 100644 index 0000000..7188fc6 --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleListParams.md @@ -0,0 +1,85 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleListParams + +# Interface: ScheduleListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标。 + +*** + +### identity\_id? + +> `optional` **identity\_id?**: `string` \| `null` + +PAT 或管理员 SAT 可省略，省略时查询当前 owner 全部 Identity；Identity-bound SAT 省略时自动绑定自身，显式传其他 Identity 返回 403。 + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` \| `null` + +是否包含已归档 Schedule。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### order? + +> `optional` **order?**: `string` \| `null` + +排序方向：`asc` 或 `desc`。 + +*** + +### sort\_by? + +> `optional` **sort\_by?**: `string` \| `null` + +排序字段：`created_at` 或 `upcoming_runs_at`。 + +*** + +### status? + +> `optional` **status?**: `string` \| `null` + +按 `active` 或 `paused` 过滤。 + +*** + +### template\_id? + +> `optional` **template\_id?**: `string` \| `null` + +按 Forward Template ID 过滤。 diff --git a/docs/api/forward/interfaces/ScheduleNewParams.md b/docs/api/forward/interfaces/ScheduleNewParams.md new file mode 100644 index 0000000..fccd7db --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleNewParams.md @@ -0,0 +1,101 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleNewParams + +# Interface: ScheduleNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### description? + +> `optional` **description?**: `string` \| `null` + +Schedule 描述。 + +*** + +### environment\_id + +> **environment\_id**: `string` + +执行环境。 + +*** + +### execution? + +> `optional` **execution?**: `Record`\<`string`, `unknown`\> \| `null` + +执行策略；省略时使用服务端默认值。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### identity\_id + +> **identity\_id**: `string` + +Schedule 所属 Forward Identity ID。 + +*** + +### initial\_events + +> **initial\_events**: `Record`\<`string`, `unknown`\>[] + +每次执行注入的初始事件，当前支持 `user.message`。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +业务元数据，仅用于标签或透传。 + +*** + +### name + +> **name**: `string` + +Schedule 名称。 + +*** + +### sinks? + +> `optional` **sinks?**: `Record`\<`string`, `unknown`\>[] \| `null` + +执行结果推送目标；为兼容性保留数组形式，当前最多允许一个元素。 + +*** + +### template\_id + +> **template\_id**: `string` + +要执行的 Forward Template ID。 + +*** + +### trigger\_policy? + +> `optional` **trigger\_policy?**: `Record`\<`string`, `unknown`\> \| `null` + +触发策略；省略或 `null` 时按 `manual` 处理。 diff --git a/docs/api/forward/interfaces/SchedulePauseParams.md b/docs/api/forward/interfaces/SchedulePauseParams.md new file mode 100644 index 0000000..dbf41d8 --- /dev/null +++ b/docs/api/forward/interfaces/SchedulePauseParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SchedulePauseParams + +# Interface: SchedulePauseParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/SchedulePausedReason.md b/docs/api/forward/interfaces/SchedulePausedReason.md new file mode 100644 index 0000000..b0edf45 --- /dev/null +++ b/docs/api/forward/interfaces/SchedulePausedReason.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SchedulePausedReason + +# Interface: SchedulePausedReason + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/ScheduleRun.md b/docs/api/forward/interfaces/ScheduleRun.md new file mode 100644 index 0000000..9483400 --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleRun.md @@ -0,0 +1,165 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleRun + +# Interface: ScheduleRun + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### attempt + +> **attempt**: `number` + +当前或最终实际执行到第几次，从 `1` 开始；当 Schedule 的 `execution.max_attempts=2` 且服务端完成自动重试时，可能返回 `2`。 + +*** + +### completed\_at + +> **completed\_at**: `string` + +null|结束时间。 + +*** + +### created\_at + +> **created\_at**: `string` + +记录创建时间。 + +*** + +### duration\_ms + +> **duration\_ms**: `number` + +null|执行耗时，单位毫秒。 + +*** + +### error + +> **error**: `Record`\<`string`, `unknown`\> + +null|失败或跳过时的结构化错误。 + +*** + +### error\_message + +> **error\_message**: `string` + +null|便于展示的错误信息；结构化信息保留在 `error`。 + +*** + +### id + +> **id**: `string` + +Schedule Run ID。 + +*** + +### identity\_id + +> **identity\_id**: `string` + +Forward Identity ID。 + +*** + +### push\_finished\_at + +> **push\_finished\_at**: `string` + +null|IM 投递结束时间。 + +*** + +### push\_sink + +> **push\_sink**: `string` + +null|本次 IM 投递使用的 Sink 类型；未配置投递时为 `null`。 + +*** + +### push\_status + +> **push\_status**: `string` + +IM 投递状态：`pending`、`succeeded`、`failed` 或 `skipped`。主流程状态与投递状态相互独立。 + +*** + +### result\_payload + +> **result\_payload**: `string` + +null|主流程文本结果。 + +*** + +### schedule\_id + +> **schedule\_id**: `string` + +所属 Schedule ID。 + +*** + +### session\_id + +> **session\_id**: `string` + +null|本次执行创建或使用的 Session。 + +*** + +### started\_at + +> **started\_at**: `string` + +null|开始执行时间。 + +*** + +### status + +> **status**: `string` + +`pending`、`running`、`completed`、`failed` 或 `skipped`。 + +*** + +### template\_id + +> **template\_id**: `string` + +Forward Template ID。 + +*** + +### trigger\_context + +> **trigger\_context**: [`ScheduleRunTriggerContext`](ScheduleRunTriggerContext.md) + +触发来源。 + +*** + +### triggered\_at + +> **triggered\_at**: `string` + +触发时间。 diff --git a/docs/api/forward/interfaces/ScheduleRunGetParams.md b/docs/api/forward/interfaces/ScheduleRunGetParams.md new file mode 100644 index 0000000..a193929 --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleRunGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleRunGetParams + +# Interface: ScheduleRunGetParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### identity\_id? + +> `optional` **identity\_id?**: `string` \| `null` + +额外归属约束。 diff --git a/docs/api/forward/interfaces/ScheduleRunListParams.md b/docs/api/forward/interfaces/ScheduleRunListParams.md new file mode 100644 index 0000000..b34c911 --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleRunListParams.md @@ -0,0 +1,93 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleRunListParams + +# Interface: ScheduleRunListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标。 + +*** + +### has\_error? + +> `optional` **has\_error?**: `boolean` \| `null` + +是否只返回有错误或无错误的 Run。 + +*** + +### identity\_id + +> **identity\_id**: `string` + +Run 所属 Forward Identity ID。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### order? + +> `optional` **order?**: `string` \| `null` + +排序方向：`asc` 或 `desc`。 + +*** + +### schedule\_id? + +> `optional` **schedule\_id?**: `string` \| `null` + +按 Schedule ID 过滤。 + +*** + +### sort\_by? + +> `optional` **sort\_by?**: `string` \| `null` + +排序字段：`created_at` 或 `triggered_at`。 + +*** + +### status? + +> `optional` **status?**: `string` \| `null` + +按 `pending`、`running`、`completed`、`failed` 或 `skipped` 过滤。 + +*** + +### trigger\_type? + +> `optional` **trigger\_type?**: `string` \| `null` + +按 `schedule` 或 `manual` 过滤。 diff --git a/docs/api/forward/interfaces/ScheduleRunParams.md b/docs/api/forward/interfaces/ScheduleRunParams.md new file mode 100644 index 0000000..fd89e6b --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleRunParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleRunParams + +# Interface: ScheduleRunParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/ScheduleRunTriggerContext.md b/docs/api/forward/interfaces/ScheduleRunTriggerContext.md new file mode 100644 index 0000000..ee330d8 --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleRunTriggerContext.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleRunTriggerContext + +# Interface: ScheduleRunTriggerContext + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### scheduled\_at + +> **scheduled\_at**: `string` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/ScheduleSinksItem.md b/docs/api/forward/interfaces/ScheduleSinksItem.md new file mode 100644 index 0000000..11a435b --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleSinksItem.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleSinksItem + +# Interface: ScheduleSinksItem + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### channel\_id + +> **channel\_id**: `string` + +*** + +### target + +> **target**: [`ScheduleSinksItemTarget`](ScheduleSinksItemTarget.md) + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/ScheduleSinksItemTarget.md b/docs/api/forward/interfaces/ScheduleSinksItemTarget.md new file mode 100644 index 0000000..bcecef3 --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleSinksItemTarget.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleSinksItemTarget + +# Interface: ScheduleSinksItemTarget + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### external\_id + +> **external\_id**: `string` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/ScheduleTriggerPolicy.md b/docs/api/forward/interfaces/ScheduleTriggerPolicy.md new file mode 100644 index 0000000..9f2ee6a --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleTriggerPolicy.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleTriggerPolicy + +# Interface: ScheduleTriggerPolicy + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### expression + +> **expression**: `string` + +*** + +### timezone + +> **timezone**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### upcoming\_runs\_at + +> **upcoming\_runs\_at**: `string`[] diff --git a/docs/api/forward/interfaces/ScheduleUnpauseParams.md b/docs/api/forward/interfaces/ScheduleUnpauseParams.md new file mode 100644 index 0000000..4dc2a86 --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleUnpauseParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleUnpauseParams + +# Interface: ScheduleUnpauseParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/ScheduleUpdateParams.md b/docs/api/forward/interfaces/ScheduleUpdateParams.md new file mode 100644 index 0000000..4b231bf --- /dev/null +++ b/docs/api/forward/interfaces/ScheduleUpdateParams.md @@ -0,0 +1,93 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleUpdateParams + +# Interface: ScheduleUpdateParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### description? + +> `optional` **description?**: `string` \| `null` + +新的 Schedule 描述。 + +*** + +### environment\_id? + +> `optional` **environment\_id?**: `string` \| `null` + +新的执行环境。 + +*** + +### execution? + +> `optional` **execution?**: `Record`\<`string`, `unknown`\> \| `null` + +合并更新执行策略。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### initial\_events? + +> `optional` **initial\_events?**: `Record`\<`string`, `unknown`\>[] \| `null` + +替换初始事件列表。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +合并更新 metadata；value 为 `null` 删除 key。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +新的 Schedule 名称。 + +*** + +### sinks? + +> `optional` **sinks?**: `Record`\<`string`, `unknown`\>[] \| `null` + +执行结果推送目标；为兼容性保留数组形式，当前最多允许一个元素。 + +*** + +### template\_id? + +> `optional` **template\_id?**: `string` \| `null` + +新的 Forward Template ID。 + +*** + +### trigger\_policy? + +> `optional` **trigger\_policy?**: `Record`\<`string`, `unknown`\> \| `null` + +更新触发策略；`null` 表示改为 manual。 diff --git a/docs/api/forward/interfaces/Session.md b/docs/api/forward/interfaces/Session.md new file mode 100644 index 0000000..5c56550 --- /dev/null +++ b/docs/api/forward/interfaces/Session.md @@ -0,0 +1,115 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Session + +# Interface: Session + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### archived\_at + +> **archived\_at**: `string` \| `null` + +*** + +### config + +> **config**: [`SessionConfig`](SessionConfig.md) + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### id + +> **id**: `string` + +Session ID。 + +*** + +### identity\_id + +> **identity\_id**: `string` + +Forward Identity ID。 + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +*** + +### resources + +> **resources**: [`SessionResource`](SessionResource.md)[] + +*** + +### source\_type + +> **source\_type**: `string` + +Session 来源，直接 API 创建为 `api`。 + +*** + +### stats + +> **stats**: [`SessionStats`](SessionStats.md) + +*** + +### status + +> **status**: `string` + +`idle`、`running`、`rescheduling`、`canceling` 或 `terminated`。 + +*** + +### template + +> **template**: [`SessionTemplate`](SessionTemplate.md) + +Template 摘要。 + +*** + +### title + +> **title**: `string` + +*** + +### type + +> **type**: `string` + +固定为 `session`。 + +*** + +### updated\_at + +> **updated\_at**: `string` + +*** + +### usage + +> **usage**: [`SessionUsage`](SessionUsage.md) diff --git a/docs/api/forward/interfaces/SessionArchiveParams.md b/docs/api/forward/interfaces/SessionArchiveParams.md new file mode 100644 index 0000000..546165e --- /dev/null +++ b/docs/api/forward/interfaces/SessionArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionArchiveParams + +# Interface: SessionArchiveParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/SessionCancelParams.md b/docs/api/forward/interfaces/SessionCancelParams.md new file mode 100644 index 0000000..d6866cf --- /dev/null +++ b/docs/api/forward/interfaces/SessionCancelParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionCancelParams + +# Interface: SessionCancelParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/SessionConfig.md b/docs/api/forward/interfaces/SessionConfig.md new file mode 100644 index 0000000..3f24978 --- /dev/null +++ b/docs/api/forward/interfaces/SessionConfig.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionConfig + +# Interface: SessionConfig + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### environment\_variables + +> **environment\_variables**: `Record`\<`string`, `string`\> diff --git a/docs/api/forward/interfaces/SessionEvent.md b/docs/api/forward/interfaces/SessionEvent.md new file mode 100644 index 0000000..1700c96 --- /dev/null +++ b/docs/api/forward/interfaces/SessionEvent.md @@ -0,0 +1,259 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionEvent + +# Interface: SessionEvent + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### agent + +> **agent**: `Record`\<`string`, `unknown`\> + +*** + +### content + +> **content**: `unknown` + +*** + +### content\_block + +> **content\_block**: `unknown` + +*** + +### content\_type + +> **content\_type**: `string` + +*** + +### custom\_tool\_use\_id + +> **custom\_tool\_use\_id**: `string` + +*** + +### delta + +> **delta**: `unknown` + +*** + +### deny\_message + +> **deny\_message**: `string` + +*** + +### description + +> **description**: `string` + +*** + +### error + +> **error**: `Record`\<`string`, `unknown`\> + +*** + +### evaluated\_permission + +> **evaluated\_permission**: `Record`\<`string`, `unknown`\> + +*** + +### event + +> **event**: `unknown` + +*** + +### event\_id + +> **event\_id**: `string` + +*** + +### file\_id + +> **file\_id**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### index + +> **index**: `number` + +*** + +### input + +> **input**: `Record`\<`string`, `unknown`\> + +*** + +### is\_error + +> **is\_error**: `boolean` + +*** + +### max\_iterations + +> **max\_iterations**: `number` + +*** + +### mcp\_server\_name + +> **mcp\_server\_name**: `string` + +*** + +### mcp\_tool\_use\_id + +> **mcp\_tool\_use\_id**: `string` + +*** + +### message + +> **message**: `unknown` + +*** + +### message\_id + +> **message\_id**: `string` + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +*** + +### model\_request\_start\_id + +> **model\_request\_start\_id**: `string` + +*** + +### model\_usage + +> **model\_usage**: `Record`\<`string`, `unknown`\> + +*** + +### name + +> **name**: `string` + +*** + +### original\_filename + +> **original\_filename**: `string` + +*** + +### outcome\_id + +> **outcome\_id**: `string` + +*** + +### processed\_at + +> **processed\_at**: `string` + +*** + +### result + +> **result**: `string` + +*** + +### rubric + +> **rubric**: `string` + +*** + +### session\_id + +> **session\_id**: `string` + +*** + +### session\_thread\_id + +> **session\_thread\_id**: `string` + +*** + +### size + +> **size**: `number` + +*** + +### stop\_reason + +> **stop\_reason**: `Record`\<`string`, `unknown`\> + +*** + +### text + +> **text**: `string` + +*** + +### thinking + +> **thinking**: `string` + +*** + +### title + +> **title**: `string` + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### usage + +> **usage**: `Record`\<`string`, `unknown`\> diff --git a/docs/api/forward/interfaces/SessionEventListParams.md b/docs/api/forward/interfaces/SessionEventListParams.md new file mode 100644 index 0000000..8dac8ae --- /dev/null +++ b/docs/api/forward/interfaces/SessionEventListParams.md @@ -0,0 +1,77 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionEventListParams + +# Interface: SessionEventListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +返回该 Event ID 之后的事件。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +返回该 Event ID 之前的事件。 + +*** + +### include\_thinking? + +> `optional` **include\_thinking?**: `boolean` \| `null` + +是否包含思考过程事件。 + +*** + +### include\_tool\_calls? + +> `optional` **include\_tool\_calls?**: `boolean` \| `null` + +是否包含工具调用类事件。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### order? + +> `optional` **order?**: `string` \| `null` + +排序方向：`asc` 或 `desc`。 + +*** + +### type? + +> `optional` **type?**: `string` \| `null` + +按 Event 类型过滤，支持逗号分隔。 + +*** + +### types\[\]? + +> `optional` **types\[\]?**: `string`[] \| `null` + +数组形式的 Event 类型过滤。 diff --git a/docs/api/forward/interfaces/SessionEventParam.md b/docs/api/forward/interfaces/SessionEventParam.md new file mode 100644 index 0000000..ea113ff --- /dev/null +++ b/docs/api/forward/interfaces/SessionEventParam.md @@ -0,0 +1,79 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionEventParam + +# Interface: SessionEventParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content? + +> `optional` **content?**: [`EventContentUnionParam`](../type-aliases/EventContentUnionParam.md) + +*** + +### custom\_tool\_use\_id? + +> `optional` **custom\_tool\_use\_id?**: `string` \| `null` + +*** + +### deny\_message? + +> `optional` **deny\_message?**: `string` \| `null` + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +*** + +### is\_error? + +> `optional` **is\_error?**: `boolean` \| `null` + +*** + +### max\_iterations? + +> `optional` **max\_iterations?**: `number` \| `null` + +*** + +### outcome\_id? + +> `optional` **outcome\_id?**: `string` \| `null` + +*** + +### result? + +> `optional` **result?**: `string` \| `null` + +*** + +### rubric? + +> `optional` **rubric?**: `string` \| `null` + +*** + +### tool\_use\_id? + +> `optional` **tool\_use\_id?**: `string` \| `null` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/SessionEventSendParams.md b/docs/api/forward/interfaces/SessionEventSendParams.md new file mode 100644 index 0000000..b75e42e --- /dev/null +++ b/docs/api/forward/interfaces/SessionEventSendParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionEventSendParams + +# Interface: SessionEventSendParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### events + +> **events**: [`SessionEventParam`](SessionEventParam.md)[] + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/SessionEventSendResponse.md b/docs/api/forward/interfaces/SessionEventSendResponse.md new file mode 100644 index 0000000..61ba2fb --- /dev/null +++ b/docs/api/forward/interfaces/SessionEventSendResponse.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionEventSendResponse + +# Interface: SessionEventSendResponse + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### data + +> **data**: [`SessionEvent`](SessionEvent.md)[] diff --git a/docs/api/forward/interfaces/SessionEventStreamParams.md b/docs/api/forward/interfaces/SessionEventStreamParams.md new file mode 100644 index 0000000..4a45347 --- /dev/null +++ b/docs/api/forward/interfaces/SessionEventStreamParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionEventStreamParams + +# Interface: SessionEventStreamParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### event\_deltas\[\]? + +> `optional` **event\_deltas\[\]?**: `string`[] \| `null` + +订阅指定公开事件类型的流式增量事件。支持重复传参，取值见 [流式增量事件](../Session&Event数据结构.md#流式增量事件)。 + +*** + +### include\_thinking? + +> `optional` **include\_thinking?**: `boolean` \| `null` + +是否包含思考过程事件。 + +*** + +### include\_tool\_calls? + +> `optional` **include\_tool\_calls?**: `boolean` \| `null` + +是否包含工具调用类事件。 + +*** + +### last\_event\_id? + +> `optional` **last\_event\_id?**: `string` \| `null` + +从该 Event ID 之后恢复订阅。 diff --git a/docs/api/forward/interfaces/SessionListParams.md b/docs/api/forward/interfaces/SessionListParams.md new file mode 100644 index 0000000..7b71125 --- /dev/null +++ b/docs/api/forward/interfaces/SessionListParams.md @@ -0,0 +1,141 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionListParams + +# Interface: SessionListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标，传入上一页响应的 `last_id`。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标，传入当前页响应的 `first_id`。 + +*** + +### created\_at\[gt\]? + +> `optional` **created\_at\[gt\]?**: `string` \| `null` + +创建时间严格大于该 RFC 3339 时间。 + +*** + +### created\_at\[gte\]? + +> `optional` **created\_at\[gte\]?**: `string` \| `null` + +创建时间大于等于该 RFC 3339 时间。 + +*** + +### created\_at\[lt\]? + +> `optional` **created\_at\[lt\]?**: `string` \| `null` + +创建时间严格小于该 RFC 3339 时间。 + +*** + +### created\_at\[lte\]? + +> `optional` **created\_at\[lte\]?**: `string` \| `null` + +创建时间小于等于该 RFC 3339 时间。 + +*** + +### identity\_ids? + +> `optional` **identity\_ids?**: `string`[] \| `null` + +按一个或多个 Identity ID 过滤，支持逗号分隔。 + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` \| `null` + +是否包含已归档 Session。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### order? + +> `optional` **order?**: `string` \| `null` + +创建时间排序方向：`desc` 或 `asc`。 + +*** + +### source\_type? + +> `optional` **source\_type?**: `string` \| `null` + +按 `api`、`im`、`schedule` 或 `batch` 过滤。 + +*** + +### template\_id? + +> `optional` **template\_id?**: `string` \| `null` + +按 Forward Template ID 过滤。 + +*** + +### updated\_at\[gt\]? + +> `optional` **updated\_at\[gt\]?**: `string` \| `null` + +更新时间严格大于该 RFC 3339 时间。 + +*** + +### updated\_at\[gte\]? + +> `optional` **updated\_at\[gte\]?**: `string` \| `null` + +更新时间大于等于该 RFC 3339 时间。 + +*** + +### updated\_at\[lt\]? + +> `optional` **updated\_at\[lt\]?**: `string` \| `null` + +更新时间严格小于该 RFC 3339 时间。 + +*** + +### updated\_at\[lte\]? + +> `optional` **updated\_at\[lte\]?**: `string` \| `null` + +更新时间小于等于该 RFC 3339 时间。 diff --git a/docs/api/forward/interfaces/SessionNewParams.md b/docs/api/forward/interfaces/SessionNewParams.md new file mode 100644 index 0000000..d360c35 --- /dev/null +++ b/docs/api/forward/interfaces/SessionNewParams.md @@ -0,0 +1,65 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionNewParams + +# Interface: SessionNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### config? + +> `optional` **config?**: [`SessionNewParamsConfigParam`](SessionNewParamsConfigParam.md) \| `null` + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### identity\_id + +> **identity\_id**: `string` + +Forward Identity ID。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +业务元数据。 + +*** + +### resources? + +> `optional` **resources?**: [`SessionResourceSpecParam`](SessionResourceSpecParam.md)[] \| `null` + +*** + +### template\_id + +> **template\_id**: `string` + +Forward Template ID。 + +*** + +### title? + +> `optional` **title?**: `string` \| `null` + +Session 标题。 diff --git a/docs/api/forward/interfaces/SessionNewParamsConfigParam.md b/docs/api/forward/interfaces/SessionNewParamsConfigParam.md new file mode 100644 index 0000000..45e6815 --- /dev/null +++ b/docs/api/forward/interfaces/SessionNewParamsConfigParam.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionNewParamsConfigParam + +# Interface: SessionNewParamsConfigParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### environment\_variables? + +> `optional` **environment\_variables?**: `Record`\<`string`, `unknown`\> \| `null` diff --git a/docs/api/forward/interfaces/SessionResource.md b/docs/api/forward/interfaces/SessionResource.md new file mode 100644 index 0000000..faec63f --- /dev/null +++ b/docs/api/forward/interfaces/SessionResource.md @@ -0,0 +1,61 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionResource + +# Interface: SessionResource + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### created\_at + +> **created\_at**: `string` + +资源创建时间，RFC3339。 + +*** + +### file\_id + +> **file\_id**: `string` + +挂载的 File ID。 + +*** + +### id + +> **id**: `string` + +Session 资源 ID，以 `sesr_` 为前缀。 + +*** + +### mount\_path + +> **mount\_path**: `string` + +文件在 Agent 容器内的实际挂载路径。 + +*** + +### type + +> **type**: `string` + +资源类型，固定为 `file`。 + +*** + +### updated\_at + +> **updated\_at**: `string` + +资源更新时间，RFC3339。 diff --git a/docs/api/forward/interfaces/SessionResourceAddParams.md b/docs/api/forward/interfaces/SessionResourceAddParams.md new file mode 100644 index 0000000..166390c --- /dev/null +++ b/docs/api/forward/interfaces/SessionResourceAddParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionResourceAddParams + +# Interface: SessionResourceAddParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### file\_id + +> **file\_id**: `string` + +Files API 返回的 File ID，文件必须已上传完成。 + +*** + +### mount\_path? + +> `optional` **mount\_path?**: `string` \| `null` + +Agent 容器内挂载路径；省略时由 Forward 根据文件名生成，默认挂载到 `/data/workspace/<文件名>`。 + +*** + +### type + +> **type**: `string` + +资源类型，必须为 `file`。 diff --git a/docs/api/forward/interfaces/SessionResourceSpec.md b/docs/api/forward/interfaces/SessionResourceSpec.md new file mode 100644 index 0000000..6f2a848 --- /dev/null +++ b/docs/api/forward/interfaces/SessionResourceSpec.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionResourceSpec + +# Interface: SessionResourceSpec + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### file\_id + +> **file\_id**: `string` + +*** + +### mount\_path + +> **mount\_path**: `string` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/SessionResourceSpecParam.md b/docs/api/forward/interfaces/SessionResourceSpecParam.md new file mode 100644 index 0000000..afbfbdc --- /dev/null +++ b/docs/api/forward/interfaces/SessionResourceSpecParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionResourceSpecParam + +# Interface: SessionResourceSpecParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### file\_id + +> **file\_id**: `string` + +*** + +### mount\_path? + +> `optional` **mount\_path?**: `string` \| `null` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/SessionStats.md b/docs/api/forward/interfaces/SessionStats.md new file mode 100644 index 0000000..ac257f0 --- /dev/null +++ b/docs/api/forward/interfaces/SessionStats.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionStats + +# Interface: SessionStats + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### active\_seconds + +> **active\_seconds**: `number` + +*** + +### duration\_seconds + +> **duration\_seconds**: `number` diff --git a/docs/api/forward/interfaces/SessionTemplate.md b/docs/api/forward/interfaces/SessionTemplate.md new file mode 100644 index 0000000..05cd99b --- /dev/null +++ b/docs/api/forward/interfaces/SessionTemplate.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionTemplate + +# Interface: SessionTemplate + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### id + +> **id**: `string` + +*** + +### model + +> **model**: [`ModelConfig`](../type-aliases/ModelConfig.md) + +*** + +### name + +> **name**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### version + +> **version**: `number` diff --git a/docs/api/forward/interfaces/SessionThread.md b/docs/api/forward/interfaces/SessionThread.md new file mode 100644 index 0000000..2c7eb72 --- /dev/null +++ b/docs/api/forward/interfaces/SessionThread.md @@ -0,0 +1,91 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionThread + +# Interface: SessionThread + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### archived\_at + +> **archived\_at**: `string` + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### created\_by\_tool\_use\_id + +> **created\_by\_tool\_use\_id**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### name + +> **name**: `string` + +*** + +### parent\_thread\_id + +> **parent\_thread\_id**: `string` + +*** + +### role + +> **role**: `string` + +*** + +### session\_id + +> **session\_id**: `string` + +*** + +### status + +> **status**: `string` + +*** + +### stop\_reason + +> **stop\_reason**: [`SessionThreadStopReason`](SessionThreadStopReason.md) + +*** + +### template\_id + +> **template\_id**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/forward/interfaces/SessionThreadArchiveParams.md b/docs/api/forward/interfaces/SessionThreadArchiveParams.md new file mode 100644 index 0000000..0f82469 --- /dev/null +++ b/docs/api/forward/interfaces/SessionThreadArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionThreadArchiveParams + +# Interface: SessionThreadArchiveParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +标识一次逻辑归档尝试；建议为每次新的逻辑尝试生成唯一值。 diff --git a/docs/api/forward/interfaces/SessionThreadEventListParams.md b/docs/api/forward/interfaces/SessionThreadEventListParams.md new file mode 100644 index 0000000..8984a85 --- /dev/null +++ b/docs/api/forward/interfaces/SessionThreadEventListParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionThreadEventListParams + +# Interface: SessionThreadEventListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +返回该 Event ID 之后的记录。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +返回该 Event ID 之前的记录。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，范围为 1–100。 diff --git a/docs/api/forward/interfaces/SessionThreadEventStreamParams.md b/docs/api/forward/interfaces/SessionThreadEventStreamParams.md new file mode 100644 index 0000000..1f9f7d6 --- /dev/null +++ b/docs/api/forward/interfaces/SessionThreadEventStreamParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionThreadEventStreamParams + +# Interface: SessionThreadEventStreamParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### last\_event\_id? + +> `optional` **last\_event\_id?**: `string` \| `null` + +从该 Thread Event 之后继续订阅。 diff --git a/docs/api/forward/interfaces/SessionThreadListParams.md b/docs/api/forward/interfaces/SessionThreadListParams.md new file mode 100644 index 0000000..4b80243 --- /dev/null +++ b/docs/api/forward/interfaces/SessionThreadListParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionThreadListParams + +# Interface: SessionThreadListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +返回该 Thread ID 之后的记录。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +返回该 Thread ID 之前的记录。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，范围为 1–100。 diff --git a/docs/api/forward/interfaces/SessionThreadStopReason.md b/docs/api/forward/interfaces/SessionThreadStopReason.md new file mode 100644 index 0000000..bcd9ca7 --- /dev/null +++ b/docs/api/forward/interfaces/SessionThreadStopReason.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionThreadStopReason + +# Interface: SessionThreadStopReason + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/SessionUpdateParams.md b/docs/api/forward/interfaces/SessionUpdateParams.md new file mode 100644 index 0000000..8d13921 --- /dev/null +++ b/docs/api/forward/interfaces/SessionUpdateParams.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionUpdateParams + +# Interface: SessionUpdateParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### config? + +> `optional` **config?**: [`SessionUpdateParamsConfigParam`](SessionUpdateParamsConfigParam.md) \| `null` + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +metadata merge patch；传入的 key 覆盖已有 key，未出现的 key 保留。 + +*** + +### title? + +> `optional` **title?**: `string` \| `null` + +新的 Session 标题。 diff --git a/docs/api/forward/interfaces/SessionUpdateParamsConfigParam.md b/docs/api/forward/interfaces/SessionUpdateParamsConfigParam.md new file mode 100644 index 0000000..43f24d2 --- /dev/null +++ b/docs/api/forward/interfaces/SessionUpdateParamsConfigParam.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionUpdateParamsConfigParam + +# Interface: SessionUpdateParamsConfigParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### environment\_variables? + +> `optional` **environment\_variables?**: `Record`\<`string`, `unknown`\> \| `null` diff --git a/docs/api/forward/interfaces/SessionUsage.md b/docs/api/forward/interfaces/SessionUsage.md new file mode 100644 index 0000000..25dd5e0 --- /dev/null +++ b/docs/api/forward/interfaces/SessionUsage.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionUsage + +# Interface: SessionUsage + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### total\_credits + +> **total\_credits**: `number` diff --git a/docs/api/forward/interfaces/Skill.md b/docs/api/forward/interfaces/Skill.md new file mode 100644 index 0000000..ae46df6 --- /dev/null +++ b/docs/api/forward/interfaces/Skill.md @@ -0,0 +1,85 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Skill + +# Interface: Skill + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### binding\_info + +> **binding\_info**: `Record`\<`string`, `number`\> + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### description + +> **description**: `string` + +*** + +### display\_title + +> **display\_title**: `string` + +*** + +### icon\_url + +> **icon\_url**: `string` \| `null` + +*** + +### id + +> **id**: `string` + +*** + +### identity\_id + +> **identity\_id**: `string` \| `null` + +*** + +### latest\_version + +> **latest\_version**: `string` + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +*** + +### source + +> **source**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/forward/interfaces/SkillBinding.md b/docs/api/forward/interfaces/SkillBinding.md new file mode 100644 index 0000000..1e9274b --- /dev/null +++ b/docs/api/forward/interfaces/SkillBinding.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillBinding + +# Interface: SkillBinding + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### skill\_id + +> **skill\_id**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### version + +> **version**: `string` diff --git a/docs/api/forward/interfaces/SkillBindingParam.md b/docs/api/forward/interfaces/SkillBindingParam.md new file mode 100644 index 0000000..307b3c8 --- /dev/null +++ b/docs/api/forward/interfaces/SkillBindingParam.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillBindingParam + +# Interface: SkillBindingParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +*** + +### skill\_id + +> **skill\_id**: `string` + +*** + +### type + +> **type**: `string` + +*** + +### version? + +> `optional` **version?**: `string` \| `null` diff --git a/docs/api/forward/interfaces/SkillGetParams.md b/docs/api/forward/interfaces/SkillGetParams.md new file mode 100644 index 0000000..41eeb0d --- /dev/null +++ b/docs/api/forward/interfaces/SkillGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillGetParams + +# Interface: SkillGetParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### include\_content? + +> `optional` **include\_content?**: `boolean` \| `null` + +⚠️ **已弃用**：为 `true` 时随响应返回 `content` 与 `content_encoding`（base64 zip）。命中时响应头会返回 `Deprecation: true`。请改用 [下载 Skill 版本内容](./Versions/download.md)。 diff --git a/docs/api/forward/interfaces/SkillListParams.md b/docs/api/forward/interfaces/SkillListParams.md new file mode 100644 index 0000000..24e070b --- /dev/null +++ b/docs/api/forward/interfaces/SkillListParams.md @@ -0,0 +1,69 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillListParams + +# Interface: SkillListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标；与 `page`、`before_id` 互斥。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标；与 `page`、`after_id` 互斥。 + +*** + +### display\_title? + +> `optional` **display\_title?**: `string` \| `null` + +按 Skill 展示名前缀搜索，不区分大小写。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +⚠️ **已弃用**：`display_title` 的兼容别名，语义完全一致。请使用 `display_title`。 + +*** + +### page? + +> `optional` **page?**: `string` \| `null` + +分页游标（推荐使用），取值来自上一页响应的 `next_page`；与 `after_id`、`before_id` 互斥。 + +*** + +### source? + +> `optional` **source?**: `string` \| `null` + +按 Skill 来源过滤，可选 `custom`、`qoder`。传 `source` 时不支持 `before_id`。 diff --git a/docs/api/forward/interfaces/SkillNewParams.md b/docs/api/forward/interfaces/SkillNewParams.md new file mode 100644 index 0000000..d8e2f37 --- /dev/null +++ b/docs/api/forward/interfaces/SkillNewParams.md @@ -0,0 +1,77 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillNewParams + +# Interface: SkillNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### description? + +> `optional` **description?**: `string` \| `null` + +⚠️ **已弃用**：最终描述始终从 `SKILL.md` 解析。 + +*** + +### file? + +> `optional` **file?**: [`Uploadable`](../../index/type-aliases/Uploadable.md) \| `null` + +⚠️ **已弃用**：单个 `.zip` 包，宽松包规则。命中时响应头返回 `Deprecation: true`。请迁移到 `files`。 + +*** + +### files? + +> `optional` **files?**: [`Uploadable`](../../index/type-aliases/Uploadable.md)[] \| `null` + +推荐上传字段，可**重复出现**多次。支持两种形态： ① 单个 `.zip` 包； ② 裸文件树——每个 part 独立上传一个文件，`filename` 携带相对路径（如 `code-review/SKILL.md`、`code-review/scripts/run.sh`）。 压缩包本身与解压后总大小均不超过 50 MB。 + +*** + +### icon\_id? + +> `optional` **icon\_id?**: `string` \| `null` + +Forward Resource icon 公开 ID。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +建议提供。相同 key 且规范化后的 `files` 指纹一致时可安全重试。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +调用方元数据对象，最多 15 个键；`created_by` 为保留字段，不可传入（传入返回 400）。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +⚠️ **已弃用**：最终名称始终从上传包内 `SKILL.md` frontmatter 的 `name` 解析。字段保留仅为兼容，传入将被忽略。 + +*** + +### type? + +> `optional` **type?**: `string` \| `null` + +⚠️ **已弃用**：Skill 创建类型，可选 `custom`、`prebuilt`，默认 `custom`。`prebuilt` 会使响应 `source` 字段返回 `qoder`（其余为 `custom`）。 diff --git a/docs/api/forward/interfaces/SkillOverride.md b/docs/api/forward/interfaces/SkillOverride.md new file mode 100644 index 0000000..4896877 --- /dev/null +++ b/docs/api/forward/interfaces/SkillOverride.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillOverride + +# Interface: SkillOverride + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### type + +> **type**: `string` + +*** + +### version + +> **version**: `string` diff --git a/docs/api/forward/interfaces/SkillOverrideParam.md b/docs/api/forward/interfaces/SkillOverrideParam.md new file mode 100644 index 0000000..22b61bd --- /dev/null +++ b/docs/api/forward/interfaces/SkillOverrideParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillOverrideParam + +# Interface: SkillOverrideParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +*** + +### type? + +> `optional` **type?**: `string` \| `null` + +*** + +### version? + +> `optional` **version?**: `string` \| `null` diff --git a/docs/api/forward/interfaces/SkillUpdateParams.md b/docs/api/forward/interfaces/SkillUpdateParams.md new file mode 100644 index 0000000..6810ccc --- /dev/null +++ b/docs/api/forward/interfaces/SkillUpdateParams.md @@ -0,0 +1,61 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillUpdateParams + +# Interface: SkillUpdateParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content? + +> `optional` **content?**: `string` \| `null` + +新内容（zip 包内容）。压缩包本身与解压后总大小均不超过 50 MB，超过返回 400；请求体整体（含 base64 编码与 JSON 信封）上限约 67.7 MB，超过返回 413。 + +*** + +### content\_encoding? + +> `optional` **content\_encoding?**: `string` \| `null` + +`content` 的编码。支持 `base64`、`utf-8`、`utf8`、`plain`、`text`；省略时按 UTF-8 文本处理。传入该字段时必须同时提供非空 `content`。 + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +新描述。 + +*** + +### icon\_id? + +> `optional` **icon\_id?**: `string` \| `null` + +更新或清空 Forward icon。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +元数据对象，会**替换**当前 metadata（非合并）；传入时不能为 `null`，value 必须为 string。`created_by` 为保留字段，不可传入（传入返回 400）。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +⚠️ **已弃用**：技能名不可修改。传入必须与当前规范名完全一致，否则返回 400；一致时为空操作。 diff --git a/docs/api/forward/interfaces/SkillVersion.md b/docs/api/forward/interfaces/SkillVersion.md new file mode 100644 index 0000000..5c7f153 --- /dev/null +++ b/docs/api/forward/interfaces/SkillVersion.md @@ -0,0 +1,79 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillVersion + +# Interface: SkillVersion + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content\_sha256 + +> **content\_sha256**: `string` + +*** + +### content\_size + +> **content\_size**: `number` + +*** + +### created\_at + +> **created\_at**: `string` + +*** + +### description + +> **description**: `string` + +*** + +### directory + +> **directory**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +*** + +### name + +> **name**: `string` + +*** + +### skill\_id + +> **skill\_id**: `string` + +*** + +### status + +> **status**: `string` + +*** + +### version + +> **version**: `string` diff --git a/docs/api/forward/interfaces/SkillVersionListParams.md b/docs/api/forward/interfaces/SkillVersionListParams.md new file mode 100644 index 0000000..5eff7c6 --- /dev/null +++ b/docs/api/forward/interfaces/SkillVersionListParams.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillVersionListParams + +# Interface: SkillVersionListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100，默认 20。 + +*** + +### page? + +> `optional` **page?**: `string` \| `null` + +向后翻页游标；取值来自上一页响应的 `next_page`；不传即从第一页开始。 diff --git a/docs/api/forward/interfaces/SkillVersionNewParams.md b/docs/api/forward/interfaces/SkillVersionNewParams.md new file mode 100644 index 0000000..9bbd97e --- /dev/null +++ b/docs/api/forward/interfaces/SkillVersionNewParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillVersionNewParams + +# Interface: SkillVersionNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### files + +> **files**: [`Uploadable`](../../index/type-aliases/Uploadable.md)[] + +上传字段，可**重复**出现多次。支持两种形态： • 单个 `.zip` 包； • 裸文件树——每个 part 独立上传一个文件，`filename` 携带相对路径（如 `customer-reply/SKILL.md`、`customer-reply/scripts/run.sh`）。 压缩包本身与解压后总大小均不超过 50 MB。 diff --git a/docs/api/forward/interfaces/SystemOverride.md b/docs/api/forward/interfaces/SystemOverride.md new file mode 100644 index 0000000..d9ef886 --- /dev/null +++ b/docs/api/forward/interfaces/SystemOverride.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SystemOverride + +# Interface: SystemOverride + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content + +> **content**: `string` + +*** + +### mode + +> **mode**: `string` diff --git a/docs/api/forward/interfaces/SystemOverrideParam.md b/docs/api/forward/interfaces/SystemOverrideParam.md new file mode 100644 index 0000000..04475c3 --- /dev/null +++ b/docs/api/forward/interfaces/SystemOverrideParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SystemOverrideParam + +# Interface: SystemOverrideParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### content? + +> `optional` **content?**: `string` \| `null` + +*** + +### mode? + +> `optional` **mode?**: `string` \| `null` diff --git a/docs/api/forward/interfaces/Template.md b/docs/api/forward/interfaces/Template.md new file mode 100644 index 0000000..62522c4 --- /dev/null +++ b/docs/api/forward/interfaces/Template.md @@ -0,0 +1,141 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Template + +# Interface: Template + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### created\_at + +> **created\_at**: `string` + +*** + +### description + +> **description**: `string` + +*** + +### environment\_id + +> **environment\_id**: `string` + +默认 Environment ID。 + +*** + +### environment\_variables + +> **environment\_variables**: `Record`\<`string`, `string`\> + +*** + +### files + +> **files**: `Record`\<`string`, [`ResourceBinding`](ResourceBinding.md)\> + +*** + +### github\_repositories + +> **github\_repositories**: `Record`\<`string`, [`GitHubRepository`](GitHubRepository.md)\> + +*** + +### id + +> **id**: `string` + +Template ID。 + +*** + +### mcp\_servers + +> **mcp\_servers**: [`MCPServer`](MCPServer.md)[] + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +自定义元数据。 + +*** + +### model + +> **model**: [`ModelConfig`](../type-aliases/ModelConfig.md) + +与请求提交的形态一致；对象形态保留 `id`、`effort` 和 `context_window`。 + +*** + +### multiagent + +> **multiagent**: [`MultiagentConfig`](MultiagentConfig.md) + +*** + +### name + +> **name**: `string` + +Template 名称。 + +*** + +### skills + +> **skills**: [`SkillBinding`](SkillBinding.md)[] + +*** + +### status + +> **status**: `string` + +`active` 或 `archived`。 + +*** + +### system + +> **system**: `string` + +*** + +### tools + +> **tools**: [`Tool`](Tool.md)[] + +*** + +### type + +> **type**: `string` + +固定为 `template`。 + +*** + +### updated\_at + +> **updated\_at**: `string` + +*** + +### vaults + +> **vaults**: `Record`\<`string`, [`ResourceBinding`](ResourceBinding.md)\> diff --git a/docs/api/forward/interfaces/TemplateArchiveParams.md b/docs/api/forward/interfaces/TemplateArchiveParams.md new file mode 100644 index 0000000..4ccc293 --- /dev/null +++ b/docs/api/forward/interfaces/TemplateArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / TemplateArchiveParams + +# Interface: TemplateArchiveParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 diff --git a/docs/api/forward/interfaces/TemplateCloneParams.md b/docs/api/forward/interfaces/TemplateCloneParams.md new file mode 100644 index 0000000..0723a18 --- /dev/null +++ b/docs/api/forward/interfaces/TemplateCloneParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / TemplateCloneParams + +# Interface: TemplateCloneParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### description? + +> `optional` **description?**: `string` \| `null` + +新 Template 描述；不传时沿用源描述。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +新 Template 名称；不传时使用 `<源名称> Copy <随机短 ID>`。 diff --git a/docs/api/forward/interfaces/TemplateListParams.md b/docs/api/forward/interfaces/TemplateListParams.md new file mode 100644 index 0000000..e9d4cbb --- /dev/null +++ b/docs/api/forward/interfaces/TemplateListParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / TemplateListParams + +# Interface: TemplateListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标，不能与 `before_id` 同用。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标，不能与 `after_id` 同用。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### status? + +> `optional` **status?**: `string` \| `null` + +按 `active` 或 `archived` 过滤。 diff --git a/docs/api/forward/interfaces/TemplateNewParams.md b/docs/api/forward/interfaces/TemplateNewParams.md new file mode 100644 index 0000000..ba0e86c --- /dev/null +++ b/docs/api/forward/interfaces/TemplateNewParams.md @@ -0,0 +1,141 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / TemplateNewParams + +# Interface: TemplateNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### description? + +> `optional` **description?**: `string` \| `null` + +Template 描述，最多 2048 个字符。 + +*** + +### environment\_id + +> **environment\_id**: `string` + +创建 Session 时默认使用的 Environment ID。 + +*** + +### environment\_variables? + +> `optional` **environment\_variables?**: [`EnvironmentVariablesUnionParam`](../type-aliases/EnvironmentVariablesUnionParam.md) + +默认 Session 环境变量。 + +*** + +### files? + +> `optional` **files?**: `Record`\<`string`, [`ResourceBindingParam`](ResourceBindingParam.md)\> \| `null` + +默认文件资源配置，按 file ID 组织。 + +*** + +### github\_repositories? + +> `optional` **github\_repositories?**: `Record`\<`string`, [`GitHubRepositoryParam`](GitHubRepositoryParam.md)\> \| `null` + +默认 GitHub 仓库配置，按调用方指定的 binding key 组织，最多 20 项。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### mcp\_servers? + +> `optional` **mcp\_servers?**: [`MCPServerParam`](MCPServerParam.md)[] \| `null` + +MCP Server 配置列表，最多 20 项。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +自定义元数据。 + +*** + +### model + +> **model**: [`ModelConfigUnionParam`](../type-aliases/ModelConfigUnionParam.md) + +模型标识。可传 string（如 `"ultimate"`），或传 Agent model 对象以同时配置 `effort` 或 `context_window`。可通过列出模型接口查询可用值。 + +*** + +### multiagent? + +> `optional` **multiagent?**: [`MultiagentConfigParam`](MultiagentConfigParam.md) \| `null` + +Multi-agent 协作配置。`type` 必须为 `coordinator`；省略或传 `null` 表示不启用。 + +*** + +### name + +> **name**: `string` + +Template 名称，1-256 个字符，租户内唯一。 + +*** + +### skills? + +> `optional` **skills?**: [`SkillBindingParam`](SkillBindingParam.md)[] \| `null` + +Skill 绑定列表，最多 20 项。 + +*** + +### system? + +> `optional` **system?**: `string` \| `null` + +System Prompt，最多 100,000 个字符。 + +*** + +### tools? + +> `optional` **tools?**: [`ToolParam`](ToolParam.md)[] \| `null` + +工具配置列表，最多 128 项。 + +*** + +### vaults? + +> `optional` **vaults?**: `Record`\<`string`, [`ResourceBindingParam`](ResourceBindingParam.md)\> \| `null` + +默认 Vault 配置，按 Vault ID 组织。 + +*** + +### x\_qoder\_beta? + +> `optional` **x\_qoder\_beta?**: `string` \| `null` + +启用 Browser Use 时必须设置为 `browser-use-2026-07-14`。 diff --git a/docs/api/forward/interfaces/TemplateUpdateParams.md b/docs/api/forward/interfaces/TemplateUpdateParams.md new file mode 100644 index 0000000..8abf9f9 --- /dev/null +++ b/docs/api/forward/interfaces/TemplateUpdateParams.md @@ -0,0 +1,141 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / TemplateUpdateParams + +# Interface: TemplateUpdateParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### description? + +> `optional` **description?**: `string` \| `null` + +新的 Template 描述。 + +*** + +### environment\_id? + +> `optional` **environment\_id?**: `string` \| `null` + +替换默认 Environment ID；`null` 或空字符串表示清空。 + +*** + +### environment\_variables? + +> `optional` **environment\_variables?**: [`EnvironmentVariablesUnionParam`](../type-aliases/EnvironmentVariablesUnionParam.md) + +整体替换默认环境变量；`null` 表示清空。 + +*** + +### files? + +> `optional` **files?**: `Record`\<`string`, [`ResourceBindingParam`](ResourceBindingParam.md)\> \| `null` + +整体替换默认文件资源配置；`null` 表示清空。 + +*** + +### github\_repositories? + +> `optional` **github\_repositories?**: `Record`\<`string`, [`GitHubRepositoryParam`](GitHubRepositoryParam.md)\> \| `null` + +整体替换默认 GitHub 仓库配置；按 binding key 组织，`null` 或空 object 表示清空。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +有副作用请求可选的幂等键。 + +*** + +### mcp\_servers? + +> `optional` **mcp\_servers?**: [`MCPServerParam`](MCPServerParam.md)[] \| `null` + +整体替换 MCP Server 列表。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +合并更新自定义元数据。 + +*** + +### model? + +> `optional` **model?**: [`ModelConfigUnionParam`](../type-aliases/ModelConfigUnionParam.md) + +新的模型标识。可传 string，或传 Agent model 对象以同时配置 `effort` 或 `context_window`。可通过列出模型接口查询可用值。 + +*** + +### multiagent? + +> `optional` **multiagent?**: [`MultiagentConfigParam`](MultiagentConfigParam.md) \| `null` + +整体替换 Multi-agent 协作配置；传 `null` 表示清空，省略则保留当前配置。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +新的 Template 名称。 + +*** + +### skills? + +> `optional` **skills?**: [`SkillBindingParam`](SkillBindingParam.md)[] \| `null` + +整体替换 Skill 绑定列表。 + +*** + +### system? + +> `optional` **system?**: `string` \| `null` + +新的 System Prompt。 + +*** + +### tools? + +> `optional` **tools?**: [`ToolParam`](ToolParam.md)[] \| `null` + +整体替换工具配置列表。 + +*** + +### vaults? + +> `optional` **vaults?**: `Record`\<`string`, [`ResourceBindingParam`](ResourceBindingParam.md)\> \| `null` + +整体替换默认 Vault 配置；按 Vault ID 组织，`null` 表示清空。 + +*** + +### x\_qoder\_beta? + +> `optional` **x\_qoder\_beta?**: `string` \| `null` + +更新后的 `tools` 中包含 Browser Use 工具集时，必须设置为 `browser-use-2026-07-14`。 diff --git a/docs/api/forward/interfaces/Tool.md b/docs/api/forward/interfaces/Tool.md new file mode 100644 index 0000000..c64eb78 --- /dev/null +++ b/docs/api/forward/interfaces/Tool.md @@ -0,0 +1,61 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Tool + +# Interface: Tool + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### configs + +> **configs**: [`ToolConfig`](ToolConfig.md)[] + +*** + +### description + +> **description**: `string` + +*** + +### disallowed\_tools + +> **disallowed\_tools**: `string`[] + +*** + +### enabled\_tools + +> **enabled\_tools**: `string`[] + +*** + +### input\_schema + +> **input\_schema**: `Record`\<`string`, `unknown`\> + +*** + +### mcp\_server\_name + +> **mcp\_server\_name**: `string` + +*** + +### name + +> **name**: `string` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/ToolConfig.md b/docs/api/forward/interfaces/ToolConfig.md new file mode 100644 index 0000000..6974b54 --- /dev/null +++ b/docs/api/forward/interfaces/ToolConfig.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ToolConfig + +# Interface: ToolConfig + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### name + +> **name**: `string` + +*** + +### permission\_policy + +> **permission\_policy**: [`PermissionPolicy`](PermissionPolicy.md) diff --git a/docs/api/forward/interfaces/ToolConfigParam.md b/docs/api/forward/interfaces/ToolConfigParam.md new file mode 100644 index 0000000..b60e361 --- /dev/null +++ b/docs/api/forward/interfaces/ToolConfigParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ToolConfigParam + +# Interface: ToolConfigParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +*** + +### name + +> **name**: `string` + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`PermissionPolicyParam`](PermissionPolicyParam.md) \| `null` diff --git a/docs/api/forward/interfaces/ToolOverride.md b/docs/api/forward/interfaces/ToolOverride.md new file mode 100644 index 0000000..b8d2b5f --- /dev/null +++ b/docs/api/forward/interfaces/ToolOverride.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ToolOverride + +# Interface: ToolOverride + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### permission\_policy + +> **permission\_policy**: [`PermissionPolicy`](PermissionPolicy.md) diff --git a/docs/api/forward/interfaces/ToolOverrideParam.md b/docs/api/forward/interfaces/ToolOverrideParam.md new file mode 100644 index 0000000..7f4ef1e --- /dev/null +++ b/docs/api/forward/interfaces/ToolOverrideParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ToolOverrideParam + +# Interface: ToolOverrideParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`PermissionPolicyParam`](PermissionPolicyParam.md) \| `null` diff --git a/docs/api/forward/interfaces/ToolParam.md b/docs/api/forward/interfaces/ToolParam.md new file mode 100644 index 0000000..1c040e0 --- /dev/null +++ b/docs/api/forward/interfaces/ToolParam.md @@ -0,0 +1,61 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ToolParam + +# Interface: ToolParam + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### configs? + +> `optional` **configs?**: [`ToolConfigParam`](ToolConfigParam.md)[] \| `null` + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +*** + +### disallowed\_tools? + +> `optional` **disallowed\_tools?**: `string`[] \| `null` + +*** + +### enabled\_tools? + +> `optional` **enabled\_tools?**: `string`[] \| `null` + +*** + +### input\_schema? + +> `optional` **input\_schema?**: `Record`\<`string`, `unknown`\> \| `null` + +*** + +### mcp\_server\_name? + +> `optional` **mcp\_server\_name?**: `string` \| `null` + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/Vault.md b/docs/api/forward/interfaces/Vault.md new file mode 100644 index 0000000..fcf4ed3 --- /dev/null +++ b/docs/api/forward/interfaces/Vault.md @@ -0,0 +1,69 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / Vault + +# Interface: Vault + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### created\_at + +> **created\_at**: `string` + +创建时间，RFC 3339 格式。 + +*** + +### display\_name + +> **display\_name**: `string` + +Vault 展示名。 + +*** + +### id + +> **id**: `string` + +Vault ID。 + +*** + +### identity\_id + +> **identity\_id**: `string` \| `null` + +Forward 归属身份。 + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +Vault 元数据。 + +*** + +### type + +> **type**: `string` + +固定为 `vault`。 + +*** + +### updated\_at + +> **updated\_at**: `string` + +最后更新时间，RFC 3339 格式。 diff --git a/docs/api/forward/interfaces/VaultCredential.md b/docs/api/forward/interfaces/VaultCredential.md new file mode 100644 index 0000000..68ee3d0 --- /dev/null +++ b/docs/api/forward/interfaces/VaultCredential.md @@ -0,0 +1,77 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / VaultCredential + +# Interface: VaultCredential + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### auth + +> **auth**: [`VaultCredentialAuth`](VaultCredentialAuth.md) + +脱敏后的认证信息。 + +*** + +### created\_at + +> **created\_at**: `string` + +创建时间，RFC 3339 格式。 + +*** + +### display\_name + +> **display\_name**: `string` + +当前固定为空字符串。 + +*** + +### id + +> **id**: `string` + +Credential ID。 + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +Credential 元数据。 + +*** + +### type + +> **type**: `string` + +固定为 `vault_credential`。 + +*** + +### updated\_at + +> **updated\_at**: `string` + +最后更新时间，RFC 3339 格式。 + +*** + +### vault\_id + +> **vault\_id**: `string` + +所属 Vault ID。 diff --git a/docs/api/forward/interfaces/VaultCredentialAuth.md b/docs/api/forward/interfaces/VaultCredentialAuth.md new file mode 100644 index 0000000..e4ef898 --- /dev/null +++ b/docs/api/forward/interfaces/VaultCredentialAuth.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / VaultCredentialAuth + +# Interface: VaultCredentialAuth + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### mcp\_server\_url + +> **mcp\_server\_url**: `string` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/forward/interfaces/VaultCredentialListParams.md b/docs/api/forward/interfaces/VaultCredentialListParams.md new file mode 100644 index 0000000..14a86d7 --- /dev/null +++ b/docs/api/forward/interfaces/VaultCredentialListParams.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / VaultCredentialListParams + +# Interface: VaultCredentialListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标；与 `page`、`before_id` 互斥。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标；与 `page`、`after_id` 互斥。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +按 `mcp_server_url` 搜索。 + +*** + +### page? + +> `optional` **page?**: `string` \| `null` + +分页游标（推荐使用），取值来自上一页响应的 `next_page`；与 `after_id`、`before_id` 互斥。 diff --git a/docs/api/forward/interfaces/VaultCredentialNewParams.md b/docs/api/forward/interfaces/VaultCredentialNewParams.md new file mode 100644 index 0000000..0cc610b --- /dev/null +++ b/docs/api/forward/interfaces/VaultCredentialNewParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / VaultCredentialNewParams + +# Interface: VaultCredentialNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### auth + +> **auth**: `Record`\<`string`, `unknown`\> + +Credential 认证信息，支持 `static_bearer`、`mcp_oauth`；响应只返回脱敏后的非密文字段。 + +*** + +### display\_name? + +> `optional` **display\_name?**: `string` \| `null` + +兼容字段；当前不持久化，Forward 响应固定为空字符串。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +可选创建请求幂等键。相同 key 只能用于相同请求。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +元数据对象；`created_by` 为保留字段，不可传入（传入返回 400）。 diff --git a/docs/api/forward/interfaces/VaultListParams.md b/docs/api/forward/interfaces/VaultListParams.md new file mode 100644 index 0000000..ca81041 --- /dev/null +++ b/docs/api/forward/interfaces/VaultListParams.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / VaultListParams + +# Interface: VaultListParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` \| `null` + +向后翻页游标；与 `page`、`before_id` 互斥。 + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` \| `null` + +向前翻页游标；与 `page`、`after_id` 互斥。 + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +分页大小，最大 100。 + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +按 `display_name` 搜索。 + +*** + +### page? + +> `optional` **page?**: `string` \| `null` + +分页游标（推荐使用），取值来自上一页响应的 `next_page`；与 `after_id`、`before_id` 互斥。 diff --git a/docs/api/forward/interfaces/VaultNewParams.md b/docs/api/forward/interfaces/VaultNewParams.md new file mode 100644 index 0000000..33997aa --- /dev/null +++ b/docs/api/forward/interfaces/VaultNewParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / VaultNewParams + +# Interface: VaultNewParams + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional fields are preserved verbatim by the SDK. + +## Properties + +### display\_name + +> **display\_name**: `string` + +Vault 展示名。 + +*** + +### idempotency\_key? + +> `optional` **idempotency\_key?**: `string` \| `null` + +可选创建请求幂等键。传入时相同 key 只能用于相同请求；不传时不提供本地幂等重放保护。 + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +元数据对象；`created_by` 为保留字段，不可传入（传入返回 400）。 diff --git a/docs/api/forward/type-aliases/BatchCreateParams.md b/docs/api/forward/type-aliases/BatchCreateParams.md new file mode 100644 index 0000000..26c913c --- /dev/null +++ b/docs/api/forward/type-aliases/BatchCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / BatchCreateParams + +# Type Alias: BatchCreateParams + +> **BatchCreateParams** = [`BatchNewParams`](../interfaces/BatchNewParams.md) diff --git a/docs/api/forward/type-aliases/ChannelCreateParams.md b/docs/api/forward/type-aliases/ChannelCreateParams.md new file mode 100644 index 0000000..dda9436 --- /dev/null +++ b/docs/api/forward/type-aliases/ChannelCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelCreateParams + +# Type Alias: ChannelCreateParams + +> **ChannelCreateParams** = [`ChannelNewParams`](../interfaces/ChannelNewParams.md) diff --git a/docs/api/forward/type-aliases/ChannelPairingCreateParams.md b/docs/api/forward/type-aliases/ChannelPairingCreateParams.md new file mode 100644 index 0000000..c6bcdc7 --- /dev/null +++ b/docs/api/forward/type-aliases/ChannelPairingCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelPairingCreateParams + +# Type Alias: ChannelPairingCreateParams + +> **ChannelPairingCreateParams** = [`ChannelPairingNewParams`](../interfaces/ChannelPairingNewParams.md) diff --git a/docs/api/forward/type-aliases/ChannelQRSessionCreateParams.md b/docs/api/forward/type-aliases/ChannelQRSessionCreateParams.md new file mode 100644 index 0000000..c08c203 --- /dev/null +++ b/docs/api/forward/type-aliases/ChannelQRSessionCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ChannelQRSessionCreateParams + +# Type Alias: ChannelQRSessionCreateParams + +> **ChannelQRSessionCreateParams** = [`ChannelQRSessionNewParams`](../interfaces/ChannelQRSessionNewParams.md) diff --git a/docs/api/forward/type-aliases/EnvironmentCreateParams.md b/docs/api/forward/type-aliases/EnvironmentCreateParams.md new file mode 100644 index 0000000..aee19c9 --- /dev/null +++ b/docs/api/forward/type-aliases/EnvironmentCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EnvironmentCreateParams + +# Type Alias: EnvironmentCreateParams + +> **EnvironmentCreateParams** = [`EnvironmentNewParams`](../interfaces/EnvironmentNewParams.md) diff --git a/docs/api/forward/type-aliases/EnvironmentVariablesUnionParam.md b/docs/api/forward/type-aliases/EnvironmentVariablesUnionParam.md new file mode 100644 index 0000000..b852a40 --- /dev/null +++ b/docs/api/forward/type-aliases/EnvironmentVariablesUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EnvironmentVariablesUnionParam + +# Type Alias: EnvironmentVariablesUnionParam + +> **EnvironmentVariablesUnionParam** = `Record`\<`string`, `unknown`\> \| `null` \| `string` \| `null` diff --git a/docs/api/forward/type-aliases/EventContentUnionParam.md b/docs/api/forward/type-aliases/EventContentUnionParam.md new file mode 100644 index 0000000..1bb7527 --- /dev/null +++ b/docs/api/forward/type-aliases/EventContentUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / EventContentUnionParam + +# Type Alias: EventContentUnionParam + +> **EventContentUnionParam** = [`ContentBlockParam`](../interfaces/ContentBlockParam.md)[] \| `null` \| `string` \| `null` \| `Record`\<`string`, `unknown`\> \| `null` diff --git a/docs/api/forward/type-aliases/ForwardClientOptions.md b/docs/api/forward/type-aliases/ForwardClientOptions.md new file mode 100644 index 0000000..defcdb0 --- /dev/null +++ b/docs/api/forward/type-aliases/ForwardClientOptions.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ForwardClientOptions + +# Type Alias: ForwardClientOptions + +> **ForwardClientOptions** = [`ClientOptions`](../../index/interfaces/ClientOptions.md) diff --git a/docs/api/forward/type-aliases/IdentityCreateParams.md b/docs/api/forward/type-aliases/IdentityCreateParams.md new file mode 100644 index 0000000..7c76937 --- /dev/null +++ b/docs/api/forward/type-aliases/IdentityCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / IdentityCreateParams + +# Type Alias: IdentityCreateParams + +> **IdentityCreateParams** = [`IdentityNewParams`](../interfaces/IdentityNewParams.md) diff --git a/docs/api/forward/type-aliases/MemoryStoreCreateParams.md b/docs/api/forward/type-aliases/MemoryStoreCreateParams.md new file mode 100644 index 0000000..87ace9e --- /dev/null +++ b/docs/api/forward/type-aliases/MemoryStoreCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreCreateParams + +# Type Alias: MemoryStoreCreateParams + +> **MemoryStoreCreateParams** = [`MemoryStoreNewParams`](../interfaces/MemoryStoreNewParams.md) diff --git a/docs/api/forward/type-aliases/MemoryStoreMemoryCreateParams.md b/docs/api/forward/type-aliases/MemoryStoreMemoryCreateParams.md new file mode 100644 index 0000000..9d8880e --- /dev/null +++ b/docs/api/forward/type-aliases/MemoryStoreMemoryCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / MemoryStoreMemoryCreateParams + +# Type Alias: MemoryStoreMemoryCreateParams + +> **MemoryStoreMemoryCreateParams** = [`MemoryStoreMemoryNewParams`](../interfaces/MemoryStoreMemoryNewParams.md) diff --git a/docs/api/forward/type-aliases/ModelConfig.md b/docs/api/forward/type-aliases/ModelConfig.md new file mode 100644 index 0000000..9868ded --- /dev/null +++ b/docs/api/forward/type-aliases/ModelConfig.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ModelConfig + +# Type Alias: ModelConfig + +> **ModelConfig** = `string` \| [`ModelConfigObject`](../interfaces/ModelConfigObject.md) diff --git a/docs/api/forward/type-aliases/ModelConfigUnionParam.md b/docs/api/forward/type-aliases/ModelConfigUnionParam.md new file mode 100644 index 0000000..218ca06 --- /dev/null +++ b/docs/api/forward/type-aliases/ModelConfigUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ModelConfigUnionParam + +# Type Alias: ModelConfigUnionParam + +> **ModelConfigUnionParam** = `string` \| `null` \| [`ModelConfigParam`](../interfaces/ModelConfigParam.md) \| `null` diff --git a/docs/api/forward/type-aliases/ScheduleCreateParams.md b/docs/api/forward/type-aliases/ScheduleCreateParams.md new file mode 100644 index 0000000..4bddf3b --- /dev/null +++ b/docs/api/forward/type-aliases/ScheduleCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleCreateParams + +# Type Alias: ScheduleCreateParams + +> **ScheduleCreateParams** = [`ScheduleNewParams`](../interfaces/ScheduleNewParams.md) diff --git a/docs/api/forward/type-aliases/ScheduleRunRetrieveParams.md b/docs/api/forward/type-aliases/ScheduleRunRetrieveParams.md new file mode 100644 index 0000000..199eed6 --- /dev/null +++ b/docs/api/forward/type-aliases/ScheduleRunRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / ScheduleRunRetrieveParams + +# Type Alias: ScheduleRunRetrieveParams + +> **ScheduleRunRetrieveParams** = [`ScheduleRunGetParams`](../interfaces/ScheduleRunGetParams.md) diff --git a/docs/api/forward/type-aliases/SessionCreateParams.md b/docs/api/forward/type-aliases/SessionCreateParams.md new file mode 100644 index 0000000..e68b19b --- /dev/null +++ b/docs/api/forward/type-aliases/SessionCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SessionCreateParams + +# Type Alias: SessionCreateParams + +> **SessionCreateParams** = [`SessionNewParams`](../interfaces/SessionNewParams.md) diff --git a/docs/api/forward/type-aliases/SkillCreateParams.md b/docs/api/forward/type-aliases/SkillCreateParams.md new file mode 100644 index 0000000..fb6863d --- /dev/null +++ b/docs/api/forward/type-aliases/SkillCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillCreateParams + +# Type Alias: SkillCreateParams + +> **SkillCreateParams** = [`SkillNewParams`](../interfaces/SkillNewParams.md) diff --git a/docs/api/forward/type-aliases/SkillRetrieveParams.md b/docs/api/forward/type-aliases/SkillRetrieveParams.md new file mode 100644 index 0000000..648b7eb --- /dev/null +++ b/docs/api/forward/type-aliases/SkillRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillRetrieveParams + +# Type Alias: SkillRetrieveParams + +> **SkillRetrieveParams** = [`SkillGetParams`](../interfaces/SkillGetParams.md) diff --git a/docs/api/forward/type-aliases/SkillVersionCreateParams.md b/docs/api/forward/type-aliases/SkillVersionCreateParams.md new file mode 100644 index 0000000..756a8e1 --- /dev/null +++ b/docs/api/forward/type-aliases/SkillVersionCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / SkillVersionCreateParams + +# Type Alias: SkillVersionCreateParams + +> **SkillVersionCreateParams** = [`SkillVersionNewParams`](../interfaces/SkillVersionNewParams.md) diff --git a/docs/api/forward/type-aliases/TemplateCreateParams.md b/docs/api/forward/type-aliases/TemplateCreateParams.md new file mode 100644 index 0000000..36f34ec --- /dev/null +++ b/docs/api/forward/type-aliases/TemplateCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / TemplateCreateParams + +# Type Alias: TemplateCreateParams + +> **TemplateCreateParams** = [`TemplateNewParams`](../interfaces/TemplateNewParams.md) diff --git a/docs/api/forward/type-aliases/VaultCreateParams.md b/docs/api/forward/type-aliases/VaultCreateParams.md new file mode 100644 index 0000000..f3898bc --- /dev/null +++ b/docs/api/forward/type-aliases/VaultCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / VaultCreateParams + +# Type Alias: VaultCreateParams + +> **VaultCreateParams** = [`VaultNewParams`](../interfaces/VaultNewParams.md) diff --git a/docs/api/forward/type-aliases/VaultCredentialCreateParams.md b/docs/api/forward/type-aliases/VaultCredentialCreateParams.md new file mode 100644 index 0000000..4430fe4 --- /dev/null +++ b/docs/api/forward/type-aliases/VaultCredentialCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [forward](../README.md) / VaultCredentialCreateParams + +# Type Alias: VaultCredentialCreateParams + +> **VaultCredentialCreateParams** = [`VaultCredentialNewParams`](../interfaces/VaultCredentialNewParams.md) diff --git a/docs/api/index/README.md b/docs/api/index/README.md new file mode 100644 index 0000000..97dc384 --- /dev/null +++ b/docs/api/index/README.md @@ -0,0 +1,61 @@ +[**qca-sdk**](../README.md) + +*** + +[qca-sdk](../README.md) / index + +# index + +## Classes + +- [APIClient](classes/APIClient.md) +- [APIConnectionError](classes/APIConnectionError.md) +- [APIConnectionTimeoutError](classes/APIConnectionTimeoutError.md) +- [APIError](classes/APIError.md) +- [APIPromise](classes/APIPromise.md) +- [APIUserAbortError](classes/APIUserAbortError.md) +- [AuthenticationError](classes/AuthenticationError.md) +- [BadRequestError](classes/BadRequestError.md) +- [ConflictError](classes/ConflictError.md) +- [ForwardClient](classes/ForwardClient.md) +- [InternalServerError](classes/InternalServerError.md) +- [ManagedClient](classes/ManagedClient.md) +- [NotFoundError](classes/NotFoundError.md) +- [Page](classes/Page.md) +- [PagePromise](classes/PagePromise.md) +- [PATCredential](classes/PATCredential.md) +- [PermissionDeniedError](classes/PermissionDeniedError.md) +- [QoderError](classes/QoderError.md) +- [RateLimitError](classes/RateLimitError.md) +- [ResumableSessionEventStream](classes/ResumableSessionEventStream.md) +- [Stream](classes/Stream.md) +- [UnprocessableEntityError](classes/UnprocessableEntityError.md) + +## Interfaces + +- [APIRequestOptions](interfaces/APIRequestOptions.md) +- [ClientOptions](interfaces/ClientOptions.md) +- [Credential](interfaces/Credential.md) +- [PageResponse](interfaces/PageResponse.md) +- [RequestOptions](interfaces/RequestOptions.md) +- [ServerSentEvent](interfaces/ServerSentEvent.md) + +## Type Aliases + +- [HeadersLike](type-aliases/HeadersLike.md) +- [Middleware](type-aliases/Middleware.md) +- [PaginationMode](type-aliases/PaginationMode.md) +- [Uploadable](type-aliases/Uploadable.md) + +## Variables + +- [VERSION](variables/VERSION.md) + +## Functions + +- [decodeSSE](functions/decodeSSE.md) +- [mergeHeaders](functions/mergeHeaders.md) +- [readEnv](functions/readEnv.md) +- [stringifyQuery](functions/stringifyQuery.md) +- [toFile](functions/toFile.md) +- [toMultipartForm](functions/toMultipartForm.md) diff --git a/docs/api/index/classes/APIClient.md b/docs/api/index/classes/APIClient.md new file mode 100644 index 0000000..557721b --- /dev/null +++ b/docs/api/index/classes/APIClient.md @@ -0,0 +1,162 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / APIClient + +# Class: APIClient + +## Extended by + +- [`ForwardClient`](ForwardClient.md) +- [`ManagedClient`](ManagedClient.md) + +## Constructors + +### Constructor + +> **new APIClient**(`options?`, `mode?`): `APIClient` + +#### Parameters + +##### options? + +[`ClientOptions`](../interfaces/ClientOptions.md) = `{}` + +##### mode? + +`"forward"` \| `"managed"` + +#### Returns + +`APIClient` + +## Properties + +### baseURL + +> `readonly` **baseURL**: `string` + +*** + +### defaultHeaders + +> `readonly` **defaultHeaders**: [`HeadersLike`](../type-aliases/HeadersLike.md) \| `undefined` + +*** + +### maxRetries + +> `readonly` **maxRetries**: `number` + +*** + +### mode + +> `readonly` **mode**: `"forward"` \| `"managed"` = `'managed'` + +*** + +### options + +> `protected` `readonly` **options**: [`ClientOptions`](../interfaces/ClientOptions.md) + +*** + +### timeout + +> `readonly` **timeout**: `number` + +## Methods + +### downloadFile() + +> **downloadFile**(`path`, `options?`): [`APIPromise`](APIPromise.md)\<`Response`\> + +Resolve the API grant, then send a separate request without API credentials or headers. + +#### Parameters + +##### path + +`string` + +##### options? + +[`RequestOptions`](../interfaces/RequestOptions.md) = `{}` + +#### Returns + +[`APIPromise`](APIPromise.md)\<`Response`\> + +*** + +### getAPIList() + +> **getAPIList**\<`T`\>(`path`, `query?`, `options?`, `pagination?`): [`PagePromise`](PagePromise.md)\<`T`\> + +#### Type Parameters + +##### T + +`T` + +#### Parameters + +##### path + +`string` + +##### query? + +`object` = `{}` + +##### options? + +[`RequestOptions`](../interfaces/RequestOptions.md) = `{}` + +##### pagination? + +[`PaginationMode`](../type-aliases/PaginationMode.md) = `...` + +#### Returns + +[`PagePromise`](PagePromise.md)\<`T`\> + +*** + +### request() + +> **request**\<`T`\>(`options`): [`APIPromise`](APIPromise.md)\<`T`\> + +#### Type Parameters + +##### T + +`T` + +#### Parameters + +##### options + +[`APIRequestOptions`](../interfaces/APIRequestOptions.md) + +#### Returns + +[`APIPromise`](APIPromise.md)\<`T`\> + +*** + +### validateHeaders() + +> `protected` **validateHeaders**(`headers`): `void` + +#### Parameters + +##### headers + +`Headers` + +#### Returns + +`void` diff --git a/docs/api/index/classes/APIConnectionError.md b/docs/api/index/classes/APIConnectionError.md new file mode 100644 index 0000000..2d95950 --- /dev/null +++ b/docs/api/index/classes/APIConnectionError.md @@ -0,0 +1,79 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / APIConnectionError + +# Class: APIConnectionError + +## Extends + +- [`QoderError`](QoderError.md) + +## Extended by + +- [`APIConnectionTimeoutError`](APIConnectionTimeoutError.md) + +## Constructors + +### Constructor + +> **new APIConnectionError**(`message`, `options?`): `APIConnectionError` + +#### Parameters + +##### message + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`APIConnectionError` + +#### Inherited from + +[`QoderError`](QoderError.md).[`constructor`](QoderError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`QoderError`](QoderError.md).[`cause`](QoderError.md#cause) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`QoderError`](QoderError.md).[`message`](QoderError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`QoderError`](QoderError.md).[`name`](QoderError.md#name) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`QoderError`](QoderError.md).[`stack`](QoderError.md#stack) diff --git a/docs/api/index/classes/APIConnectionTimeoutError.md b/docs/api/index/classes/APIConnectionTimeoutError.md new file mode 100644 index 0000000..c2e3b7c --- /dev/null +++ b/docs/api/index/classes/APIConnectionTimeoutError.md @@ -0,0 +1,75 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / APIConnectionTimeoutError + +# Class: APIConnectionTimeoutError + +## Extends + +- [`APIConnectionError`](APIConnectionError.md) + +## Constructors + +### Constructor + +> **new APIConnectionTimeoutError**(`message`, `options?`): `APIConnectionTimeoutError` + +#### Parameters + +##### message + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`APIConnectionTimeoutError` + +#### Inherited from + +[`APIConnectionError`](APIConnectionError.md).[`constructor`](APIConnectionError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`APIConnectionError`](APIConnectionError.md).[`cause`](APIConnectionError.md#cause) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`APIConnectionError`](APIConnectionError.md).[`message`](APIConnectionError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`APIConnectionError`](APIConnectionError.md).[`name`](APIConnectionError.md#name) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`APIConnectionError`](APIConnectionError.md).[`stack`](APIConnectionError.md#stack) diff --git a/docs/api/index/classes/APIError.md b/docs/api/index/classes/APIError.md new file mode 100644 index 0000000..c75fcd0 --- /dev/null +++ b/docs/api/index/classes/APIError.md @@ -0,0 +1,184 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / APIError + +# Class: APIError + +## Extends + +- [`QoderError`](QoderError.md) + +## Extended by + +- [`BadRequestError`](BadRequestError.md) +- [`AuthenticationError`](AuthenticationError.md) +- [`PermissionDeniedError`](PermissionDeniedError.md) +- [`NotFoundError`](NotFoundError.md) +- [`ConflictError`](ConflictError.md) +- [`UnprocessableEntityError`](UnprocessableEntityError.md) +- [`RateLimitError`](RateLimitError.md) +- [`InternalServerError`](InternalServerError.md) + +## Constructors + +### Constructor + +> **new APIError**(`status`, `error`, `message?`, `headers?`, `response?`): `APIError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` = `...` + +##### response? + +`Response` + +#### Returns + +`APIError` + +#### Overrides + +[`QoderError`](QoderError.md).[`constructor`](QoderError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`QoderError`](QoderError.md).[`cause`](QoderError.md#cause) + +*** + +### code? + +> `readonly` `optional` **code?**: `string` + +*** + +### error + +> `readonly` **error**: `unknown` + +*** + +### headers + +> `readonly` **headers**: `Headers` + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`QoderError`](QoderError.md).[`message`](QoderError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`QoderError`](QoderError.md).[`name`](QoderError.md#name) + +*** + +### request? + +> `optional` **request?**: `Request` + +*** + +### request\_id + +> `readonly` **request\_id**: `string` \| `null` + +*** + +### requestID + +> `readonly` **requestID**: `string` \| `null` + +*** + +### response? + +> `readonly` `optional` **response?**: `Response` + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`QoderError`](QoderError.md).[`stack`](QoderError.md#stack) + +*** + +### status + +> `readonly` **status**: `number` + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +## Methods + +### generate() + +> `static` **generate**(`status`, `error`, `message?`, `headers?`, `response?`): `APIError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` + +##### response? + +`Response` + +#### Returns + +`APIError` diff --git a/docs/api/index/classes/APIPromise.md b/docs/api/index/classes/APIPromise.md new file mode 100644 index 0000000..15e794d --- /dev/null +++ b/docs/api/index/classes/APIPromise.md @@ -0,0 +1,568 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / APIPromise + +# Class: APIPromise\ + +Response helpers follow anthropic-sdk-typescript's lazy parsing contract. + +## Extends + +- `Promise`\<`T`\> + +## Extended by + +- [`PagePromise`](PagePromise.md) + +## Type Parameters + +### T + +`T` + +## Constructors + +### Constructor + +> **new APIPromise**\<`T`\>(`responsePromise`, `parseResponse`): `APIPromise`\<`T`\> + +#### Parameters + +##### responsePromise + +`Promise`\<`Response`\> + +##### parseResponse + +(`response`) => `T` \| `PromiseLike`\<`T`\> + +#### Returns + +`APIPromise`\<`T`\> + +#### Overrides + +`Promise.constructor` + +## Properties + +### \[toStringTag\] + +> `readonly` **\[toStringTag\]**: `string` + +#### Inherited from + +`APIPromise`.[`[toStringTag]`](#tostringtag) + +## Accessors + +### \[species\] + +#### Get Signature + +> **get** `static` **\[species\]**(): `PromiseConstructor` + +##### Returns + +`PromiseConstructor` + +#### Overrides + +`Promise.[species]` + +## Methods + +### asResponse() + +> **asResponse**(): `Promise`\<`Response`\> + +#### Returns + +`Promise`\<`Response`\> + +*** + +### catch() + +> **catch**\<`TResult`\>(`onrejected?`): `Promise`\<`T` \| `TResult`\> + +Attaches a callback for only the rejection of the Promise. + +#### Type Parameters + +##### TResult + +`TResult` = `never` + +#### Parameters + +##### onrejected? + +((`reason`) => `TResult` \| `PromiseLike`\<`TResult`\>) \| `null` + +The callback to execute when the Promise is rejected. + +#### Returns + +`Promise`\<`T` \| `TResult`\> + +A Promise for the completion of the callback. + +#### Overrides + +`Promise.catch` + +*** + +### finally() + +> **finally**(`onfinally?`): `Promise`\<`T`\> + +Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The +resolved value cannot be modified from the callback. + +#### Parameters + +##### onfinally? + +(() => `void`) \| `null` + +The callback to execute when the Promise is settled (fulfilled or rejected). + +#### Returns + +`Promise`\<`T`\> + +A Promise for the completion of the callback. + +#### Overrides + +`Promise.finally` + +*** + +### then() + +> **then**\<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`\<`TResult1` \| `TResult2`\> + +Attaches callbacks for the resolution and/or rejection of the Promise. + +#### Type Parameters + +##### TResult1 + +`TResult1` = `T` + +##### TResult2 + +`TResult2` = `never` + +#### Parameters + +##### onfulfilled? + +((`value`) => `TResult1` \| `PromiseLike`\<`TResult1`\>) \| `null` + +The callback to execute when the Promise is resolved. + +##### onrejected? + +((`reason`) => `TResult2` \| `PromiseLike`\<`TResult2`\>) \| `null` + +The callback to execute when the Promise is rejected. + +#### Returns + +`Promise`\<`TResult1` \| `TResult2`\> + +A Promise for the completion of which ever callback is executed. + +#### Overrides + +`Promise.then` + +*** + +### withResponse() + +> **withResponse**(): `Promise`\<\{ `data`: `T`; `request_id`: `string` \| `null`; `response`: `Response`; \}\> + +#### Returns + +`Promise`\<\{ `data`: `T`; `request_id`: `string` \| `null`; `response`: `Response`; \}\> + +*** + +### all() + +#### Call Signature + +> `static` **all**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\>[]\> + +Creates a Promise that is resolved with an array of results when all of the provided Promises +resolve, or rejected when any Promise is rejected. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### values + +`Iterable`\<`T` \| `PromiseLike`\<`T`\>\> + +An iterable of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>[]\> + +A new Promise. + +##### Inherited from + +`Promise.all` + +#### Call Signature + +> `static` **all**\<`T`\>(`values`): `Promise`\<\{ -readonly \[P in string \| number \| symbol\]: Awaited\ \}\> + +Creates a Promise that is resolved with an array of results when all of the provided Promises +resolve, or rejected when any Promise is rejected. + +##### Type Parameters + +###### T + +`T` *extends* readonly `unknown`[] \| \[\] + +##### Parameters + +###### values + +`T` + +An array of Promises. + +##### Returns + +`Promise`\<\{ -readonly \[P in string \| number \| symbol\]: Awaited\ \}\> + +A new Promise. + +##### Inherited from + +`Promise.all` + +*** + +### allSettled() + +#### Call Signature + +> `static` **allSettled**\<`T`\>(`values`): `Promise`\<\{ -readonly \[P in string \| number \| symbol\]: PromiseSettledResult\\> \}\> + +Creates a Promise that is resolved with an array of results when all +of the provided Promises resolve or reject. + +##### Type Parameters + +###### T + +`T` *extends* readonly `unknown`[] \| \[\] + +##### Parameters + +###### values + +`T` + +An array of Promises. + +##### Returns + +`Promise`\<\{ -readonly \[P in string \| number \| symbol\]: PromiseSettledResult\\> \}\> + +A new Promise. + +##### Inherited from + +`Promise.allSettled` + +#### Call Signature + +> `static` **allSettled**\<`T`\>(`values`): `Promise`\<`PromiseSettledResult`\<`Awaited`\<`T`\>\>[]\> + +Creates a Promise that is resolved with an array of results when all +of the provided Promises resolve or reject. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### values + +`Iterable`\<`T` \| `PromiseLike`\<`T`\>\> + +An array of Promises. + +##### Returns + +`Promise`\<`PromiseSettledResult`\<`Awaited`\<`T`\>\>[]\> + +A new Promise. + +##### Inherited from + +`Promise.allSettled` + +*** + +### any() + +#### Call Signature + +> `static` **any**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\[`number`\]\>\> + +The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm. + +##### Type Parameters + +###### T + +`T` *extends* readonly `unknown`[] \| \[\] + +##### Parameters + +###### values + +`T` + +An array or iterable of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\[`number`\]\>\> + +A new Promise. + +##### Inherited from + +`Promise.any` + +#### Call Signature + +> `static` **any**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\>\> + +The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### values + +`Iterable`\<`T` \| `PromiseLike`\<`T`\>\> + +An array or iterable of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>\> + +A new Promise. + +##### Inherited from + +`Promise.any` + +*** + +### race() + +#### Call Signature + +> `static` **race**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\>\> + +Creates a Promise that is resolved or rejected when any of the provided Promises are resolved +or rejected. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### values + +`Iterable`\<`T` \| `PromiseLike`\<`T`\>\> + +An iterable of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>\> + +A new Promise. + +##### Inherited from + +`Promise.race` + +#### Call Signature + +> `static` **race**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\[`number`\]\>\> + +Creates a Promise that is resolved or rejected when any of the provided Promises are resolved +or rejected. + +##### Type Parameters + +###### T + +`T` *extends* readonly `unknown`[] \| \[\] + +##### Parameters + +###### values + +`T` + +An array of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\[`number`\]\>\> + +A new Promise. + +##### Inherited from + +`Promise.race` + +*** + +### reject() + +> `static` **reject**\<`T`\>(`reason?`): `Promise`\<`T`\> + +Creates a new rejected promise for the provided reason. + +#### Type Parameters + +##### T + +`T` = `never` + +#### Parameters + +##### reason? + +`any` + +The reason the promise was rejected. + +#### Returns + +`Promise`\<`T`\> + +A new rejected Promise. + +#### Inherited from + +`Promise.reject` + +*** + +### resolve() + +#### Call Signature + +> `static` **resolve**(): `Promise`\<`void`\> + +Creates a new resolved promise. + +##### Returns + +`Promise`\<`void`\> + +A resolved promise. + +##### Inherited from + +`Promise.resolve` + +#### Call Signature + +> `static` **resolve**\<`T`\>(`value`): `Promise`\<`Awaited`\<`T`\>\> + +Creates a new resolved promise for the provided value. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### value + +`T` + +A promise. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>\> + +A promise whose internal state matches the provided promise. + +##### Inherited from + +`Promise.resolve` + +#### Call Signature + +> `static` **resolve**\<`T`\>(`value`): `Promise`\<`Awaited`\<`T`\>\> + +Creates a new resolved promise for the provided value. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### value + +`T` \| `PromiseLike`\<`T`\> + +A promise. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>\> + +A promise whose internal state matches the provided promise. + +##### Inherited from + +`Promise.resolve` diff --git a/docs/api/index/classes/APIUserAbortError.md b/docs/api/index/classes/APIUserAbortError.md new file mode 100644 index 0000000..fb58e0a --- /dev/null +++ b/docs/api/index/classes/APIUserAbortError.md @@ -0,0 +1,75 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / APIUserAbortError + +# Class: APIUserAbortError + +## Extends + +- [`QoderError`](QoderError.md) + +## Constructors + +### Constructor + +> **new APIUserAbortError**(`message`, `options?`): `APIUserAbortError` + +#### Parameters + +##### message + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`APIUserAbortError` + +#### Inherited from + +[`QoderError`](QoderError.md).[`constructor`](QoderError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`QoderError`](QoderError.md).[`cause`](QoderError.md#cause) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`QoderError`](QoderError.md).[`message`](QoderError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`QoderError`](QoderError.md).[`name`](QoderError.md#name) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`QoderError`](QoderError.md).[`stack`](QoderError.md#stack) diff --git a/docs/api/index/classes/AuthenticationError.md b/docs/api/index/classes/AuthenticationError.md new file mode 100644 index 0000000..6ec9ddc --- /dev/null +++ b/docs/api/index/classes/AuthenticationError.md @@ -0,0 +1,213 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / AuthenticationError + +# Class: AuthenticationError + +## Extends + +- [`APIError`](APIError.md) + +## Constructors + +### Constructor + +> **new AuthenticationError**(`status`, `error`, `message?`, `headers?`, `response?`): `AuthenticationError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` = `...` + +##### response? + +`Response` + +#### Returns + +`AuthenticationError` + +#### Inherited from + +[`APIError`](APIError.md).[`constructor`](APIError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`cause`](APIError.md#cause) + +*** + +### code? + +> `readonly` `optional` **code?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`code`](APIError.md#code) + +*** + +### error + +> `readonly` **error**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`error`](APIError.md#error) + +*** + +### headers + +> `readonly` **headers**: `Headers` + +#### Inherited from + +[`APIError`](APIError.md).[`headers`](APIError.md#headers) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`message`](APIError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`name`](APIError.md#name) + +*** + +### request? + +> `optional` **request?**: `Request` + +#### Inherited from + +[`APIError`](APIError.md).[`request`](APIError.md#request) + +*** + +### request\_id + +> `readonly` **request\_id**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`request_id`](APIError.md#request_id) + +*** + +### requestID + +> `readonly` **requestID**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`requestID`](APIError.md#requestid) + +*** + +### response? + +> `readonly` `optional` **response?**: `Response` + +#### Inherited from + +[`APIError`](APIError.md).[`response`](APIError.md#response) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`stack`](APIError.md#stack) + +*** + +### status + +> `readonly` **status**: `number` + +#### Inherited from + +[`APIError`](APIError.md).[`status`](APIError.md#status) + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`type`](APIError.md#type) + +## Methods + +### generate() + +> `static` **generate**(`status`, `error`, `message?`, `headers?`, `response?`): [`APIError`](APIError.md) + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` + +##### response? + +`Response` + +#### Returns + +[`APIError`](APIError.md) + +#### Inherited from + +[`APIError`](APIError.md).[`generate`](APIError.md#generate) diff --git a/docs/api/index/classes/BadRequestError.md b/docs/api/index/classes/BadRequestError.md new file mode 100644 index 0000000..6181207 --- /dev/null +++ b/docs/api/index/classes/BadRequestError.md @@ -0,0 +1,213 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / BadRequestError + +# Class: BadRequestError + +## Extends + +- [`APIError`](APIError.md) + +## Constructors + +### Constructor + +> **new BadRequestError**(`status`, `error`, `message?`, `headers?`, `response?`): `BadRequestError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` = `...` + +##### response? + +`Response` + +#### Returns + +`BadRequestError` + +#### Inherited from + +[`APIError`](APIError.md).[`constructor`](APIError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`cause`](APIError.md#cause) + +*** + +### code? + +> `readonly` `optional` **code?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`code`](APIError.md#code) + +*** + +### error + +> `readonly` **error**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`error`](APIError.md#error) + +*** + +### headers + +> `readonly` **headers**: `Headers` + +#### Inherited from + +[`APIError`](APIError.md).[`headers`](APIError.md#headers) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`message`](APIError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`name`](APIError.md#name) + +*** + +### request? + +> `optional` **request?**: `Request` + +#### Inherited from + +[`APIError`](APIError.md).[`request`](APIError.md#request) + +*** + +### request\_id + +> `readonly` **request\_id**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`request_id`](APIError.md#request_id) + +*** + +### requestID + +> `readonly` **requestID**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`requestID`](APIError.md#requestid) + +*** + +### response? + +> `readonly` `optional` **response?**: `Response` + +#### Inherited from + +[`APIError`](APIError.md).[`response`](APIError.md#response) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`stack`](APIError.md#stack) + +*** + +### status + +> `readonly` **status**: `number` + +#### Inherited from + +[`APIError`](APIError.md).[`status`](APIError.md#status) + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`type`](APIError.md#type) + +## Methods + +### generate() + +> `static` **generate**(`status`, `error`, `message?`, `headers?`, `response?`): [`APIError`](APIError.md) + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` + +##### response? + +`Response` + +#### Returns + +[`APIError`](APIError.md) + +#### Inherited from + +[`APIError`](APIError.md).[`generate`](APIError.md#generate) diff --git a/docs/api/index/classes/ConflictError.md b/docs/api/index/classes/ConflictError.md new file mode 100644 index 0000000..2ff82b1 --- /dev/null +++ b/docs/api/index/classes/ConflictError.md @@ -0,0 +1,213 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / ConflictError + +# Class: ConflictError + +## Extends + +- [`APIError`](APIError.md) + +## Constructors + +### Constructor + +> **new ConflictError**(`status`, `error`, `message?`, `headers?`, `response?`): `ConflictError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` = `...` + +##### response? + +`Response` + +#### Returns + +`ConflictError` + +#### Inherited from + +[`APIError`](APIError.md).[`constructor`](APIError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`cause`](APIError.md#cause) + +*** + +### code? + +> `readonly` `optional` **code?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`code`](APIError.md#code) + +*** + +### error + +> `readonly` **error**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`error`](APIError.md#error) + +*** + +### headers + +> `readonly` **headers**: `Headers` + +#### Inherited from + +[`APIError`](APIError.md).[`headers`](APIError.md#headers) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`message`](APIError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`name`](APIError.md#name) + +*** + +### request? + +> `optional` **request?**: `Request` + +#### Inherited from + +[`APIError`](APIError.md).[`request`](APIError.md#request) + +*** + +### request\_id + +> `readonly` **request\_id**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`request_id`](APIError.md#request_id) + +*** + +### requestID + +> `readonly` **requestID**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`requestID`](APIError.md#requestid) + +*** + +### response? + +> `readonly` `optional` **response?**: `Response` + +#### Inherited from + +[`APIError`](APIError.md).[`response`](APIError.md#response) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`stack`](APIError.md#stack) + +*** + +### status + +> `readonly` **status**: `number` + +#### Inherited from + +[`APIError`](APIError.md).[`status`](APIError.md#status) + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`type`](APIError.md#type) + +## Methods + +### generate() + +> `static` **generate**(`status`, `error`, `message?`, `headers?`, `response?`): [`APIError`](APIError.md) + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` + +##### response? + +`Response` + +#### Returns + +[`APIError`](APIError.md) + +#### Inherited from + +[`APIError`](APIError.md).[`generate`](APIError.md#generate) diff --git a/docs/api/index/classes/ForwardClient.md b/docs/api/index/classes/ForwardClient.md new file mode 100644 index 0000000..0c8ce5a --- /dev/null +++ b/docs/api/index/classes/ForwardClient.md @@ -0,0 +1,285 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / ForwardClient + +# Class: ForwardClient + +## Extends + +- [`APIClient`](APIClient.md) + +## Constructors + +### Constructor + +> **new ForwardClient**(`options?`): `ForwardClient` + +#### Parameters + +##### options? + +[`ClientOptions`](../interfaces/ClientOptions.md) = `{}` + +#### Returns + +`ForwardClient` + +#### Overrides + +[`APIClient`](APIClient.md).[`constructor`](APIClient.md#constructor) + +## Properties + +### baseURL + +> `readonly` **baseURL**: `string` + +#### Inherited from + +[`APIClient`](APIClient.md).[`baseURL`](APIClient.md#baseurl) + +*** + +### batches + +> `readonly` **batches**: [`Batches`](../../forward/classes/Batches.md) + +*** + +### channelPairings + +> `readonly` **channelPairings**: [`ChannelPairings`](../../forward/classes/ChannelPairings.md) + +*** + +### channels + +> `readonly` **channels**: [`Channels`](../../forward/classes/Channels.md) + +*** + +### defaultHeaders + +> `readonly` **defaultHeaders**: [`HeadersLike`](../type-aliases/HeadersLike.md) \| `undefined` + +#### Inherited from + +[`APIClient`](APIClient.md).[`defaultHeaders`](APIClient.md#defaultheaders) + +*** + +### environments + +> `readonly` **environments**: [`Environments`](../../forward/classes/Environments.md) + +*** + +### files + +> `readonly` **files**: [`Files`](../../forward/classes/Files.md) + +*** + +### identities + +> `readonly` **identities**: [`Identities`](../../forward/classes/Identities.md) + +*** + +### maxRetries + +> `readonly` **maxRetries**: `number` + +#### Inherited from + +[`APIClient`](APIClient.md).[`maxRetries`](APIClient.md#maxretries) + +*** + +### memoryStores + +> `readonly` **memoryStores**: [`MemoryStores`](../../forward/classes/MemoryStores.md) + +*** + +### mode + +> `readonly` **mode**: `"forward"` \| `"managed"` = `'managed'` + +#### Inherited from + +[`APIClient`](APIClient.md).[`mode`](APIClient.md#mode) + +*** + +### models + +> `readonly` **models**: [`Models`](../../forward/classes/Models.md) + +*** + +### options + +> `protected` `readonly` **options**: [`ClientOptions`](../interfaces/ClientOptions.md) + +#### Inherited from + +[`APIClient`](APIClient.md).[`options`](APIClient.md#options) + +*** + +### scheduleRuns + +> `readonly` **scheduleRuns**: [`ScheduleRuns`](../../forward/classes/ScheduleRuns.md) + +*** + +### schedules + +> `readonly` **schedules**: [`Schedules`](../../forward/classes/Schedules.md) + +*** + +### sessions + +> `readonly` **sessions**: [`Sessions`](../../forward/classes/Sessions.md) + +*** + +### skills + +> `readonly` **skills**: [`Skills`](../../forward/classes/Skills.md) + +*** + +### templates + +> `readonly` **templates**: [`Templates`](../../forward/classes/Templates.md) + +*** + +### timeout + +> `readonly` **timeout**: `number` + +#### Inherited from + +[`APIClient`](APIClient.md).[`timeout`](APIClient.md#timeout) + +*** + +### vaults + +> `readonly` **vaults**: [`Vaults`](../../forward/classes/Vaults.md) + +## Methods + +### downloadFile() + +> **downloadFile**(`path`, `options?`): [`APIPromise`](APIPromise.md)\<`Response`\> + +Resolve the API grant, then send a separate request without API credentials or headers. + +#### Parameters + +##### path + +`string` + +##### options? + +[`RequestOptions`](../interfaces/RequestOptions.md) = `{}` + +#### Returns + +[`APIPromise`](APIPromise.md)\<`Response`\> + +#### Inherited from + +[`APIClient`](APIClient.md).[`downloadFile`](APIClient.md#downloadfile) + +*** + +### getAPIList() + +> **getAPIList**\<`T`\>(`path`, `query?`, `options?`, `pagination?`): [`PagePromise`](PagePromise.md)\<`T`\> + +#### Type Parameters + +##### T + +`T` + +#### Parameters + +##### path + +`string` + +##### query? + +`object` = `{}` + +##### options? + +[`RequestOptions`](../interfaces/RequestOptions.md) = `{}` + +##### pagination? + +[`PaginationMode`](../type-aliases/PaginationMode.md) = `...` + +#### Returns + +[`PagePromise`](PagePromise.md)\<`T`\> + +#### Inherited from + +[`APIClient`](APIClient.md).[`getAPIList`](APIClient.md#getapilist) + +*** + +### request() + +> **request**\<`T`\>(`options`): [`APIPromise`](APIPromise.md)\<`T`\> + +#### Type Parameters + +##### T + +`T` + +#### Parameters + +##### options + +[`APIRequestOptions`](../interfaces/APIRequestOptions.md) + +#### Returns + +[`APIPromise`](APIPromise.md)\<`T`\> + +#### Inherited from + +[`APIClient`](APIClient.md).[`request`](APIClient.md#request) + +*** + +### validateHeaders() + +> `protected` **validateHeaders**(`headers`): `void` + +#### Parameters + +##### headers + +`Headers` + +#### Returns + +`void` + +#### Inherited from + +[`APIClient`](APIClient.md).[`validateHeaders`](APIClient.md#validateheaders) diff --git a/docs/api/index/classes/InternalServerError.md b/docs/api/index/classes/InternalServerError.md new file mode 100644 index 0000000..3be4ab3 --- /dev/null +++ b/docs/api/index/classes/InternalServerError.md @@ -0,0 +1,213 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / InternalServerError + +# Class: InternalServerError + +## Extends + +- [`APIError`](APIError.md) + +## Constructors + +### Constructor + +> **new InternalServerError**(`status`, `error`, `message?`, `headers?`, `response?`): `InternalServerError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` = `...` + +##### response? + +`Response` + +#### Returns + +`InternalServerError` + +#### Inherited from + +[`APIError`](APIError.md).[`constructor`](APIError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`cause`](APIError.md#cause) + +*** + +### code? + +> `readonly` `optional` **code?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`code`](APIError.md#code) + +*** + +### error + +> `readonly` **error**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`error`](APIError.md#error) + +*** + +### headers + +> `readonly` **headers**: `Headers` + +#### Inherited from + +[`APIError`](APIError.md).[`headers`](APIError.md#headers) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`message`](APIError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`name`](APIError.md#name) + +*** + +### request? + +> `optional` **request?**: `Request` + +#### Inherited from + +[`APIError`](APIError.md).[`request`](APIError.md#request) + +*** + +### request\_id + +> `readonly` **request\_id**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`request_id`](APIError.md#request_id) + +*** + +### requestID + +> `readonly` **requestID**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`requestID`](APIError.md#requestid) + +*** + +### response? + +> `readonly` `optional` **response?**: `Response` + +#### Inherited from + +[`APIError`](APIError.md).[`response`](APIError.md#response) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`stack`](APIError.md#stack) + +*** + +### status + +> `readonly` **status**: `number` + +#### Inherited from + +[`APIError`](APIError.md).[`status`](APIError.md#status) + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`type`](APIError.md#type) + +## Methods + +### generate() + +> `static` **generate**(`status`, `error`, `message?`, `headers?`, `response?`): [`APIError`](APIError.md) + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` + +##### response? + +`Response` + +#### Returns + +[`APIError`](APIError.md) + +#### Inherited from + +[`APIError`](APIError.md).[`generate`](APIError.md#generate) diff --git a/docs/api/index/classes/ManagedClient.md b/docs/api/index/classes/ManagedClient.md new file mode 100644 index 0000000..dfffb60 --- /dev/null +++ b/docs/api/index/classes/ManagedClient.md @@ -0,0 +1,269 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / ManagedClient + +# Class: ManagedClient + +Qoder Managed Mode API client. + +## Extends + +- [`APIClient`](APIClient.md) + +## Constructors + +### Constructor + +> **new ManagedClient**(`options?`): `ManagedClient` + +#### Parameters + +##### options? + +[`ClientOptions`](../interfaces/ClientOptions.md) = `{}` + +#### Returns + +`ManagedClient` + +#### Overrides + +[`APIClient`](APIClient.md).[`constructor`](APIClient.md#constructor) + +## Properties + +### agents + +> `readonly` **agents**: [`Agents`](../../managed/classes/Agents.md) + +*** + +### baseURL + +> `readonly` **baseURL**: `string` + +#### Inherited from + +[`APIClient`](APIClient.md).[`baseURL`](APIClient.md#baseurl) + +*** + +### defaultHeaders + +> `readonly` **defaultHeaders**: [`HeadersLike`](../type-aliases/HeadersLike.md) \| `undefined` + +#### Inherited from + +[`APIClient`](APIClient.md).[`defaultHeaders`](APIClient.md#defaultheaders) + +*** + +### deploymentRuns + +> `readonly` **deploymentRuns**: [`DeploymentRuns`](../../managed/classes/DeploymentRuns.md) + +*** + +### deployments + +> `readonly` **deployments**: [`Deployments`](../../managed/classes/Deployments.md) + +*** + +### dreams + +> `readonly` **dreams**: [`Dreams`](../../managed/classes/Dreams.md) + +*** + +### environments + +> `readonly` **environments**: [`Environments`](../../managed/classes/Environments.md) + +*** + +### files + +> `readonly` **files**: [`Files`](../../managed/classes/Files.md) + +*** + +### maxRetries + +> `readonly` **maxRetries**: `number` + +#### Inherited from + +[`APIClient`](APIClient.md).[`maxRetries`](APIClient.md#maxretries) + +*** + +### memoryStores + +> `readonly` **memoryStores**: [`MemoryStores`](../../managed/classes/MemoryStores.md) + +*** + +### mode + +> `readonly` **mode**: `"forward"` \| `"managed"` = `'managed'` + +#### Inherited from + +[`APIClient`](APIClient.md).[`mode`](APIClient.md#mode) + +*** + +### models + +> `readonly` **models**: [`Models`](../../managed/classes/Models.md) + +*** + +### options + +> `protected` `readonly` **options**: [`ClientOptions`](../interfaces/ClientOptions.md) + +#### Inherited from + +[`APIClient`](APIClient.md).[`options`](APIClient.md#options) + +*** + +### sessions + +> `readonly` **sessions**: [`Sessions`](../../managed/classes/Sessions.md) + +*** + +### skills + +> `readonly` **skills**: [`Skills`](../../managed/classes/Skills.md) + +*** + +### timeout + +> `readonly` **timeout**: `number` + +#### Inherited from + +[`APIClient`](APIClient.md).[`timeout`](APIClient.md#timeout) + +*** + +### vaults + +> `readonly` **vaults**: [`Vaults`](../../managed/classes/Vaults.md) + +## Methods + +### downloadFile() + +> **downloadFile**(`path`, `options?`): [`APIPromise`](APIPromise.md)\<`Response`\> + +Resolve the API grant, then send a separate request without API credentials or headers. + +#### Parameters + +##### path + +`string` + +##### options? + +[`RequestOptions`](../interfaces/RequestOptions.md) = `{}` + +#### Returns + +[`APIPromise`](APIPromise.md)\<`Response`\> + +#### Inherited from + +[`APIClient`](APIClient.md).[`downloadFile`](APIClient.md#downloadfile) + +*** + +### getAPIList() + +> **getAPIList**\<`T`\>(`path`, `query?`, `options?`, `pagination?`): [`PagePromise`](PagePromise.md)\<`T`\> + +#### Type Parameters + +##### T + +`T` + +#### Parameters + +##### path + +`string` + +##### query? + +`object` = `{}` + +##### options? + +[`RequestOptions`](../interfaces/RequestOptions.md) = `{}` + +##### pagination? + +[`PaginationMode`](../type-aliases/PaginationMode.md) = `...` + +#### Returns + +[`PagePromise`](PagePromise.md)\<`T`\> + +#### Inherited from + +[`APIClient`](APIClient.md).[`getAPIList`](APIClient.md#getapilist) + +*** + +### request() + +> **request**\<`T`\>(`options`): [`APIPromise`](APIPromise.md)\<`T`\> + +#### Type Parameters + +##### T + +`T` + +#### Parameters + +##### options + +[`APIRequestOptions`](../interfaces/APIRequestOptions.md) + +#### Returns + +[`APIPromise`](APIPromise.md)\<`T`\> + +#### Inherited from + +[`APIClient`](APIClient.md).[`request`](APIClient.md#request) + +*** + +### validateHeaders() + +> `protected` **validateHeaders**(`headers`): `void` + +#### Parameters + +##### headers + +`Headers` + +#### Returns + +`void` + +#### Inherited from + +[`APIClient`](APIClient.md).[`validateHeaders`](APIClient.md#validateheaders) diff --git a/docs/api/index/classes/NotFoundError.md b/docs/api/index/classes/NotFoundError.md new file mode 100644 index 0000000..16f13c8 --- /dev/null +++ b/docs/api/index/classes/NotFoundError.md @@ -0,0 +1,213 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / NotFoundError + +# Class: NotFoundError + +## Extends + +- [`APIError`](APIError.md) + +## Constructors + +### Constructor + +> **new NotFoundError**(`status`, `error`, `message?`, `headers?`, `response?`): `NotFoundError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` = `...` + +##### response? + +`Response` + +#### Returns + +`NotFoundError` + +#### Inherited from + +[`APIError`](APIError.md).[`constructor`](APIError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`cause`](APIError.md#cause) + +*** + +### code? + +> `readonly` `optional` **code?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`code`](APIError.md#code) + +*** + +### error + +> `readonly` **error**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`error`](APIError.md#error) + +*** + +### headers + +> `readonly` **headers**: `Headers` + +#### Inherited from + +[`APIError`](APIError.md).[`headers`](APIError.md#headers) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`message`](APIError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`name`](APIError.md#name) + +*** + +### request? + +> `optional` **request?**: `Request` + +#### Inherited from + +[`APIError`](APIError.md).[`request`](APIError.md#request) + +*** + +### request\_id + +> `readonly` **request\_id**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`request_id`](APIError.md#request_id) + +*** + +### requestID + +> `readonly` **requestID**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`requestID`](APIError.md#requestid) + +*** + +### response? + +> `readonly` `optional` **response?**: `Response` + +#### Inherited from + +[`APIError`](APIError.md).[`response`](APIError.md#response) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`stack`](APIError.md#stack) + +*** + +### status + +> `readonly` **status**: `number` + +#### Inherited from + +[`APIError`](APIError.md).[`status`](APIError.md#status) + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`type`](APIError.md#type) + +## Methods + +### generate() + +> `static` **generate**(`status`, `error`, `message?`, `headers?`, `response?`): [`APIError`](APIError.md) + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` + +##### response? + +`Response` + +#### Returns + +[`APIError`](APIError.md) + +#### Inherited from + +[`APIError`](APIError.md).[`generate`](APIError.md#generate) diff --git a/docs/api/index/classes/PATCredential.md b/docs/api/index/classes/PATCredential.md new file mode 100644 index 0000000..cf915d5 --- /dev/null +++ b/docs/api/index/classes/PATCredential.md @@ -0,0 +1,57 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / PATCredential + +# Class: PATCredential + +## Implements + +- [`Credential`](../interfaces/Credential.md) + +## Constructors + +### Constructor + +> **new PATCredential**(`token`): `PATCredential` + +#### Parameters + +##### token + +`string` + +#### Returns + +`PATCredential` + +## Methods + +### getToken() + +> **getToken**(): `string` + +#### Returns + +`string` + +#### Implementation of + +[`Credential`](../interfaces/Credential.md).[`getToken`](../interfaces/Credential.md#gettoken) + +*** + +### fromEnv() + +> `static` **fromEnv**(`name?`): `PATCredential` + +#### Parameters + +##### name? + +`string` = `'QODER_PAT'` + +#### Returns + +`PATCredential` diff --git a/docs/api/index/classes/Page.md b/docs/api/index/classes/Page.md new file mode 100644 index 0000000..d6a9347 --- /dev/null +++ b/docs/api/index/classes/Page.md @@ -0,0 +1,167 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / Page + +# Class: Page\ + +## Type Parameters + +### T + +`T` + +## Implements + +- `AsyncIterable`\<`T`\> + +## Indexable + +> \[`key`: `string`\]: `unknown` + +## Constructors + +### Constructor + +> **new Page**\<`T`\>(`client`, `response`, `body`, `path`, `query`, `options`, `mode`): `Page`\<`T`\> + +#### Parameters + +##### client + +[`APIClient`](APIClient.md) + +##### response + +`Response` + +##### body + +[`PageResponse`](../interfaces/PageResponse.md)\<`T`\> + +##### path + +`string` + +##### query + +`Record`\<`string`, `unknown`\> + +##### options + +[`RequestOptions`](../interfaces/RequestOptions.md) + +##### mode + +[`PaginationMode`](../type-aliases/PaginationMode.md) + +#### Returns + +`Page`\<`T`\> + +## Properties + +### data + +> `readonly` **data**: `T`[] + +*** + +### first\_id? + +> `readonly` `optional` **first\_id?**: `string` \| `null` + +*** + +### has\_more? + +> `readonly` `optional` **has\_more?**: `boolean` + +*** + +### last\_id? + +> `readonly` `optional` **last\_id?**: `string` \| `null` + +*** + +### next\_page? + +> `readonly` `optional` **next\_page?**: `string` \| `null` + +*** + +### prev\_page? + +> `readonly` `optional` **prev\_page?**: `string` \| `null` + +*** + +### response + +> `readonly` **response**: `Response` + +## Methods + +### \[asyncIterator\]() + +> **\[asyncIterator\]**(): `AsyncGenerator`\<`T`\> + +#### Returns + +`AsyncGenerator`\<`T`\> + +#### Implementation of + +`AsyncIterable.[asyncIterator]` + +*** + +### getNextPage() + +> **getNextPage**(): `Promise`\<`Page`\<`T`\> \| `null`\> + +#### Returns + +`Promise`\<`Page`\<`T`\> \| `null`\> + +*** + +### getPaginatedItems() + +> **getPaginatedItems**(): `T`[] + +#### Returns + +`T`[] + +*** + +### hasNextPage() + +> **hasNextPage**(): `boolean` + +#### Returns + +`boolean` + +*** + +### iterPages() + +> **iterPages**(): `AsyncGenerator`\<`Page`\<`T`\>\> + +#### Returns + +`AsyncGenerator`\<`Page`\<`T`\>\> + +*** + +### toJSON() + +> **toJSON**(): [`PageResponse`](../interfaces/PageResponse.md)\<`T`\> + +#### Returns + +[`PageResponse`](../interfaces/PageResponse.md)\<`T`\> diff --git a/docs/api/index/classes/PagePromise.md b/docs/api/index/classes/PagePromise.md new file mode 100644 index 0000000..fe45497 --- /dev/null +++ b/docs/api/index/classes/PagePromise.md @@ -0,0 +1,590 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / PagePromise + +# Class: PagePromise\ + +Response helpers follow anthropic-sdk-typescript's lazy parsing contract. + +## Extends + +- [`APIPromise`](APIPromise.md)\<[`Page`](Page.md)\<`T`\>\> + +## Type Parameters + +### T + +`T` + +## Implements + +- `AsyncIterable`\<`T`\> + +## Constructors + +### Constructor + +> **new PagePromise**\<`T`\>(`responsePromise`, `parseResponse`): `PagePromise`\<`T`\> + +#### Parameters + +##### responsePromise + +`Promise`\<`Response`\> + +##### parseResponse + +(`response`) => [`Page`](Page.md)\<`T`\> \| `PromiseLike`\<[`Page`](Page.md)\<`T`\>\> + +#### Returns + +`PagePromise`\<`T`\> + +#### Inherited from + +[`APIPromise`](APIPromise.md).[`constructor`](APIPromise.md#constructor) + +## Properties + +### \[toStringTag\] + +> `readonly` **\[toStringTag\]**: `string` + +#### Inherited from + +[`APIPromise`](APIPromise.md).[`[toStringTag]`](APIPromise.md#tostringtag) + +## Accessors + +### \[species\] + +#### Get Signature + +> **get** `static` **\[species\]**(): `PromiseConstructor` + +##### Returns + +`PromiseConstructor` + +#### Inherited from + +[`APIPromise`](APIPromise.md).[`[species]`](APIPromise.md#species) + +## Methods + +### \[asyncIterator\]() + +> **\[asyncIterator\]**(): `AsyncGenerator`\<`T`\> + +#### Returns + +`AsyncGenerator`\<`T`\> + +#### Implementation of + +`AsyncIterable.[asyncIterator]` + +*** + +### asResponse() + +> **asResponse**(): `Promise`\<`Response`\> + +#### Returns + +`Promise`\<`Response`\> + +#### Inherited from + +[`APIPromise`](APIPromise.md).[`asResponse`](APIPromise.md#asresponse) + +*** + +### catch() + +> **catch**\<`TResult`\>(`onrejected?`): `Promise`\<[`Page`](Page.md)\<`T`\> \| `TResult`\> + +Attaches a callback for only the rejection of the Promise. + +#### Type Parameters + +##### TResult + +`TResult` = `never` + +#### Parameters + +##### onrejected? + +((`reason`) => `TResult` \| `PromiseLike`\<`TResult`\>) \| `null` + +The callback to execute when the Promise is rejected. + +#### Returns + +`Promise`\<[`Page`](Page.md)\<`T`\> \| `TResult`\> + +A Promise for the completion of the callback. + +#### Inherited from + +[`APIPromise`](APIPromise.md).[`catch`](APIPromise.md#catch) + +*** + +### finally() + +> **finally**(`onfinally?`): `Promise`\<[`Page`](Page.md)\<`T`\>\> + +Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The +resolved value cannot be modified from the callback. + +#### Parameters + +##### onfinally? + +(() => `void`) \| `null` + +The callback to execute when the Promise is settled (fulfilled or rejected). + +#### Returns + +`Promise`\<[`Page`](Page.md)\<`T`\>\> + +A Promise for the completion of the callback. + +#### Inherited from + +[`APIPromise`](APIPromise.md).[`finally`](APIPromise.md#finally) + +*** + +### then() + +> **then**\<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`\<`TResult1` \| `TResult2`\> + +Attaches callbacks for the resolution and/or rejection of the Promise. + +#### Type Parameters + +##### TResult1 + +`TResult1` = [`Page`](Page.md)\<`T`\> + +##### TResult2 + +`TResult2` = `never` + +#### Parameters + +##### onfulfilled? + +((`value`) => `TResult1` \| `PromiseLike`\<`TResult1`\>) \| `null` + +The callback to execute when the Promise is resolved. + +##### onrejected? + +((`reason`) => `TResult2` \| `PromiseLike`\<`TResult2`\>) \| `null` + +The callback to execute when the Promise is rejected. + +#### Returns + +`Promise`\<`TResult1` \| `TResult2`\> + +A Promise for the completion of which ever callback is executed. + +#### Inherited from + +[`APIPromise`](APIPromise.md).[`then`](APIPromise.md#then) + +*** + +### withResponse() + +> **withResponse**(): `Promise`\<\{ `data`: [`Page`](Page.md); `request_id`: `string` \| `null`; `response`: `Response`; \}\> + +#### Returns + +`Promise`\<\{ `data`: [`Page`](Page.md); `request_id`: `string` \| `null`; `response`: `Response`; \}\> + +#### Inherited from + +[`APIPromise`](APIPromise.md).[`withResponse`](APIPromise.md#withresponse) + +*** + +### all() + +#### Call Signature + +> `static` **all**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\>[]\> + +Creates a Promise that is resolved with an array of results when all of the provided Promises +resolve, or rejected when any Promise is rejected. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### values + +`Iterable`\<`T` \| `PromiseLike`\<`T`\>\> + +An iterable of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>[]\> + +A new Promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`all`](APIPromise.md#all) + +#### Call Signature + +> `static` **all**\<`T`\>(`values`): `Promise`\<\{ -readonly \[P in string \| number \| symbol\]: Awaited\ \}\> + +Creates a Promise that is resolved with an array of results when all of the provided Promises +resolve, or rejected when any Promise is rejected. + +##### Type Parameters + +###### T + +`T` *extends* readonly `unknown`[] \| \[\] + +##### Parameters + +###### values + +`T` + +An array of Promises. + +##### Returns + +`Promise`\<\{ -readonly \[P in string \| number \| symbol\]: Awaited\ \}\> + +A new Promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`all`](APIPromise.md#all) + +*** + +### allSettled() + +#### Call Signature + +> `static` **allSettled**\<`T`\>(`values`): `Promise`\<\{ -readonly \[P in string \| number \| symbol\]: PromiseSettledResult\\> \}\> + +Creates a Promise that is resolved with an array of results when all +of the provided Promises resolve or reject. + +##### Type Parameters + +###### T + +`T` *extends* readonly `unknown`[] \| \[\] + +##### Parameters + +###### values + +`T` + +An array of Promises. + +##### Returns + +`Promise`\<\{ -readonly \[P in string \| number \| symbol\]: PromiseSettledResult\\> \}\> + +A new Promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`allSettled`](APIPromise.md#allsettled) + +#### Call Signature + +> `static` **allSettled**\<`T`\>(`values`): `Promise`\<`PromiseSettledResult`\<`Awaited`\<`T`\>\>[]\> + +Creates a Promise that is resolved with an array of results when all +of the provided Promises resolve or reject. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### values + +`Iterable`\<`T` \| `PromiseLike`\<`T`\>\> + +An array of Promises. + +##### Returns + +`Promise`\<`PromiseSettledResult`\<`Awaited`\<`T`\>\>[]\> + +A new Promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`allSettled`](APIPromise.md#allsettled) + +*** + +### any() + +#### Call Signature + +> `static` **any**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\[`number`\]\>\> + +The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm. + +##### Type Parameters + +###### T + +`T` *extends* readonly `unknown`[] \| \[\] + +##### Parameters + +###### values + +`T` + +An array or iterable of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\[`number`\]\>\> + +A new Promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`any`](APIPromise.md#any) + +#### Call Signature + +> `static` **any**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\>\> + +The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### values + +`Iterable`\<`T` \| `PromiseLike`\<`T`\>\> + +An array or iterable of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>\> + +A new Promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`any`](APIPromise.md#any) + +*** + +### race() + +#### Call Signature + +> `static` **race**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\>\> + +Creates a Promise that is resolved or rejected when any of the provided Promises are resolved +or rejected. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### values + +`Iterable`\<`T` \| `PromiseLike`\<`T`\>\> + +An iterable of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>\> + +A new Promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`race`](APIPromise.md#race) + +#### Call Signature + +> `static` **race**\<`T`\>(`values`): `Promise`\<`Awaited`\<`T`\[`number`\]\>\> + +Creates a Promise that is resolved or rejected when any of the provided Promises are resolved +or rejected. + +##### Type Parameters + +###### T + +`T` *extends* readonly `unknown`[] \| \[\] + +##### Parameters + +###### values + +`T` + +An array of Promises. + +##### Returns + +`Promise`\<`Awaited`\<`T`\[`number`\]\>\> + +A new Promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`race`](APIPromise.md#race) + +*** + +### reject() + +> `static` **reject**\<`T`\>(`reason?`): `Promise`\<`T`\> + +Creates a new rejected promise for the provided reason. + +#### Type Parameters + +##### T + +`T` = `never` + +#### Parameters + +##### reason? + +`any` + +The reason the promise was rejected. + +#### Returns + +`Promise`\<`T`\> + +A new rejected Promise. + +#### Inherited from + +[`APIPromise`](APIPromise.md).[`reject`](APIPromise.md#reject) + +*** + +### resolve() + +#### Call Signature + +> `static` **resolve**(): `Promise`\<`void`\> + +Creates a new resolved promise. + +##### Returns + +`Promise`\<`void`\> + +A resolved promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`resolve`](APIPromise.md#resolve) + +#### Call Signature + +> `static` **resolve**\<`T`\>(`value`): `Promise`\<`Awaited`\<`T`\>\> + +Creates a new resolved promise for the provided value. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### value + +`T` + +A promise. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>\> + +A promise whose internal state matches the provided promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`resolve`](APIPromise.md#resolve) + +#### Call Signature + +> `static` **resolve**\<`T`\>(`value`): `Promise`\<`Awaited`\<`T`\>\> + +Creates a new resolved promise for the provided value. + +##### Type Parameters + +###### T + +`T` + +##### Parameters + +###### value + +`T` \| `PromiseLike`\<`T`\> + +A promise. + +##### Returns + +`Promise`\<`Awaited`\<`T`\>\> + +A promise whose internal state matches the provided promise. + +##### Inherited from + +[`APIPromise`](APIPromise.md).[`resolve`](APIPromise.md#resolve) diff --git a/docs/api/index/classes/PermissionDeniedError.md b/docs/api/index/classes/PermissionDeniedError.md new file mode 100644 index 0000000..a401751 --- /dev/null +++ b/docs/api/index/classes/PermissionDeniedError.md @@ -0,0 +1,213 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / PermissionDeniedError + +# Class: PermissionDeniedError + +## Extends + +- [`APIError`](APIError.md) + +## Constructors + +### Constructor + +> **new PermissionDeniedError**(`status`, `error`, `message?`, `headers?`, `response?`): `PermissionDeniedError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` = `...` + +##### response? + +`Response` + +#### Returns + +`PermissionDeniedError` + +#### Inherited from + +[`APIError`](APIError.md).[`constructor`](APIError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`cause`](APIError.md#cause) + +*** + +### code? + +> `readonly` `optional` **code?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`code`](APIError.md#code) + +*** + +### error + +> `readonly` **error**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`error`](APIError.md#error) + +*** + +### headers + +> `readonly` **headers**: `Headers` + +#### Inherited from + +[`APIError`](APIError.md).[`headers`](APIError.md#headers) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`message`](APIError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`name`](APIError.md#name) + +*** + +### request? + +> `optional` **request?**: `Request` + +#### Inherited from + +[`APIError`](APIError.md).[`request`](APIError.md#request) + +*** + +### request\_id + +> `readonly` **request\_id**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`request_id`](APIError.md#request_id) + +*** + +### requestID + +> `readonly` **requestID**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`requestID`](APIError.md#requestid) + +*** + +### response? + +> `readonly` `optional` **response?**: `Response` + +#### Inherited from + +[`APIError`](APIError.md).[`response`](APIError.md#response) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`stack`](APIError.md#stack) + +*** + +### status + +> `readonly` **status**: `number` + +#### Inherited from + +[`APIError`](APIError.md).[`status`](APIError.md#status) + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`type`](APIError.md#type) + +## Methods + +### generate() + +> `static` **generate**(`status`, `error`, `message?`, `headers?`, `response?`): [`APIError`](APIError.md) + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` + +##### response? + +`Response` + +#### Returns + +[`APIError`](APIError.md) + +#### Inherited from + +[`APIError`](APIError.md).[`generate`](APIError.md#generate) diff --git a/docs/api/index/classes/QoderError.md b/docs/api/index/classes/QoderError.md new file mode 100644 index 0000000..9ec36a3 --- /dev/null +++ b/docs/api/index/classes/QoderError.md @@ -0,0 +1,81 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / QoderError + +# Class: QoderError + +## Extends + +- `Error` + +## Extended by + +- [`APIError`](APIError.md) +- [`APIConnectionError`](APIConnectionError.md) +- [`APIUserAbortError`](APIUserAbortError.md) + +## Constructors + +### Constructor + +> **new QoderError**(`message`, `options?`): `QoderError` + +#### Parameters + +##### message + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`QoderError` + +#### Overrides + +`Error.constructor` + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +`Error.cause` + +*** + +### message + +> **message**: `string` + +#### Inherited from + +`Error.message` + +*** + +### name + +> **name**: `string` + +#### Inherited from + +`Error.name` + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +`Error.stack` diff --git a/docs/api/index/classes/RateLimitError.md b/docs/api/index/classes/RateLimitError.md new file mode 100644 index 0000000..7ac8404 --- /dev/null +++ b/docs/api/index/classes/RateLimitError.md @@ -0,0 +1,213 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / RateLimitError + +# Class: RateLimitError + +## Extends + +- [`APIError`](APIError.md) + +## Constructors + +### Constructor + +> **new RateLimitError**(`status`, `error`, `message?`, `headers?`, `response?`): `RateLimitError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` = `...` + +##### response? + +`Response` + +#### Returns + +`RateLimitError` + +#### Inherited from + +[`APIError`](APIError.md).[`constructor`](APIError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`cause`](APIError.md#cause) + +*** + +### code? + +> `readonly` `optional` **code?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`code`](APIError.md#code) + +*** + +### error + +> `readonly` **error**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`error`](APIError.md#error) + +*** + +### headers + +> `readonly` **headers**: `Headers` + +#### Inherited from + +[`APIError`](APIError.md).[`headers`](APIError.md#headers) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`message`](APIError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`name`](APIError.md#name) + +*** + +### request? + +> `optional` **request?**: `Request` + +#### Inherited from + +[`APIError`](APIError.md).[`request`](APIError.md#request) + +*** + +### request\_id + +> `readonly` **request\_id**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`request_id`](APIError.md#request_id) + +*** + +### requestID + +> `readonly` **requestID**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`requestID`](APIError.md#requestid) + +*** + +### response? + +> `readonly` `optional` **response?**: `Response` + +#### Inherited from + +[`APIError`](APIError.md).[`response`](APIError.md#response) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`stack`](APIError.md#stack) + +*** + +### status + +> `readonly` **status**: `number` + +#### Inherited from + +[`APIError`](APIError.md).[`status`](APIError.md#status) + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`type`](APIError.md#type) + +## Methods + +### generate() + +> `static` **generate**(`status`, `error`, `message?`, `headers?`, `response?`): [`APIError`](APIError.md) + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` + +##### response? + +`Response` + +#### Returns + +[`APIError`](APIError.md) + +#### Inherited from + +[`APIError`](APIError.md).[`generate`](APIError.md#generate) diff --git a/docs/api/index/classes/ResumableSessionEventStream.md b/docs/api/index/classes/ResumableSessionEventStream.md new file mode 100644 index 0000000..40a73f9 --- /dev/null +++ b/docs/api/index/classes/ResumableSessionEventStream.md @@ -0,0 +1,80 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / ResumableSessionEventStream + +# Class: ResumableSessionEventStream\ + +A stateful, single-consumer Session Events stream that reconnects after retryable +failures and resumes from the last fully decoded SSE frame. + +## Type Parameters + +### T + +`T` + +## Implements + +- `AsyncIterable`\<`T`\> + +## Constructors + +### Constructor + +> **new ResumableSessionEventStream**\<`T`\>(`openStream`, `initialLastEventID?`, `signal?`): `ResumableSessionEventStream`\<`T`\> + +#### Parameters + +##### openStream + +`StreamFactory`\<`T`\> + +##### initialLastEventID? + +`string` \| `null` + +##### signal? + +`AbortSignal` \| `null` + +#### Returns + +`ResumableSessionEventStream`\<`T`\> + +## Properties + +### controller + +> `readonly` **controller**: `AbortController` + +*** + +### lastEventID + +> **lastEventID**: `string` \| `undefined` + +## Methods + +### \[asyncIterator\]() + +> **\[asyncIterator\]**(): `AsyncGenerator`\<`T`\> + +#### Returns + +`AsyncGenerator`\<`T`\> + +#### Implementation of + +`AsyncIterable.[asyncIterator]` + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/api/index/classes/Stream.md b/docs/api/index/classes/Stream.md new file mode 100644 index 0000000..d431057 --- /dev/null +++ b/docs/api/index/classes/Stream.md @@ -0,0 +1,117 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / Stream + +# Class: Stream\ + +## Type Parameters + +### T + +`T` + +## Implements + +- `AsyncIterable`\<`T`\> + +## Constructors + +### Constructor + +> **new Stream**\<`T`\>(`response`, `controller?`): `Stream`\<`T`\> + +#### Parameters + +##### response + +`Response` + +##### controller? + +`AbortController` = `...` + +#### Returns + +`Stream`\<`T`\> + +## Properties + +### completed + +> **completed**: `boolean` = `false` + +*** + +### controller + +> `readonly` **controller**: `AbortController` + +*** + +### hasLastEventID + +> **hasLastEventID**: `boolean` = `false` + +*** + +### lastEventID + +> **lastEventID**: `string` = `''` + +*** + +### response + +> `readonly` **response**: `Response` + +## Methods + +### \[asyncIterator\]() + +> **\[asyncIterator\]**(): `AsyncGenerator`\<`T`\> + +#### Returns + +`AsyncGenerator`\<`T`\> + +#### Implementation of + +`AsyncIterable.[asyncIterator]` + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### fromSSEResponse() + +> `static` **fromSSEResponse**\<`T`\>(`response`, `controller?`): `Stream`\<`T`\> + +#### Type Parameters + +##### T + +`T` + +#### Parameters + +##### response + +`Response` + +##### controller? + +`AbortController` = `...` + +#### Returns + +`Stream`\<`T`\> diff --git a/docs/api/index/classes/UnprocessableEntityError.md b/docs/api/index/classes/UnprocessableEntityError.md new file mode 100644 index 0000000..8c2059d --- /dev/null +++ b/docs/api/index/classes/UnprocessableEntityError.md @@ -0,0 +1,213 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / UnprocessableEntityError + +# Class: UnprocessableEntityError + +## Extends + +- [`APIError`](APIError.md) + +## Constructors + +### Constructor + +> **new UnprocessableEntityError**(`status`, `error`, `message?`, `headers?`, `response?`): `UnprocessableEntityError` + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` = `...` + +##### response? + +`Response` + +#### Returns + +`UnprocessableEntityError` + +#### Inherited from + +[`APIError`](APIError.md).[`constructor`](APIError.md#constructor) + +## Properties + +### cause? + +> `optional` **cause?**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`cause`](APIError.md#cause) + +*** + +### code? + +> `readonly` `optional` **code?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`code`](APIError.md#code) + +*** + +### error + +> `readonly` **error**: `unknown` + +#### Inherited from + +[`APIError`](APIError.md).[`error`](APIError.md#error) + +*** + +### headers + +> `readonly` **headers**: `Headers` + +#### Inherited from + +[`APIError`](APIError.md).[`headers`](APIError.md#headers) + +*** + +### message + +> **message**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`message`](APIError.md#message) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`name`](APIError.md#name) + +*** + +### request? + +> `optional` **request?**: `Request` + +#### Inherited from + +[`APIError`](APIError.md).[`request`](APIError.md#request) + +*** + +### request\_id + +> `readonly` **request\_id**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`request_id`](APIError.md#request_id) + +*** + +### requestID + +> `readonly` **requestID**: `string` \| `null` + +#### Inherited from + +[`APIError`](APIError.md).[`requestID`](APIError.md#requestid) + +*** + +### response? + +> `readonly` `optional` **response?**: `Response` + +#### Inherited from + +[`APIError`](APIError.md).[`response`](APIError.md#response) + +*** + +### stack? + +> `optional` **stack?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`stack`](APIError.md#stack) + +*** + +### status + +> `readonly` **status**: `number` + +#### Inherited from + +[`APIError`](APIError.md).[`status`](APIError.md#status) + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +#### Inherited from + +[`APIError`](APIError.md).[`type`](APIError.md#type) + +## Methods + +### generate() + +> `static` **generate**(`status`, `error`, `message?`, `headers?`, `response?`): [`APIError`](APIError.md) + +#### Parameters + +##### status + +`number` + +##### error + +`unknown` + +##### message? + +`string` + +##### headers? + +`Headers` + +##### response? + +`Response` + +#### Returns + +[`APIError`](APIError.md) + +#### Inherited from + +[`APIError`](APIError.md).[`generate`](APIError.md#generate) diff --git a/docs/api/index/functions/decodeSSE.md b/docs/api/index/functions/decodeSSE.md new file mode 100644 index 0000000..05f221c --- /dev/null +++ b/docs/api/index/functions/decodeSSE.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / decodeSSE + +# Function: decodeSSE() + +> **decodeSSE**(`body`): `AsyncGenerator`\<[`ServerSentEvent`](../interfaces/ServerSentEvent.md)\> + +Incremental SSE decoding: IDs identify events, not individual delta frames. + +## Parameters + +### body + +`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +## Returns + +`AsyncGenerator`\<[`ServerSentEvent`](../interfaces/ServerSentEvent.md)\> diff --git a/docs/api/index/functions/mergeHeaders.md b/docs/api/index/functions/mergeHeaders.md new file mode 100644 index 0000000..edebee1 --- /dev/null +++ b/docs/api/index/functions/mergeHeaders.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / mergeHeaders + +# Function: mergeHeaders() + +> **mergeHeaders**(...`sources`): `Headers` + +## Parameters + +### sources + +...([`HeadersLike`](../type-aliases/HeadersLike.md) \| `undefined`)[] + +## Returns + +`Headers` diff --git a/docs/api/index/functions/readEnv.md b/docs/api/index/functions/readEnv.md new file mode 100644 index 0000000..540b466 --- /dev/null +++ b/docs/api/index/functions/readEnv.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / readEnv + +# Function: readEnv() + +> **readEnv**(`name`): `string` \| `undefined` + +## Parameters + +### name + +`string` + +## Returns + +`string` \| `undefined` diff --git a/docs/api/index/functions/stringifyQuery.md b/docs/api/index/functions/stringifyQuery.md new file mode 100644 index 0000000..5e805fe --- /dev/null +++ b/docs/api/index/functions/stringifyQuery.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / stringifyQuery + +# Function: stringifyQuery() + +> **stringifyQuery**(`query`, `arrayFormat?`): `string` + +## Parameters + +### query + +`object` + +### arrayFormat? + +`"repeat"` \| `"brackets"` + +## Returns + +`string` diff --git a/docs/api/index/functions/toFile.md b/docs/api/index/functions/toFile.md new file mode 100644 index 0000000..32454e5 --- /dev/null +++ b/docs/api/index/functions/toFile.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / toFile + +# Function: toFile() + +> **toFile**(`input`, `name?`, `options?`): `Promise`\<`File`\> + +## Parameters + +### input + +`string` \| [`Uploadable`](../type-aliases/Uploadable.md) + +### name? + +`string` + +### options? + +`FilePropertyBag` + +## Returns + +`Promise`\<`File`\> diff --git a/docs/api/index/functions/toMultipartForm.md b/docs/api/index/functions/toMultipartForm.md new file mode 100644 index 0000000..1418cb4 --- /dev/null +++ b/docs/api/index/functions/toMultipartForm.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / toMultipartForm + +# Function: toMultipartForm() + +> **toMultipartForm**(`params`): `Promise`\<`FormData`\> + +File tree names and repeated `files` parts follow the API's multipart encoding. + +## Parameters + +### params + +`object` + +## Returns + +`Promise`\<`FormData`\> diff --git a/docs/api/index/interfaces/APIRequestOptions.md b/docs/api/index/interfaces/APIRequestOptions.md new file mode 100644 index 0000000..a11d4c9 --- /dev/null +++ b/docs/api/index/interfaces/APIRequestOptions.md @@ -0,0 +1,99 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / APIRequestOptions + +# Interface: APIRequestOptions + +## Extends + +- [`RequestOptions`](RequestOptions.md) + +## Properties + +### body? + +> `optional` **body?**: `unknown` + +#### Inherited from + +[`RequestOptions`](RequestOptions.md).[`body`](RequestOptions.md#body) + +*** + +### headers? + +> `optional` **headers?**: [`HeadersLike`](../type-aliases/HeadersLike.md) + +#### Inherited from + +[`RequestOptions`](RequestOptions.md).[`headers`](RequestOptions.md#headers) + +*** + +### idempotencyKey? + +> `optional` **idempotencyKey?**: `string` + +#### Inherited from + +[`RequestOptions`](RequestOptions.md).[`idempotencyKey`](RequestOptions.md#idempotencykey) + +*** + +### maxRetries? + +> `optional` **maxRetries?**: `number` + +#### Inherited from + +[`RequestOptions`](RequestOptions.md).[`maxRetries`](RequestOptions.md#maxretries) + +*** + +### method + +> **method**: `string` + +*** + +### path + +> **path**: `string` + +*** + +### query? + +> `optional` **query?**: `object` + +#### Inherited from + +[`RequestOptions`](RequestOptions.md).[`query`](RequestOptions.md#query) + +*** + +### responseType? + +> `optional` **responseType?**: `"response"` \| `"stream"` \| `"json"` \| `"binary"` \| `"void"` + +*** + +### signal? + +> `optional` **signal?**: `AbortSignal` \| `null` + +#### Inherited from + +[`RequestOptions`](RequestOptions.md).[`signal`](RequestOptions.md#signal) + +*** + +### timeout? + +> `optional` **timeout?**: `number` + +#### Inherited from + +[`RequestOptions`](RequestOptions.md).[`timeout`](RequestOptions.md#timeout) diff --git a/docs/api/index/interfaces/ClientOptions.md b/docs/api/index/interfaces/ClientOptions.md new file mode 100644 index 0000000..6d442f8 --- /dev/null +++ b/docs/api/index/interfaces/ClientOptions.md @@ -0,0 +1,77 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / ClientOptions + +# Interface: ClientOptions + +## Properties + +### baseURL? + +> `optional` **baseURL?**: `string` + +*** + +### credential? + +> `optional` **credential?**: [`Credential`](Credential.md) + +*** + +### defaultHeaders? + +> `optional` **defaultHeaders?**: [`HeadersLike`](../type-aliases/HeadersLike.md) + +*** + +### defaultQuery? + +> `optional` **defaultQuery?**: `Record`\<`string`, `unknown`\> + +*** + +### fetch? + +> `optional` **fetch?**: (`input`, `init?`) => `Promise`\<`Response`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch) + +#### Parameters + +##### input + +`URL` \| `RequestInfo` + +##### init? + +`RequestInit` + +#### Returns + +`Promise`\<`Response`\> + +*** + +### maxRetries? + +> `optional` **maxRetries?**: `number` + +*** + +### middleware? + +> `optional` **middleware?**: [`Middleware`](../type-aliases/Middleware.md)[] + +*** + +### pat? + +> `optional` **pat?**: `string` \| (() => `string` \| `Promise`\<`string`\>) + +*** + +### timeout? + +> `optional` **timeout?**: `number` diff --git a/docs/api/index/interfaces/Credential.md b/docs/api/index/interfaces/Credential.md new file mode 100644 index 0000000..335e095 --- /dev/null +++ b/docs/api/index/interfaces/Credential.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / Credential + +# Interface: Credential + +## Methods + +### getToken() + +> **getToken**(): `string` \| `Promise`\<`string`\> + +#### Returns + +`string` \| `Promise`\<`string`\> diff --git a/docs/api/index/interfaces/PageResponse.md b/docs/api/index/interfaces/PageResponse.md new file mode 100644 index 0000000..1df7b53 --- /dev/null +++ b/docs/api/index/interfaces/PageResponse.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / PageResponse + +# Interface: PageResponse\ + +## Type Parameters + +### T + +`T` + +## Indexable + +> \[`key`: `string`\]: `unknown` + +## Properties + +### data + +> **data**: `T`[] + +*** + +### first\_id? + +> `optional` **first\_id?**: `string` \| `null` + +*** + +### has\_more? + +> `optional` **has\_more?**: `boolean` + +*** + +### last\_id? + +> `optional` **last\_id?**: `string` \| `null` + +*** + +### next\_page? + +> `optional` **next\_page?**: `string` \| `null` + +*** + +### prev\_page? + +> `optional` **prev\_page?**: `string` \| `null` diff --git a/docs/api/index/interfaces/RequestOptions.md b/docs/api/index/interfaces/RequestOptions.md new file mode 100644 index 0000000..d848f22 --- /dev/null +++ b/docs/api/index/interfaces/RequestOptions.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / RequestOptions + +# Interface: RequestOptions + +## Extended by + +- [`APIRequestOptions`](APIRequestOptions.md) + +## Properties + +### body? + +> `optional` **body?**: `unknown` + +*** + +### headers? + +> `optional` **headers?**: [`HeadersLike`](../type-aliases/HeadersLike.md) + +*** + +### idempotencyKey? + +> `optional` **idempotencyKey?**: `string` + +*** + +### maxRetries? + +> `optional` **maxRetries?**: `number` + +*** + +### query? + +> `optional` **query?**: `object` + +*** + +### signal? + +> `optional` **signal?**: `AbortSignal` \| `null` + +*** + +### timeout? + +> `optional` **timeout?**: `number` diff --git a/docs/api/index/interfaces/ServerSentEvent.md b/docs/api/index/interfaces/ServerSentEvent.md new file mode 100644 index 0000000..92ee622 --- /dev/null +++ b/docs/api/index/interfaces/ServerSentEvent.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / ServerSentEvent + +# Interface: ServerSentEvent + +## Properties + +### data + +> **data**: `string` + +*** + +### event + +> **event**: `string` + +*** + +### hasID + +> **hasID**: `boolean` + +*** + +### id + +> **id**: `string` + +*** + +### retry? + +> `optional` **retry?**: `number` diff --git a/docs/api/index/type-aliases/HeadersLike.md b/docs/api/index/type-aliases/HeadersLike.md new file mode 100644 index 0000000..a61d521 --- /dev/null +++ b/docs/api/index/type-aliases/HeadersLike.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / HeadersLike + +# Type Alias: HeadersLike + +> **HeadersLike** = `HeadersInit` \| `Record`\<`string`, `string` \| `null` \| `undefined`\> diff --git a/docs/api/index/type-aliases/Middleware.md b/docs/api/index/type-aliases/Middleware.md new file mode 100644 index 0000000..ae2e6a7 --- /dev/null +++ b/docs/api/index/type-aliases/Middleware.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / Middleware + +# Type Alias: Middleware + +> **Middleware** = (`request`, `next`) => `Promise`\<`Response`\> + +## Parameters + +### request + +`Request` + +### next + +(`request`) => `Promise`\<`Response`\> + +## Returns + +`Promise`\<`Response`\> diff --git a/docs/api/index/type-aliases/PaginationMode.md b/docs/api/index/type-aliases/PaginationMode.md new file mode 100644 index 0000000..04e0f09 --- /dev/null +++ b/docs/api/index/type-aliases/PaginationMode.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / PaginationMode + +# Type Alias: PaginationMode + +> **PaginationMode** = `"cursor"` \| `"page"` \| `"page_token"` diff --git a/docs/api/index/type-aliases/Uploadable.md b/docs/api/index/type-aliases/Uploadable.md new file mode 100644 index 0000000..235ed2d --- /dev/null +++ b/docs/api/index/type-aliases/Uploadable.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / Uploadable + +# Type Alias: Uploadable + +> **Uploadable** = `Blob` \| `Uint8Array` \| `ArrayBuffer` \| `Response` \| `AsyncIterable`\<`Uint8Array` \| `string`\> \| `ReadableStream`\<`Uint8Array`\> \| \{ `data`: `Uploadable`; `name?`: `string`; `type?`: `string`; \} diff --git a/docs/api/index/variables/VERSION.md b/docs/api/index/variables/VERSION.md new file mode 100644 index 0000000..b839547 --- /dev/null +++ b/docs/api/index/variables/VERSION.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [index](../README.md) / VERSION + +# Variable: VERSION + +> `const` **VERSION**: `"0.1.0"` = `'0.1.0'` diff --git a/docs/api/managed/README.md b/docs/api/managed/README.md new file mode 100644 index 0000000..65050c7 --- /dev/null +++ b/docs/api/managed/README.md @@ -0,0 +1,1178 @@ +[**qca-sdk**](../README.md) + +*** + +[qca-sdk](../README.md) / managed + +# managed + +## Classes + +- [Agents](classes/Agents.md) +- [AgentsVersions](classes/AgentsVersions.md) +- [DeploymentRuns](classes/DeploymentRuns.md) +- [Deployments](classes/Deployments.md) +- [Dreams](classes/Dreams.md) +- [Environments](classes/Environments.md) +- [EnvironmentsWork](classes/EnvironmentsWork.md) +- [Files](classes/Files.md) +- [MemoryStores](classes/MemoryStores.md) +- [MemoryStoresMemories](classes/MemoryStoresMemories.md) +- [MemoryStoresMemoryVersions](classes/MemoryStoresMemoryVersions.md) +- [Models](classes/Models.md) +- [Sessions](classes/Sessions.md) +- [SessionsEvents](classes/SessionsEvents.md) +- [SessionsResources](classes/SessionsResources.md) +- [SessionsThreads](classes/SessionsThreads.md) +- [SessionsThreadsEvents](classes/SessionsThreadsEvents.md) +- [Skills](classes/Skills.md) +- [SkillsVersions](classes/SkillsVersions.md) +- [Vaults](classes/Vaults.md) +- [VaultsCredentials](classes/VaultsCredentials.md) + +## Interfaces + +- [AdvisorRedactedResultBlockParam](interfaces/AdvisorRedactedResultBlockParam.md) +- [AdvisorResultBlockParam](interfaces/AdvisorResultBlockParam.md) +- [AdvisorToolResultBlockParam](interfaces/AdvisorToolResultBlockParam.md) +- [AdvisorToolResultErrorParam](interfaces/AdvisorToolResultErrorParam.md) +- [AgentArchiveParams](interfaces/AgentArchiveParams.md) +- [AgentGetParams](interfaces/AgentGetParams.md) +- [AgentListParams](interfaces/AgentListParams.md) +- [AgentNewParams](interfaces/AgentNewParams.md) +- [AgentUpdateParams](interfaces/AgentUpdateParams.md) +- [AgentVersionListParams](interfaces/AgentVersionListParams.md) +- [Base64ImageSourceParam](interfaces/Base64ImageSourceParam.md) +- [Base64PDFSourceParam](interfaces/Base64PDFSourceParam.md) +- [BashCodeExecutionOutputBlockParam](interfaces/BashCodeExecutionOutputBlockParam.md) +- [BashCodeExecutionResultBlockParam](interfaces/BashCodeExecutionResultBlockParam.md) +- [BashCodeExecutionToolResultBlockParam](interfaces/BashCodeExecutionToolResultBlockParam.md) +- [BashCodeExecutionToolResultErrorParam](interfaces/BashCodeExecutionToolResultErrorParam.md) +- [BrowserStateBlockParam](interfaces/BrowserStateBlockParam.md) +- [BrowserStateChangeDownloadCompletedParam](interfaces/BrowserStateChangeDownloadCompletedParam.md) +- [BrowserStateChangeDownloadFailedParam](interfaces/BrowserStateChangeDownloadFailedParam.md) +- [BrowserStateChangeDownloadStartedParam](interfaces/BrowserStateChangeDownloadStartedParam.md) +- [BrowserStateChangeTabOpenedParam](interfaces/BrowserStateChangeTabOpenedParam.md) +- [BrowserStateTabEntryParam](interfaces/BrowserStateTabEntryParam.md) +- [CacheControlEphemeralParam](interfaces/CacheControlEphemeralParam.md) +- [CapabilitySupport](interfaces/CapabilitySupport.md) +- [CitationCharLocationParam](interfaces/CitationCharLocationParam.md) +- [CitationContentBlockLocationParam](interfaces/CitationContentBlockLocationParam.md) +- [CitationPageLocationParam](interfaces/CitationPageLocationParam.md) +- [CitationsConfigParam](interfaces/CitationsConfigParam.md) +- [CitationSearchResultLocationParam](interfaces/CitationSearchResultLocationParam.md) +- [CitationWebSearchResultLocationParam](interfaces/CitationWebSearchResultLocationParam.md) +- [CloudConfig](interfaces/CloudConfig.md) +- [CloudConfigParams](interfaces/CloudConfigParams.md) +- [CodeExecutionOutputBlockParam](interfaces/CodeExecutionOutputBlockParam.md) +- [CodeExecutionResultBlockParam](interfaces/CodeExecutionResultBlockParam.md) +- [CodeExecutionToolResultBlockParam](interfaces/CodeExecutionToolResultBlockParam.md) +- [CodeExecutionToolResultErrorParam](interfaces/CodeExecutionToolResultErrorParam.md) +- [CompactionBlockParam](interfaces/CompactionBlockParam.md) +- [ContainerUploadBlockParam](interfaces/ContainerUploadBlockParam.md) +- [ContentBlockSourceParam](interfaces/ContentBlockSourceParam.md) +- [ContextManagementCapability](interfaces/ContextManagementCapability.md) +- [DeletedFile](interfaces/DeletedFile.md) +- [DeletedSkill](interfaces/DeletedSkill.md) +- [DeletedSkillVersion](interfaces/DeletedSkillVersion.md) +- [DeploymentArchiveParams](interfaces/DeploymentArchiveParams.md) +- [DeploymentGetParams](interfaces/DeploymentGetParams.md) +- [DeploymentListParams](interfaces/DeploymentListParams.md) +- [DeploymentNewParams](interfaces/DeploymentNewParams.md) +- [DeploymentPauseParams](interfaces/DeploymentPauseParams.md) +- [DeploymentRunGetParams](interfaces/DeploymentRunGetParams.md) +- [DeploymentRunListParams](interfaces/DeploymentRunListParams.md) +- [DeploymentRunParams](interfaces/DeploymentRunParams.md) +- [DeploymentUnpauseParams](interfaces/DeploymentUnpauseParams.md) +- [DeploymentUpdateParams](interfaces/DeploymentUpdateParams.md) +- [DirectCallerParam](interfaces/DirectCallerParam.md) +- [Dream](interfaces/Dream.md) +- [DreamArchiveParams](interfaces/DreamArchiveParams.md) +- [DreamCancelParams](interfaces/DreamCancelParams.md) +- [DreamError](interfaces/DreamError.md) +- [DreamGetParams](interfaces/DreamGetParams.md) +- [DreamListParams](interfaces/DreamListParams.md) +- [DreamMemoryStoreInput](interfaces/DreamMemoryStoreInput.md) +- [DreamMemoryStoreInputParam](interfaces/DreamMemoryStoreInputParam.md) +- [DreamModelConfig](interfaces/DreamModelConfig.md) +- [DreamModelConfigParam](interfaces/DreamModelConfigParam.md) +- [DreamNewParams](interfaces/DreamNewParams.md) +- [DreamOutput](interfaces/DreamOutput.md) +- [DreamSessionsInput](interfaces/DreamSessionsInput.md) +- [DreamSessionsInputParam](interfaces/DreamSessionsInputParam.md) +- [DreamUsage](interfaces/DreamUsage.md) +- [EffortCapability](interfaces/EffortCapability.md) +- [EncryptedCodeExecutionResultBlockParam](interfaces/EncryptedCodeExecutionResultBlockParam.md) +- [Environment](interfaces/Environment.md) +- [EnvironmentArchiveParams](interfaces/EnvironmentArchiveParams.md) +- [EnvironmentDeleteParams](interfaces/EnvironmentDeleteParams.md) +- [EnvironmentDeleteResponse](interfaces/EnvironmentDeleteResponse.md) +- [EnvironmentGetParams](interfaces/EnvironmentGetParams.md) +- [EnvironmentListParams](interfaces/EnvironmentListParams.md) +- [EnvironmentNewParams](interfaces/EnvironmentNewParams.md) +- [EnvironmentUpdateParams](interfaces/EnvironmentUpdateParams.md) +- [EnvironmentWorkAckParams](interfaces/EnvironmentWorkAckParams.md) +- [EnvironmentWorkGetParams](interfaces/EnvironmentWorkGetParams.md) +- [EnvironmentWorkHeartbeatParams](interfaces/EnvironmentWorkHeartbeatParams.md) +- [EnvironmentWorkListParams](interfaces/EnvironmentWorkListParams.md) +- [EnvironmentWorkPollParams](interfaces/EnvironmentWorkPollParams.md) +- [EnvironmentWorkStatsParams](interfaces/EnvironmentWorkStatsParams.md) +- [EnvironmentWorkStopParams](interfaces/EnvironmentWorkStopParams.md) +- [EnvironmentWorkUpdateParams](interfaces/EnvironmentWorkUpdateParams.md) +- [FallbackBlockParam](interfaces/FallbackBlockParam.md) +- [FallbackInfoParam](interfaces/FallbackInfoParam.md) +- [FileDeleteParams](interfaces/FileDeleteParams.md) +- [FileDocumentSourceParam](interfaces/FileDocumentSourceParam.md) +- [FileDownloadParams](interfaces/FileDownloadParams.md) +- [FileGetMetadataParams](interfaces/FileGetMetadataParams.md) +- [FileImageSourceParam](interfaces/FileImageSourceParam.md) +- [FileListParams](interfaces/FileListParams.md) +- [FileMetadata](interfaces/FileMetadata.md) +- [FileScope](interfaces/FileScope.md) +- [FileUploadParams](interfaces/FileUploadParams.md) +- [HealthCheckWorkData](interfaces/HealthCheckWorkData.md) +- [ImageBlockParam](interfaces/ImageBlockParam.md) +- [ImageTransformationsParam](interfaces/ImageTransformationsParam.md) +- [LimitedNetwork](interfaces/LimitedNetwork.md) +- [LimitedNetworkParams](interfaces/LimitedNetworkParams.md) +- [ManagedAgentsAdvisor](interfaces/ManagedAgentsAdvisor.md) +- [ManagedAgentsAdvisorParams](interfaces/ManagedAgentsAdvisorParams.md) +- [ManagedAgentsAgent](interfaces/ManagedAgentsAgent.md) +- [ManagedAgentsAgentArchivedDeploymentPausedReasonError](interfaces/ManagedAgentsAgentArchivedDeploymentPausedReasonError.md) +- [ManagedAgentsAgentArchivedRunError](interfaces/ManagedAgentsAgentArchivedRunError.md) +- [ManagedAgentsAgentCustomToolUseEvent](interfaces/ManagedAgentsAgentCustomToolUseEvent.md) +- [ManagedAgentsAgentMCPToolResultEvent](interfaces/ManagedAgentsAgentMCPToolResultEvent.md) +- [ManagedAgentsAgentMCPToolUseEvent](interfaces/ManagedAgentsAgentMCPToolUseEvent.md) +- [ManagedAgentsAgentMessageEvent](interfaces/ManagedAgentsAgentMessageEvent.md) +- [ManagedAgentsAgentMessagePreview](interfaces/ManagedAgentsAgentMessagePreview.md) +- [ManagedAgentsAgentParams](interfaces/ManagedAgentsAgentParams.md) +- [ManagedAgentsAgentReference](interfaces/ManagedAgentsAgentReference.md) +- [ManagedAgentsAgentThinkingEvent](interfaces/ManagedAgentsAgentThinkingEvent.md) +- [ManagedAgentsAgentThinkingPreview](interfaces/ManagedAgentsAgentThinkingPreview.md) +- [ManagedAgentsAgentThreadContextCompactedEvent](interfaces/ManagedAgentsAgentThreadContextCompactedEvent.md) +- [ManagedAgentsAgentThreadMessageReceivedEvent](interfaces/ManagedAgentsAgentThreadMessageReceivedEvent.md) +- [ManagedAgentsAgentThreadMessageReceivedEventContentUnionSource](interfaces/ManagedAgentsAgentThreadMessageReceivedEventContentUnionSource.md) +- [ManagedAgentsAgentThreadMessageSentEvent](interfaces/ManagedAgentsAgentThreadMessageSentEvent.md) +- [ManagedAgentsAgentThreadMessageSentEventContentUnionSource](interfaces/ManagedAgentsAgentThreadMessageSentEventContentUnionSource.md) +- [ManagedAgentsAgentToolConfigUnionPermissionPolicy](interfaces/ManagedAgentsAgentToolConfigUnionPermissionPolicy.md) +- [ManagedAgentsAgentToolResultEvent](interfaces/ManagedAgentsAgentToolResultEvent.md) +- [ManagedAgentsAgentToolset20260401](interfaces/ManagedAgentsAgentToolset20260401.md) +- [ManagedAgentsAgentToolset20260401BashInput](interfaces/ManagedAgentsAgentToolset20260401BashInput.md) +- [ManagedAgentsAgentToolset20260401EditInput](interfaces/ManagedAgentsAgentToolset20260401EditInput.md) +- [ManagedAgentsAgentToolset20260401GlobInput](interfaces/ManagedAgentsAgentToolset20260401GlobInput.md) +- [ManagedAgentsAgentToolset20260401GrepInput](interfaces/ManagedAgentsAgentToolset20260401GrepInput.md) +- [ManagedAgentsAgentToolset20260401Params](interfaces/ManagedAgentsAgentToolset20260401Params.md) +- [ManagedAgentsAgentToolset20260401ReadInput](interfaces/ManagedAgentsAgentToolset20260401ReadInput.md) +- [ManagedAgentsAgentToolset20260401WriteInput](interfaces/ManagedAgentsAgentToolset20260401WriteInput.md) +- [ManagedAgentsAgentToolsetDefaultConfig](interfaces/ManagedAgentsAgentToolsetDefaultConfig.md) +- [ManagedAgentsAgentToolsetDefaultConfigParams](interfaces/ManagedAgentsAgentToolsetDefaultConfigParams.md) +- [ManagedAgentsAgentToolUnionDefaultConfig](interfaces/ManagedAgentsAgentToolUnionDefaultConfig.md) +- [ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy](interfaces/ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy.md) +- [ManagedAgentsAgentToolUseEvent](interfaces/ManagedAgentsAgentToolUseEvent.md) +- [ManagedAgentsAgentWithOverridesParams](interfaces/ManagedAgentsAgentWithOverridesParams.md) +- [ManagedAgentsAlwaysAllowPolicy](interfaces/ManagedAgentsAlwaysAllowPolicy.md) +- [ManagedAgentsAlwaysAllowPolicyParam](interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) +- [ManagedAgentsAlwaysAskPolicy](interfaces/ManagedAgentsAlwaysAskPolicy.md) +- [ManagedAgentsAlwaysAskPolicyParam](interfaces/ManagedAgentsAlwaysAskPolicyParam.md) +- [ManagedAgentsAPIActor](interfaces/ManagedAgentsAPIActor.md) +- [ManagedAgentsBase64DocumentSource](interfaces/ManagedAgentsBase64DocumentSource.md) +- [ManagedAgentsBase64DocumentSourceParam](interfaces/ManagedAgentsBase64DocumentSourceParam.md) +- [ManagedAgentsBase64ImageSource](interfaces/ManagedAgentsBase64ImageSource.md) +- [ManagedAgentsBase64ImageSourceParam](interfaces/ManagedAgentsBase64ImageSourceParam.md) +- [ManagedAgentsBashToolConfig](interfaces/ManagedAgentsBashToolConfig.md) +- [ManagedAgentsBashToolConfigParams](interfaces/ManagedAgentsBashToolConfigParams.md) +- [ManagedAgentsBillingError](interfaces/ManagedAgentsBillingError.md) +- [ManagedAgentsBranchCheckout](interfaces/ManagedAgentsBranchCheckout.md) +- [ManagedAgentsBranchCheckoutParam](interfaces/ManagedAgentsBranchCheckoutParam.md) +- [ManagedAgentsBudgetLimit](interfaces/ManagedAgentsBudgetLimit.md) +- [ManagedAgentsBudgetLimitParam](interfaces/ManagedAgentsBudgetLimitParam.md) +- [ManagedAgentsCacheCreationUsage](interfaces/ManagedAgentsCacheCreationUsage.md) +- [ManagedAgentsCommitCheckout](interfaces/ManagedAgentsCommitCheckout.md) +- [ManagedAgentsCommitCheckoutParam](interfaces/ManagedAgentsCommitCheckoutParam.md) +- [ManagedAgentsCredential](interfaces/ManagedAgentsCredential.md) +- [ManagedAgentsCredentialHostUnreachableError](interfaces/ManagedAgentsCredentialHostUnreachableError.md) +- [ManagedAgentsCredentialValidation](interfaces/ManagedAgentsCredentialValidation.md) +- [ManagedAgentsCustomSkill](interfaces/ManagedAgentsCustomSkill.md) +- [ManagedAgentsCustomSkillParams](interfaces/ManagedAgentsCustomSkillParams.md) +- [ManagedAgentsCustomTool](interfaces/ManagedAgentsCustomTool.md) +- [ManagedAgentsCustomToolInputSchema](interfaces/ManagedAgentsCustomToolInputSchema.md) +- [ManagedAgentsCustomToolInputSchemaParam](interfaces/ManagedAgentsCustomToolInputSchemaParam.md) +- [ManagedAgentsCustomToolParams](interfaces/ManagedAgentsCustomToolParams.md) +- [ManagedAgentsDeletedCredential](interfaces/ManagedAgentsDeletedCredential.md) +- [ManagedAgentsDeletedMemory](interfaces/ManagedAgentsDeletedMemory.md) +- [ManagedAgentsDeletedMemoryStore](interfaces/ManagedAgentsDeletedMemoryStore.md) +- [ManagedAgentsDeletedSession](interfaces/ManagedAgentsDeletedSession.md) +- [ManagedAgentsDeletedVault](interfaces/ManagedAgentsDeletedVault.md) +- [ManagedAgentsDeleteSessionResource](interfaces/ManagedAgentsDeleteSessionResource.md) +- [ManagedAgentsDeltaContent](interfaces/ManagedAgentsDeltaContent.md) +- [ManagedAgentsDeltaEvent](interfaces/ManagedAgentsDeltaEvent.md) +- [ManagedAgentsDeployment](interfaces/ManagedAgentsDeployment.md) +- [ManagedAgentsDeploymentRun](interfaces/ManagedAgentsDeploymentRun.md) +- [ManagedAgentsDeploymentSystemMessageEvent](interfaces/ManagedAgentsDeploymentSystemMessageEvent.md) +- [ManagedAgentsDeploymentUserDefineOutcomeEvent](interfaces/ManagedAgentsDeploymentUserDefineOutcomeEvent.md) +- [ManagedAgentsDeploymentUserMessageEvent](interfaces/ManagedAgentsDeploymentUserMessageEvent.md) +- [ManagedAgentsDeploymentUserMessageEventContentUnionSource](interfaces/ManagedAgentsDeploymentUserMessageEventContentUnionSource.md) +- [ManagedAgentsDocumentBlock](interfaces/ManagedAgentsDocumentBlock.md) +- [ManagedAgentsDocumentBlockParam](interfaces/ManagedAgentsDocumentBlockParam.md) +- [ManagedAgentsEditToolConfig](interfaces/ManagedAgentsEditToolConfig.md) +- [ManagedAgentsEditToolConfigParams](interfaces/ManagedAgentsEditToolConfigParams.md) +- [ManagedAgentsEffortHigh](interfaces/ManagedAgentsEffortHigh.md) +- [ManagedAgentsEffortHighParam](interfaces/ManagedAgentsEffortHighParam.md) +- [ManagedAgentsEffortLow](interfaces/ManagedAgentsEffortLow.md) +- [ManagedAgentsEffortLowParam](interfaces/ManagedAgentsEffortLowParam.md) +- [ManagedAgentsEffortMax](interfaces/ManagedAgentsEffortMax.md) +- [ManagedAgentsEffortMaxParam](interfaces/ManagedAgentsEffortMaxParam.md) +- [ManagedAgentsEffortMedium](interfaces/ManagedAgentsEffortMedium.md) +- [ManagedAgentsEffortMediumParam](interfaces/ManagedAgentsEffortMediumParam.md) +- [ManagedAgentsEffortXhigh](interfaces/ManagedAgentsEffortXhigh.md) +- [ManagedAgentsEffortXhighParam](interfaces/ManagedAgentsEffortXhighParam.md) +- [ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError](interfaces/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError.md) +- [ManagedAgentsEnvironmentArchivedRunError](interfaces/ManagedAgentsEnvironmentArchivedRunError.md) +- [ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError](interfaces/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError.md) +- [ManagedAgentsEnvironmentNotFoundRunError](interfaces/ManagedAgentsEnvironmentNotFoundRunError.md) +- [ManagedAgentsEnvironmentVariableAuthResponse](interfaces/ManagedAgentsEnvironmentVariableAuthResponse.md) +- [ManagedAgentsEnvironmentVariableCreateParams](interfaces/ManagedAgentsEnvironmentVariableCreateParams.md) +- [ManagedAgentsEnvironmentVariableUpdateParams](interfaces/ManagedAgentsEnvironmentVariableUpdateParams.md) +- [ManagedAgentsErrorDeploymentPausedReason](interfaces/ManagedAgentsErrorDeploymentPausedReason.md) +- [ManagedAgentsFileDocumentSource](interfaces/ManagedAgentsFileDocumentSource.md) +- [ManagedAgentsFileDocumentSourceParam](interfaces/ManagedAgentsFileDocumentSourceParam.md) +- [ManagedAgentsFileImageSource](interfaces/ManagedAgentsFileImageSource.md) +- [ManagedAgentsFileImageSourceParam](interfaces/ManagedAgentsFileImageSourceParam.md) +- [ManagedAgentsFileNotFoundDeploymentPausedReasonError](interfaces/ManagedAgentsFileNotFoundDeploymentPausedReasonError.md) +- [ManagedAgentsFileNotFoundRunError](interfaces/ManagedAgentsFileNotFoundRunError.md) +- [ManagedAgentsFileResource](interfaces/ManagedAgentsFileResource.md) +- [ManagedAgentsFileResourceConfig](interfaces/ManagedAgentsFileResourceConfig.md) +- [ManagedAgentsFileResourceParams](interfaces/ManagedAgentsFileResourceParams.md) +- [ManagedAgentsFileRubric](interfaces/ManagedAgentsFileRubric.md) +- [ManagedAgentsFileRubricParams](interfaces/ManagedAgentsFileRubricParams.md) +- [ManagedAgentsGitHubRepositoryResource](interfaces/ManagedAgentsGitHubRepositoryResource.md) +- [ManagedAgentsGitHubRepositoryResourceConfig](interfaces/ManagedAgentsGitHubRepositoryResourceConfig.md) +- [ManagedAgentsGitHubRepositoryResourceParams](interfaces/ManagedAgentsGitHubRepositoryResourceParams.md) +- [ManagedAgentsGlobToolConfig](interfaces/ManagedAgentsGlobToolConfig.md) +- [ManagedAgentsGlobToolConfigParams](interfaces/ManagedAgentsGlobToolConfigParams.md) +- [ManagedAgentsGrepToolConfig](interfaces/ManagedAgentsGrepToolConfig.md) +- [ManagedAgentsGrepToolConfigParams](interfaces/ManagedAgentsGrepToolConfigParams.md) +- [ManagedAgentsImageBlock](interfaces/ManagedAgentsImageBlock.md) +- [ManagedAgentsImageBlockParam](interfaces/ManagedAgentsImageBlockParam.md) +- [ManagedAgentsInjectionLocationParams](interfaces/ManagedAgentsInjectionLocationParams.md) +- [ManagedAgentsInjectionLocationResponse](interfaces/ManagedAgentsInjectionLocationResponse.md) +- [ManagedAgentsInjectionLocationUpdateParams](interfaces/ManagedAgentsInjectionLocationUpdateParams.md) +- [ManagedAgentsLimitedCredentialNetworkingParams](interfaces/ManagedAgentsLimitedCredentialNetworkingParams.md) +- [ManagedAgentsLimitedCredentialNetworkingResponse](interfaces/ManagedAgentsLimitedCredentialNetworkingResponse.md) +- [ManagedAgentsManualDeploymentPausedReason](interfaces/ManagedAgentsManualDeploymentPausedReason.md) +- [ManagedAgentsManualTriggerContext](interfaces/ManagedAgentsManualTriggerContext.md) +- [ManagedAgentsMCPAuthenticationFailedError](interfaces/ManagedAgentsMCPAuthenticationFailedError.md) +- [ManagedAgentsMCPConnectionFailedError](interfaces/ManagedAgentsMCPConnectionFailedError.md) +- [ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError](interfaces/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError.md) +- [ManagedAgentsMCPEgressBlockedRunError](interfaces/ManagedAgentsMCPEgressBlockedRunError.md) +- [ManagedAgentsMCPOAuthAuthResponse](interfaces/ManagedAgentsMCPOAuthAuthResponse.md) +- [ManagedAgentsMCPOAuthCreateParams](interfaces/ManagedAgentsMCPOAuthCreateParams.md) +- [ManagedAgentsMCPOAuthRefreshParams](interfaces/ManagedAgentsMCPOAuthRefreshParams.md) +- [ManagedAgentsMCPOAuthRefreshResponse](interfaces/ManagedAgentsMCPOAuthRefreshResponse.md) +- [ManagedAgentsMCPOAuthRefreshUpdateParams](interfaces/ManagedAgentsMCPOAuthRefreshUpdateParams.md) +- [ManagedAgentsMCPOAuthUpdateParams](interfaces/ManagedAgentsMCPOAuthUpdateParams.md) +- [ManagedAgentsMCPProbe](interfaces/ManagedAgentsMCPProbe.md) +- [ManagedAgentsMCPServerURLDefinition](interfaces/ManagedAgentsMCPServerURLDefinition.md) +- [ManagedAgentsMCPToolConfig](interfaces/ManagedAgentsMCPToolConfig.md) +- [ManagedAgentsMCPToolConfigParams](interfaces/ManagedAgentsMCPToolConfigParams.md) +- [ManagedAgentsMCPToolset](interfaces/ManagedAgentsMCPToolset.md) +- [ManagedAgentsMCPToolsetDefaultConfig](interfaces/ManagedAgentsMCPToolsetDefaultConfig.md) +- [ManagedAgentsMCPToolsetDefaultConfigParams](interfaces/ManagedAgentsMCPToolsetDefaultConfigParams.md) +- [ManagedAgentsMCPToolsetParams](interfaces/ManagedAgentsMCPToolsetParams.md) +- [ManagedAgentsMemory](interfaces/ManagedAgentsMemory.md) +- [ManagedAgentsMemoryPrefix](interfaces/ManagedAgentsMemoryPrefix.md) +- [ManagedAgentsMemoryStore](interfaces/ManagedAgentsMemoryStore.md) +- [ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError](interfaces/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError.md) +- [ManagedAgentsMemoryStoreArchivedRunError](interfaces/ManagedAgentsMemoryStoreArchivedRunError.md) +- [ManagedAgentsMemoryStoreResource](interfaces/ManagedAgentsMemoryStoreResource.md) +- [ManagedAgentsMemoryStoreResourceConfig](interfaces/ManagedAgentsMemoryStoreResourceConfig.md) +- [ManagedAgentsMemoryStoreResourceParam](interfaces/ManagedAgentsMemoryStoreResourceParam.md) +- [ManagedAgentsMemoryVersion](interfaces/ManagedAgentsMemoryVersion.md) +- [ManagedAgentsModelOverloadedError](interfaces/ManagedAgentsModelOverloadedError.md) +- [ManagedAgentsModelRateLimitedError](interfaces/ManagedAgentsModelRateLimitedError.md) +- [ManagedAgentsModelRequestFailedError](interfaces/ManagedAgentsModelRequestFailedError.md) +- [ManagedAgentsMultiagent](interfaces/ManagedAgentsMultiagent.md) +- [ManagedAgentsMultiagentParams](interfaces/ManagedAgentsMultiagentParams.md) +- [ManagedAgentsMultiagentSelfParams](interfaces/ManagedAgentsMultiagentSelfParams.md) +- [ManagedAgentsOrganizationDisabledDeploymentPausedReasonError](interfaces/ManagedAgentsOrganizationDisabledDeploymentPausedReasonError.md) +- [ManagedAgentsOrganizationDisabledRunError](interfaces/ManagedAgentsOrganizationDisabledRunError.md) +- [ManagedAgentsOutcomeEvaluationResource](interfaces/ManagedAgentsOutcomeEvaluationResource.md) +- [ManagedAgentsPlainTextDocumentSource](interfaces/ManagedAgentsPlainTextDocumentSource.md) +- [ManagedAgentsPlainTextDocumentSourceParam](interfaces/ManagedAgentsPlainTextDocumentSourceParam.md) +- [ManagedAgentsPreconditionParam](interfaces/ManagedAgentsPreconditionParam.md) +- [ManagedAgentsQoderSkill](interfaces/ManagedAgentsQoderSkill.md) +- [ManagedAgentsQoderSkillParams](interfaces/ManagedAgentsQoderSkillParams.md) +- [ManagedAgentsReadToolConfig](interfaces/ManagedAgentsReadToolConfig.md) +- [ManagedAgentsReadToolConfigParams](interfaces/ManagedAgentsReadToolConfigParams.md) +- [ManagedAgentsRedactedBlock](interfaces/ManagedAgentsRedactedBlock.md) +- [ManagedAgentsRedactedBlockParam](interfaces/ManagedAgentsRedactedBlockParam.md) +- [ManagedAgentsRefreshHTTPResponse](interfaces/ManagedAgentsRefreshHTTPResponse.md) +- [ManagedAgentsRefreshObject](interfaces/ManagedAgentsRefreshObject.md) +- [ManagedAgentsRetryStatusExhausted](interfaces/ManagedAgentsRetryStatusExhausted.md) +- [ManagedAgentsRetryStatusRetrying](interfaces/ManagedAgentsRetryStatusRetrying.md) +- [ManagedAgentsRetryStatusTerminal](interfaces/ManagedAgentsRetryStatusTerminal.md) +- [ManagedAgentsSchedule](interfaces/ManagedAgentsSchedule.md) +- [ManagedAgentsScheduleParams](interfaces/ManagedAgentsScheduleParams.md) +- [ManagedAgentsScheduleTriggerContext](interfaces/ManagedAgentsScheduleTriggerContext.md) +- [ManagedAgentsSearchResultBlock](interfaces/ManagedAgentsSearchResultBlock.md) +- [ManagedAgentsSearchResultBlockParam](interfaces/ManagedAgentsSearchResultBlockParam.md) +- [ManagedAgentsSearchResultCitations](interfaces/ManagedAgentsSearchResultCitations.md) +- [ManagedAgentsSearchResultCitationsParam](interfaces/ManagedAgentsSearchResultCitationsParam.md) +- [ManagedAgentsSearchResultContent](interfaces/ManagedAgentsSearchResultContent.md) +- [ManagedAgentsSearchResultContentParam](interfaces/ManagedAgentsSearchResultContentParam.md) +- [ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError](interfaces/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError.md) +- [ManagedAgentsSelfHostedResourcesUnsupportedRunError](interfaces/ManagedAgentsSelfHostedResourcesUnsupportedRunError.md) +- [ManagedAgentsSendSessionEvents](interfaces/ManagedAgentsSendSessionEvents.md) +- [ManagedAgentsServerToolUsage](interfaces/ManagedAgentsServerToolUsage.md) +- [ManagedAgentsServiceAccountActor](interfaces/ManagedAgentsServiceAccountActor.md) +- [ManagedAgentsSession](interfaces/ManagedAgentsSession.md) +- [ManagedAgentsSessionActor](interfaces/ManagedAgentsSessionActor.md) +- [ManagedAgentsSessionAgent](interfaces/ManagedAgentsSessionAgent.md) +- [ManagedAgentsSessionAgentToolUnionDefaultConfig](interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfig.md) +- [ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy](interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy.md) +- [ManagedAgentsSessionAgentUpdateParam](interfaces/ManagedAgentsSessionAgentUpdateParam.md) +- [ManagedAgentsSessionBudgetReached](interfaces/ManagedAgentsSessionBudgetReached.md) +- [ManagedAgentsSessionCreationRejectedRunError](interfaces/ManagedAgentsSessionCreationRejectedRunError.md) +- [ManagedAgentsSessionDeletedEvent](interfaces/ManagedAgentsSessionDeletedEvent.md) +- [ManagedAgentsSessionEndTurn](interfaces/ManagedAgentsSessionEndTurn.md) +- [ManagedAgentsSessionErrorEvent](interfaces/ManagedAgentsSessionErrorEvent.md) +- [ManagedAgentsSessionErrorEventErrorUnionRetryStatus](interfaces/ManagedAgentsSessionErrorEventErrorUnionRetryStatus.md) +- [ManagedAgentsSessionEventUnionStopReason](interfaces/ManagedAgentsSessionEventUnionStopReason.md) +- [ManagedAgentsSessionEventUnionUsage](interfaces/ManagedAgentsSessionEventUnionUsage.md) +- [ManagedAgentsSessionMultiagentCoordinator](interfaces/ManagedAgentsSessionMultiagentCoordinator.md) +- [ManagedAgentsSessionRateLimitedRunError](interfaces/ManagedAgentsSessionRateLimitedRunError.md) +- [ManagedAgentsSessionRequiresAction](interfaces/ManagedAgentsSessionRequiresAction.md) +- [ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError](interfaces/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError.md) +- [ManagedAgentsSessionResourceNotFoundRunError](interfaces/ManagedAgentsSessionResourceNotFoundRunError.md) +- [ManagedAgentsSessionRetriesExhausted](interfaces/ManagedAgentsSessionRetriesExhausted.md) +- [ManagedAgentsSessionStats](interfaces/ManagedAgentsSessionStats.md) +- [ManagedAgentsSessionStatusIdleEvent](interfaces/ManagedAgentsSessionStatusIdleEvent.md) +- [ManagedAgentsSessionStatusRescheduledEvent](interfaces/ManagedAgentsSessionStatusRescheduledEvent.md) +- [ManagedAgentsSessionStatusRunningEvent](interfaces/ManagedAgentsSessionStatusRunningEvent.md) +- [ManagedAgentsSessionStatusTerminatedEvent](interfaces/ManagedAgentsSessionStatusTerminatedEvent.md) +- [ManagedAgentsSessionThread](interfaces/ManagedAgentsSessionThread.md) +- [ManagedAgentsSessionThreadAgent](interfaces/ManagedAgentsSessionThreadAgent.md) +- [ManagedAgentsSessionThreadAgentToolUnionDefaultConfig](interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfig.md) +- [ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy](interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy.md) +- [ManagedAgentsSessionThreadCreatedEvent](interfaces/ManagedAgentsSessionThreadCreatedEvent.md) +- [ManagedAgentsSessionThreadStats](interfaces/ManagedAgentsSessionThreadStats.md) +- [ManagedAgentsSessionThreadStatusIdleEvent](interfaces/ManagedAgentsSessionThreadStatusIdleEvent.md) +- [ManagedAgentsSessionThreadStatusRescheduledEvent](interfaces/ManagedAgentsSessionThreadStatusRescheduledEvent.md) +- [ManagedAgentsSessionThreadStatusRunningEvent](interfaces/ManagedAgentsSessionThreadStatusRunningEvent.md) +- [ManagedAgentsSessionThreadStatusTerminatedEvent](interfaces/ManagedAgentsSessionThreadStatusTerminatedEvent.md) +- [ManagedAgentsSessionThreadUsage](interfaces/ManagedAgentsSessionThreadUsage.md) +- [ManagedAgentsSessionUpdatedEvent](interfaces/ManagedAgentsSessionUpdatedEvent.md) +- [ManagedAgentsSessionUsage](interfaces/ManagedAgentsSessionUsage.md) +- [ManagedAgentsSessionUsageEvent](interfaces/ManagedAgentsSessionUsageEvent.md) +- [ManagedAgentsSessionUsageSnapshot](interfaces/ManagedAgentsSessionUsageSnapshot.md) +- [ManagedAgentsSkillNotFoundDeploymentPausedReasonError](interfaces/ManagedAgentsSkillNotFoundDeploymentPausedReasonError.md) +- [ManagedAgentsSkillNotFoundRunError](interfaces/ManagedAgentsSkillNotFoundRunError.md) +- [ManagedAgentsSpanModelRequestEndEvent](interfaces/ManagedAgentsSpanModelRequestEndEvent.md) +- [ManagedAgentsSpanModelRequestStartEvent](interfaces/ManagedAgentsSpanModelRequestStartEvent.md) +- [ManagedAgentsSpanModelUsage](interfaces/ManagedAgentsSpanModelUsage.md) +- [ManagedAgentsSpanOutcomeEvaluationEndEvent](interfaces/ManagedAgentsSpanOutcomeEvaluationEndEvent.md) +- [ManagedAgentsSpanOutcomeEvaluationOngoingEvent](interfaces/ManagedAgentsSpanOutcomeEvaluationOngoingEvent.md) +- [ManagedAgentsSpanOutcomeEvaluationStartEvent](interfaces/ManagedAgentsSpanOutcomeEvaluationStartEvent.md) +- [ManagedAgentsStartEvent](interfaces/ManagedAgentsStartEvent.md) +- [ManagedAgentsStaticBearerAuthResponse](interfaces/ManagedAgentsStaticBearerAuthResponse.md) +- [ManagedAgentsStaticBearerCreateParams](interfaces/ManagedAgentsStaticBearerCreateParams.md) +- [ManagedAgentsStaticBearerUpdateParams](interfaces/ManagedAgentsStaticBearerUpdateParams.md) +- [ManagedAgentsStreamSessionEventsUnionStopReason](interfaces/ManagedAgentsStreamSessionEventsUnionStopReason.md) +- [ManagedAgentsStreamSessionEventsUnionUsage](interfaces/ManagedAgentsStreamSessionEventsUnionUsage.md) +- [ManagedAgentsStreamSessionThreadEventsUnionStopReason](interfaces/ManagedAgentsStreamSessionThreadEventsUnionStopReason.md) +- [ManagedAgentsStreamSessionThreadEventsUnionUsage](interfaces/ManagedAgentsStreamSessionThreadEventsUnionUsage.md) +- [ManagedAgentsSystemContentBlock](interfaces/ManagedAgentsSystemContentBlock.md) +- [ManagedAgentsSystemContentBlockParam](interfaces/ManagedAgentsSystemContentBlockParam.md) +- [ManagedAgentsSystemMessageEvent](interfaces/ManagedAgentsSystemMessageEvent.md) +- [ManagedAgentsSystemMessageEventParams](interfaces/ManagedAgentsSystemMessageEventParams.md) +- [ManagedAgentsTextBlock](interfaces/ManagedAgentsTextBlock.md) +- [ManagedAgentsTextBlockParam](interfaces/ManagedAgentsTextBlockParam.md) +- [ManagedAgentsTextRubric](interfaces/ManagedAgentsTextRubric.md) +- [ManagedAgentsTextRubricParams](interfaces/ManagedAgentsTextRubricParams.md) +- [ManagedAgentsTokenEndpointAuthBasicParam](interfaces/ManagedAgentsTokenEndpointAuthBasicParam.md) +- [ManagedAgentsTokenEndpointAuthBasicResponse](interfaces/ManagedAgentsTokenEndpointAuthBasicResponse.md) +- [ManagedAgentsTokenEndpointAuthBasicUpdateParam](interfaces/ManagedAgentsTokenEndpointAuthBasicUpdateParam.md) +- [ManagedAgentsTokenEndpointAuthNoneParam](interfaces/ManagedAgentsTokenEndpointAuthNoneParam.md) +- [ManagedAgentsTokenEndpointAuthNoneResponse](interfaces/ManagedAgentsTokenEndpointAuthNoneResponse.md) +- [ManagedAgentsTokenEndpointAuthPostParam](interfaces/ManagedAgentsTokenEndpointAuthPostParam.md) +- [ManagedAgentsTokenEndpointAuthPostResponse](interfaces/ManagedAgentsTokenEndpointAuthPostResponse.md) +- [ManagedAgentsTokenEndpointAuthPostUpdateParam](interfaces/ManagedAgentsTokenEndpointAuthPostUpdateParam.md) +- [ManagedAgentsUnknownDeploymentPausedReasonError](interfaces/ManagedAgentsUnknownDeploymentPausedReasonError.md) +- [ManagedAgentsUnknownError](interfaces/ManagedAgentsUnknownError.md) +- [ManagedAgentsUnknownRunError](interfaces/ManagedAgentsUnknownRunError.md) +- [ManagedAgentsUnrestrictedCredentialNetworkingParams](interfaces/ManagedAgentsUnrestrictedCredentialNetworkingParams.md) +- [ManagedAgentsUnrestrictedCredentialNetworkingResponse](interfaces/ManagedAgentsUnrestrictedCredentialNetworkingResponse.md) +- [ManagedAgentsURLDocumentSource](interfaces/ManagedAgentsURLDocumentSource.md) +- [ManagedAgentsURLDocumentSourceParam](interfaces/ManagedAgentsURLDocumentSourceParam.md) +- [ManagedAgentsURLImageSource](interfaces/ManagedAgentsURLImageSource.md) +- [ManagedAgentsURLImageSourceParam](interfaces/ManagedAgentsURLImageSourceParam.md) +- [ManagedAgentsURLMCPServerParams](interfaces/ManagedAgentsURLMCPServerParams.md) +- [ManagedAgentsUserActor](interfaces/ManagedAgentsUserActor.md) +- [ManagedAgentsUserCustomToolResultEvent](interfaces/ManagedAgentsUserCustomToolResultEvent.md) +- [ManagedAgentsUserCustomToolResultEventParams](interfaces/ManagedAgentsUserCustomToolResultEventParams.md) +- [ManagedAgentsUserDefineOutcomeEvent](interfaces/ManagedAgentsUserDefineOutcomeEvent.md) +- [ManagedAgentsUserDefineOutcomeEventParams](interfaces/ManagedAgentsUserDefineOutcomeEventParams.md) +- [ManagedAgentsUserInterruptEvent](interfaces/ManagedAgentsUserInterruptEvent.md) +- [ManagedAgentsUserInterruptEventParams](interfaces/ManagedAgentsUserInterruptEventParams.md) +- [ManagedAgentsUserLocation](interfaces/ManagedAgentsUserLocation.md) +- [ManagedAgentsUserLocationParam](interfaces/ManagedAgentsUserLocationParam.md) +- [ManagedAgentsUserMessageEvent](interfaces/ManagedAgentsUserMessageEvent.md) +- [ManagedAgentsUserMessageEventContentUnionSource](interfaces/ManagedAgentsUserMessageEventContentUnionSource.md) +- [ManagedAgentsUserMessageEventParams](interfaces/ManagedAgentsUserMessageEventParams.md) +- [ManagedAgentsUserToolConfirmationEvent](interfaces/ManagedAgentsUserToolConfirmationEvent.md) +- [ManagedAgentsUserToolConfirmationEventParams](interfaces/ManagedAgentsUserToolConfirmationEventParams.md) +- [ManagedAgentsUserToolResultEvent](interfaces/ManagedAgentsUserToolResultEvent.md) +- [ManagedAgentsUserToolResultEventParams](interfaces/ManagedAgentsUserToolResultEventParams.md) +- [ManagedAgentsVault](interfaces/ManagedAgentsVault.md) +- [ManagedAgentsVaultArchivedDeploymentPausedReasonError](interfaces/ManagedAgentsVaultArchivedDeploymentPausedReasonError.md) +- [ManagedAgentsVaultArchivedRunError](interfaces/ManagedAgentsVaultArchivedRunError.md) +- [ManagedAgentsVaultNotFoundDeploymentPausedReasonError](interfaces/ManagedAgentsVaultNotFoundDeploymentPausedReasonError.md) +- [ManagedAgentsVaultNotFoundRunError](interfaces/ManagedAgentsVaultNotFoundRunError.md) +- [ManagedAgentsWebFetchToolConfig](interfaces/ManagedAgentsWebFetchToolConfig.md) +- [ManagedAgentsWebFetchToolConfigParams](interfaces/ManagedAgentsWebFetchToolConfigParams.md) +- [ManagedAgentsWebSearchToolConfig](interfaces/ManagedAgentsWebSearchToolConfig.md) +- [ManagedAgentsWebSearchToolConfigParams](interfaces/ManagedAgentsWebSearchToolConfigParams.md) +- [ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError](interfaces/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError.md) +- [ManagedAgentsWorkspaceArchivedRunError](interfaces/ManagedAgentsWorkspaceArchivedRunError.md) +- [ManagedAgentsWriteToolConfig](interfaces/ManagedAgentsWriteToolConfig.md) +- [ManagedAgentsWriteToolConfigParams](interfaces/ManagedAgentsWriteToolConfigParams.md) +- [MCPToolUseBlockParam](interfaces/MCPToolUseBlockParam.md) +- [MemoryStoreArchiveParams](interfaces/MemoryStoreArchiveParams.md) +- [MemoryStoreDeleteParams](interfaces/MemoryStoreDeleteParams.md) +- [MemoryStoreGetParams](interfaces/MemoryStoreGetParams.md) +- [MemoryStoreListParams](interfaces/MemoryStoreListParams.md) +- [MemoryStoreMemoryDeleteParams](interfaces/MemoryStoreMemoryDeleteParams.md) +- [MemoryStoreMemoryGetParams](interfaces/MemoryStoreMemoryGetParams.md) +- [MemoryStoreMemoryListParams](interfaces/MemoryStoreMemoryListParams.md) +- [MemoryStoreMemoryNewParams](interfaces/MemoryStoreMemoryNewParams.md) +- [MemoryStoreMemoryUpdateParams](interfaces/MemoryStoreMemoryUpdateParams.md) +- [MemoryStoreMemoryVersionGetParams](interfaces/MemoryStoreMemoryVersionGetParams.md) +- [MemoryStoreMemoryVersionListParams](interfaces/MemoryStoreMemoryVersionListParams.md) +- [MemoryStoreMemoryVersionRedactParams](interfaces/MemoryStoreMemoryVersionRedactParams.md) +- [MemoryStoreNewParams](interfaces/MemoryStoreNewParams.md) +- [MemoryStoreUpdateParams](interfaces/MemoryStoreUpdateParams.md) +- [ModelCapabilities](interfaces/ModelCapabilities.md) +- [ModelInfo](interfaces/ModelInfo.md) +- [ModelListParams](interfaces/ModelListParams.md) +- [MonetaryAmount](interfaces/MonetaryAmount.md) +- [MonetaryAmountParam](interfaces/MonetaryAmountParam.md) +- [OutputBehaviorCreateNew](interfaces/OutputBehaviorCreateNew.md) +- [OutputBehaviorCreateNewParam](interfaces/OutputBehaviorCreateNewParam.md) +- [OutputBehaviorUpdateExisting](interfaces/OutputBehaviorUpdateExisting.md) +- [OutputBehaviorUpdateExistingParam](interfaces/OutputBehaviorUpdateExistingParam.md) +- [Packages](interfaces/Packages.md) +- [PackagesParams](interfaces/PackagesParams.md) +- [PlainTextSourceParam](interfaces/PlainTextSourceParam.md) +- [RedactedThinkingBlockParam](interfaces/RedactedThinkingBlockParam.md) +- [RequestDocumentBlockParam](interfaces/RequestDocumentBlockParam.md) +- [RequestMCPToolResultBlockParam](interfaces/RequestMCPToolResultBlockParam.md) +- [RequestToolAdditionBlockParam](interfaces/RequestToolAdditionBlockParam.md) +- [RequestToolRemovalBlockParam](interfaces/RequestToolRemovalBlockParam.md) +- [SearchResultBlockParam](interfaces/SearchResultBlockParam.md) +- [SelfHostedConfig](interfaces/SelfHostedConfig.md) +- [SelfHostedConfigParams](interfaces/SelfHostedConfigParams.md) +- [SelfHostedWork](interfaces/SelfHostedWork.md) +- [SelfHostedWorkHeartbeatResponse](interfaces/SelfHostedWorkHeartbeatResponse.md) +- [SelfHostedWorkListResponse](interfaces/SelfHostedWorkListResponse.md) +- [SelfHostedWorkQueueStats](interfaces/SelfHostedWorkQueueStats.md) +- [SelfHostedWorkStopRequestParam](interfaces/SelfHostedWorkStopRequestParam.md) +- [SelfHostedWorkUpdateRequestParam](interfaces/SelfHostedWorkUpdateRequestParam.md) +- [ServerToolCaller20260120Param](interfaces/ServerToolCaller20260120Param.md) +- [ServerToolCallerParam](interfaces/ServerToolCallerParam.md) +- [ServerToolUseBlockParam](interfaces/ServerToolUseBlockParam.md) +- [SessionArchiveParams](interfaces/SessionArchiveParams.md) +- [SessionDeleteParams](interfaces/SessionDeleteParams.md) +- [SessionEventListParams](interfaces/SessionEventListParams.md) +- [SessionEventSendParams](interfaces/SessionEventSendParams.md) +- [SessionEventStreamParams](interfaces/SessionEventStreamParams.md) +- [SessionGetParams](interfaces/SessionGetParams.md) +- [SessionListParams](interfaces/SessionListParams.md) +- [SessionNewParams](interfaces/SessionNewParams.md) +- [SessionResourceAddParams](interfaces/SessionResourceAddParams.md) +- [SessionResourceDeleteParams](interfaces/SessionResourceDeleteParams.md) +- [SessionResourceGetParams](interfaces/SessionResourceGetParams.md) +- [SessionResourceListParams](interfaces/SessionResourceListParams.md) +- [SessionResourceUpdateParams](interfaces/SessionResourceUpdateParams.md) +- [SessionThreadArchiveParams](interfaces/SessionThreadArchiveParams.md) +- [SessionThreadEventListParams](interfaces/SessionThreadEventListParams.md) +- [SessionThreadEventStreamParams](interfaces/SessionThreadEventStreamParams.md) +- [SessionThreadGetParams](interfaces/SessionThreadGetParams.md) +- [SessionThreadListParams](interfaces/SessionThreadListParams.md) +- [SessionUpdateParams](interfaces/SessionUpdateParams.md) +- [SessionWorkData](interfaces/SessionWorkData.md) +- [Skill](interfaces/Skill.md) +- [SkillDeleteParams](interfaces/SkillDeleteParams.md) +- [SkillGetParams](interfaces/SkillGetParams.md) +- [SkillListParams](interfaces/SkillListParams.md) +- [SkillNewParams](interfaces/SkillNewParams.md) +- [SkillVersion](interfaces/SkillVersion.md) +- [SkillVersionDeleteParams](interfaces/SkillVersionDeleteParams.md) +- [SkillVersionDownloadParams](interfaces/SkillVersionDownloadParams.md) +- [SkillVersionGetParams](interfaces/SkillVersionGetParams.md) +- [SkillVersionListParams](interfaces/SkillVersionListParams.md) +- [SkillVersionNewParams](interfaces/SkillVersionNewParams.md) +- [TextBlockParam](interfaces/TextBlockParam.md) +- [TextEditorCodeExecutionCreateResultBlockParam](interfaces/TextEditorCodeExecutionCreateResultBlockParam.md) +- [TextEditorCodeExecutionStrReplaceResultBlockParam](interfaces/TextEditorCodeExecutionStrReplaceResultBlockParam.md) +- [TextEditorCodeExecutionToolResultBlockParam](interfaces/TextEditorCodeExecutionToolResultBlockParam.md) +- [TextEditorCodeExecutionToolResultErrorParam](interfaces/TextEditorCodeExecutionToolResultErrorParam.md) +- [TextEditorCodeExecutionViewResultBlockParam](interfaces/TextEditorCodeExecutionViewResultBlockParam.md) +- [ThinkingBlockParam](interfaces/ThinkingBlockParam.md) +- [ThinkingCapability](interfaces/ThinkingCapability.md) +- [ThinkingTypes](interfaces/ThinkingTypes.md) +- [ToolChangeMCPToolReferenceParam](interfaces/ToolChangeMCPToolReferenceParam.md) +- [ToolChangeMCPToolsetReferenceParam](interfaces/ToolChangeMCPToolsetReferenceParam.md) +- [ToolChangeToolReferenceParam](interfaces/ToolChangeToolReferenceParam.md) +- [ToolReferenceBlockParam](interfaces/ToolReferenceBlockParam.md) +- [ToolResultBlockParam](interfaces/ToolResultBlockParam.md) +- [ToolSearchToolResultBlockParam](interfaces/ToolSearchToolResultBlockParam.md) +- [ToolSearchToolResultErrorParam](interfaces/ToolSearchToolResultErrorParam.md) +- [ToolSearchToolSearchResultBlockParam](interfaces/ToolSearchToolSearchResultBlockParam.md) +- [ToolUseBlockParam](interfaces/ToolUseBlockParam.md) +- [UnrestrictedNetwork](interfaces/UnrestrictedNetwork.md) +- [UnrestrictedNetworkParam](interfaces/UnrestrictedNetworkParam.md) +- [URLImageSourceParam](interfaces/URLImageSourceParam.md) +- [URLPDFSourceParam](interfaces/URLPDFSourceParam.md) +- [VaultArchiveParams](interfaces/VaultArchiveParams.md) +- [VaultCredentialArchiveParams](interfaces/VaultCredentialArchiveParams.md) +- [VaultCredentialDeleteParams](interfaces/VaultCredentialDeleteParams.md) +- [VaultCredentialGetParams](interfaces/VaultCredentialGetParams.md) +- [VaultCredentialListParams](interfaces/VaultCredentialListParams.md) +- [VaultCredentialMCPOAuthValidateParams](interfaces/VaultCredentialMCPOAuthValidateParams.md) +- [VaultCredentialNewParams](interfaces/VaultCredentialNewParams.md) +- [VaultCredentialUpdateParams](interfaces/VaultCredentialUpdateParams.md) +- [VaultDeleteParams](interfaces/VaultDeleteParams.md) +- [VaultGetParams](interfaces/VaultGetParams.md) +- [VaultListParams](interfaces/VaultListParams.md) +- [VaultNewParams](interfaces/VaultNewParams.md) +- [WebFetchBlockParam](interfaces/WebFetchBlockParam.md) +- [WebFetchToolResultBlockParam](interfaces/WebFetchToolResultBlockParam.md) +- [WebFetchToolResultErrorBlockParam](interfaces/WebFetchToolResultErrorBlockParam.md) +- [WebSearchResultBlockParam](interfaces/WebSearchResultBlockParam.md) +- [WebSearchToolRequestErrorParam](interfaces/WebSearchToolRequestErrorParam.md) +- [WebSearchToolResultBlockParam](interfaces/WebSearchToolResultBlockParam.md) + +## Type Aliases + +- [AdvisorToolResultBlockParamContentUnion](type-aliases/AdvisorToolResultBlockParamContentUnion.md) +- [AdvisorToolResultErrorParamErrorCode](type-aliases/AdvisorToolResultErrorParamErrorCode.md) +- [AgentCreateParams](type-aliases/AgentCreateParams.md) +- [AgentNewParamsToolUnion](type-aliases/AgentNewParamsToolUnion.md) +- [AgentRetrieveParams](type-aliases/AgentRetrieveParams.md) +- [AgentUpdateParamsToolUnion](type-aliases/AgentUpdateParamsToolUnion.md) +- [Base64ImageSourceMediaType](type-aliases/Base64ImageSourceMediaType.md) +- [BashCodeExecutionToolResultBlockParamContentUnion](type-aliases/BashCodeExecutionToolResultBlockParamContentUnion.md) +- [BashCodeExecutionToolResultErrorParamErrorCode](type-aliases/BashCodeExecutionToolResultErrorParamErrorCode.md) +- [BrowserStateChangeUnionParam](type-aliases/BrowserStateChangeUnionParam.md) +- [CacheControlEphemeralTTL](type-aliases/CacheControlEphemeralTTL.md) +- [CloudConfigNetworkingUnion](type-aliases/CloudConfigNetworkingUnion.md) +- [CloudConfigParamsNetworkingUnion](type-aliases/CloudConfigParamsNetworkingUnion.md) +- [CodeExecutionToolResultBlockParamContentUnion](type-aliases/CodeExecutionToolResultBlockParamContentUnion.md) +- [CodeExecutionToolResultErrorCode](type-aliases/CodeExecutionToolResultErrorCode.md) +- [ContentBlockParamUnion](type-aliases/ContentBlockParamUnion.md) +- [ContentBlockSourceContentUnionParam](type-aliases/ContentBlockSourceContentUnionParam.md) +- [Currency](type-aliases/Currency.md) +- [DeletedFileType](type-aliases/DeletedFileType.md) +- [DeploymentCreateParams](type-aliases/DeploymentCreateParams.md) +- [DeploymentNewParamsAgentUnion](type-aliases/DeploymentNewParamsAgentUnion.md) +- [DeploymentNewParamsResourceUnion](type-aliases/DeploymentNewParamsResourceUnion.md) +- [DeploymentRetrieveParams](type-aliases/DeploymentRetrieveParams.md) +- [DeploymentRunRetrieveParams](type-aliases/DeploymentRunRetrieveParams.md) +- [DeploymentUpdateParamsAgentUnion](type-aliases/DeploymentUpdateParamsAgentUnion.md) +- [DeploymentUpdateParamsResourceUnion](type-aliases/DeploymentUpdateParamsResourceUnion.md) +- [DreamCreateParams](type-aliases/DreamCreateParams.md) +- [DreamInputUnion](type-aliases/DreamInputUnion.md) +- [DreamInputUnionParam](type-aliases/DreamInputUnionParam.md) +- [DreamMemoryStoreInputType](type-aliases/DreamMemoryStoreInputType.md) +- [DreamModelConfigParamSpeed](type-aliases/DreamModelConfigParamSpeed.md) +- [DreamModelConfigSpeed](type-aliases/DreamModelConfigSpeed.md) +- [DreamNewParamsModelUnion](type-aliases/DreamNewParamsModelUnion.md) +- [DreamOutputType](type-aliases/DreamOutputType.md) +- [DreamRetrieveParams](type-aliases/DreamRetrieveParams.md) +- [DreamSessionsInputType](type-aliases/DreamSessionsInputType.md) +- [DreamStatus](type-aliases/DreamStatus.md) +- [DreamType](type-aliases/DreamType.md) +- [EnvironmentConfigUnion](type-aliases/EnvironmentConfigUnion.md) +- [EnvironmentCreateParams](type-aliases/EnvironmentCreateParams.md) +- [EnvironmentDeleteResponseType](type-aliases/EnvironmentDeleteResponseType.md) +- [EnvironmentNewParamsConfigUnion](type-aliases/EnvironmentNewParamsConfigUnion.md) +- [EnvironmentNewParamsScope](type-aliases/EnvironmentNewParamsScope.md) +- [EnvironmentRetrieveParams](type-aliases/EnvironmentRetrieveParams.md) +- [EnvironmentScope](type-aliases/EnvironmentScope.md) +- [EnvironmentUpdateParamsConfigUnion](type-aliases/EnvironmentUpdateParamsConfigUnion.md) +- [EnvironmentUpdateParamsScope](type-aliases/EnvironmentUpdateParamsScope.md) +- [EnvironmentWorkRetrieveParams](type-aliases/EnvironmentWorkRetrieveParams.md) +- [HealthCheckWorkDataType](type-aliases/HealthCheckWorkDataType.md) +- [ImageBlockParamSourceUnion](type-aliases/ImageBlockParamSourceUnion.md) +- [ImageTransformationsParamOversizedImage](type-aliases/ImageTransformationsParamOversizedImage.md) +- [ManagedAgentsActorUnion](type-aliases/ManagedAgentsActorUnion.md) +- [ManagedAgentsAdvisorParamsType](type-aliases/ManagedAgentsAdvisorParamsType.md) +- [ManagedAgentsAdvisorType](type-aliases/ManagedAgentsAdvisorType.md) +- [ManagedAgentsAgentArchivedDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsAgentArchivedDeploymentPausedReasonErrorType.md) +- [ManagedAgentsAgentArchivedRunErrorType](type-aliases/ManagedAgentsAgentArchivedRunErrorType.md) +- [ManagedAgentsAgentCustomToolUseEventType](type-aliases/ManagedAgentsAgentCustomToolUseEventType.md) +- [ManagedAgentsAgentMCPToolResultEventContentUnion](type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnion.md) +- [ManagedAgentsAgentMCPToolResultEventContentUnionSource](type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnionSource.md) +- [ManagedAgentsAgentMCPToolResultEventType](type-aliases/ManagedAgentsAgentMCPToolResultEventType.md) +- [ManagedAgentsAgentMCPToolUseEventEvaluatedPermission](type-aliases/ManagedAgentsAgentMCPToolUseEventEvaluatedPermission.md) +- [ManagedAgentsAgentMCPToolUseEventType](type-aliases/ManagedAgentsAgentMCPToolUseEventType.md) +- [ManagedAgentsAgentMessageEventContentUnion](type-aliases/ManagedAgentsAgentMessageEventContentUnion.md) +- [ManagedAgentsAgentMessageEventType](type-aliases/ManagedAgentsAgentMessageEventType.md) +- [ManagedAgentsAgentMessagePreviewType](type-aliases/ManagedAgentsAgentMessagePreviewType.md) +- [ManagedAgentsAgentParamsType](type-aliases/ManagedAgentsAgentParamsType.md) +- [ManagedAgentsAgentReferenceType](type-aliases/ManagedAgentsAgentReferenceType.md) +- [ManagedAgentsAgentSkillUnion](type-aliases/ManagedAgentsAgentSkillUnion.md) +- [ManagedAgentsAgentThinkingEventType](type-aliases/ManagedAgentsAgentThinkingEventType.md) +- [ManagedAgentsAgentThinkingPreviewType](type-aliases/ManagedAgentsAgentThinkingPreviewType.md) +- [ManagedAgentsAgentThreadContextCompactedEventType](type-aliases/ManagedAgentsAgentThreadContextCompactedEventType.md) +- [ManagedAgentsAgentThreadMessageReceivedEventContentUnion](type-aliases/ManagedAgentsAgentThreadMessageReceivedEventContentUnion.md) +- [ManagedAgentsAgentThreadMessageReceivedEventType](type-aliases/ManagedAgentsAgentThreadMessageReceivedEventType.md) +- [ManagedAgentsAgentThreadMessageSentEventContentUnion](type-aliases/ManagedAgentsAgentThreadMessageSentEventContentUnion.md) +- [ManagedAgentsAgentThreadMessageSentEventType](type-aliases/ManagedAgentsAgentThreadMessageSentEventType.md) +- [ManagedAgentsAgentToolConfigParamsUnion](type-aliases/ManagedAgentsAgentToolConfigParamsUnion.md) +- [ManagedAgentsAgentToolConfigUnion](type-aliases/ManagedAgentsAgentToolConfigUnion.md) +- [ManagedAgentsAgentToolResultEventContentUnion](type-aliases/ManagedAgentsAgentToolResultEventContentUnion.md) +- [ManagedAgentsAgentToolResultEventContentUnionSource](type-aliases/ManagedAgentsAgentToolResultEventContentUnionSource.md) +- [ManagedAgentsAgentToolResultEventType](type-aliases/ManagedAgentsAgentToolResultEventType.md) +- [ManagedAgentsAgentToolset20260401ParamsType](type-aliases/ManagedAgentsAgentToolset20260401ParamsType.md) +- [ManagedAgentsAgentToolset20260401Type](type-aliases/ManagedAgentsAgentToolset20260401Type.md) +- [ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion](type-aliases/ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion.md) +- [ManagedAgentsAgentToolUnion](type-aliases/ManagedAgentsAgentToolUnion.md) +- [ManagedAgentsAgentToolUnionConfigs](type-aliases/ManagedAgentsAgentToolUnionConfigs.md) +- [ManagedAgentsAgentToolUseEventEvaluatedPermission](type-aliases/ManagedAgentsAgentToolUseEventEvaluatedPermission.md) +- [ManagedAgentsAgentToolUseEventType](type-aliases/ManagedAgentsAgentToolUseEventType.md) +- [ManagedAgentsAgentType](type-aliases/ManagedAgentsAgentType.md) +- [ManagedAgentsAgentWithOverridesParamsToolUnion](type-aliases/ManagedAgentsAgentWithOverridesParamsToolUnion.md) +- [ManagedAgentsAgentWithOverridesParamsType](type-aliases/ManagedAgentsAgentWithOverridesParamsType.md) +- [ManagedAgentsAlwaysAllowPolicyType](type-aliases/ManagedAgentsAlwaysAllowPolicyType.md) +- [ManagedAgentsAlwaysAskPolicyType](type-aliases/ManagedAgentsAlwaysAskPolicyType.md) +- [ManagedAgentsAPIActorType](type-aliases/ManagedAgentsAPIActorType.md) +- [ManagedAgentsBase64DocumentSourceType](type-aliases/ManagedAgentsBase64DocumentSourceType.md) +- [ManagedAgentsBase64ImageSourceType](type-aliases/ManagedAgentsBase64ImageSourceType.md) +- [ManagedAgentsBashToolConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsBashToolConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsBashToolConfigParamsType](type-aliases/ManagedAgentsBashToolConfigParamsType.md) +- [ManagedAgentsBashToolConfigPermissionPolicyUnion](type-aliases/ManagedAgentsBashToolConfigPermissionPolicyUnion.md) +- [ManagedAgentsBillingErrorRetryStatusUnion](type-aliases/ManagedAgentsBillingErrorRetryStatusUnion.md) +- [ManagedAgentsBillingErrorType](type-aliases/ManagedAgentsBillingErrorType.md) +- [ManagedAgentsBranchCheckoutType](type-aliases/ManagedAgentsBranchCheckoutType.md) +- [ManagedAgentsBudgetLimitType](type-aliases/ManagedAgentsBudgetLimitType.md) +- [ManagedAgentsCommitCheckoutType](type-aliases/ManagedAgentsCommitCheckoutType.md) +- [ManagedAgentsCredentialAuthUnion](type-aliases/ManagedAgentsCredentialAuthUnion.md) +- [ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion](type-aliases/ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion.md) +- [ManagedAgentsCredentialHostUnreachableErrorType](type-aliases/ManagedAgentsCredentialHostUnreachableErrorType.md) +- [ManagedAgentsCredentialNetworkingParamsUnion](type-aliases/ManagedAgentsCredentialNetworkingParamsUnion.md) +- [ManagedAgentsCredentialType](type-aliases/ManagedAgentsCredentialType.md) +- [ManagedAgentsCredentialValidationStatus](type-aliases/ManagedAgentsCredentialValidationStatus.md) +- [ManagedAgentsCredentialValidationType](type-aliases/ManagedAgentsCredentialValidationType.md) +- [ManagedAgentsCustomSkillParamsType](type-aliases/ManagedAgentsCustomSkillParamsType.md) +- [ManagedAgentsCustomSkillType](type-aliases/ManagedAgentsCustomSkillType.md) +- [ManagedAgentsCustomToolParamsType](type-aliases/ManagedAgentsCustomToolParamsType.md) +- [ManagedAgentsCustomToolType](type-aliases/ManagedAgentsCustomToolType.md) +- [ManagedAgentsDeletedCredentialType](type-aliases/ManagedAgentsDeletedCredentialType.md) +- [ManagedAgentsDeletedMemoryStoreType](type-aliases/ManagedAgentsDeletedMemoryStoreType.md) +- [ManagedAgentsDeletedMemoryType](type-aliases/ManagedAgentsDeletedMemoryType.md) +- [ManagedAgentsDeletedSessionType](type-aliases/ManagedAgentsDeletedSessionType.md) +- [ManagedAgentsDeletedVaultType](type-aliases/ManagedAgentsDeletedVaultType.md) +- [ManagedAgentsDeleteSessionResourceType](type-aliases/ManagedAgentsDeleteSessionResourceType.md) +- [ManagedAgentsDeltaContentType](type-aliases/ManagedAgentsDeltaContentType.md) +- [ManagedAgentsDeltaEventType](type-aliases/ManagedAgentsDeltaEventType.md) +- [ManagedAgentsDeltaType](type-aliases/ManagedAgentsDeltaType.md) +- [ManagedAgentsDeploymentInitialEventParamsUnion](type-aliases/ManagedAgentsDeploymentInitialEventParamsUnion.md) +- [ManagedAgentsDeploymentInitialEventUnion](type-aliases/ManagedAgentsDeploymentInitialEventUnion.md) +- [ManagedAgentsDeploymentInitialEventUnionContent](type-aliases/ManagedAgentsDeploymentInitialEventUnionContent.md) +- [ManagedAgentsDeploymentPausedReasonErrorUnion](type-aliases/ManagedAgentsDeploymentPausedReasonErrorUnion.md) +- [ManagedAgentsDeploymentPausedReasonUnion](type-aliases/ManagedAgentsDeploymentPausedReasonUnion.md) +- [ManagedAgentsDeploymentRunErrorUnion](type-aliases/ManagedAgentsDeploymentRunErrorUnion.md) +- [ManagedAgentsDeploymentRunType](type-aliases/ManagedAgentsDeploymentRunType.md) +- [ManagedAgentsDeploymentStatus](type-aliases/ManagedAgentsDeploymentStatus.md) +- [ManagedAgentsDeploymentSystemMessageEventType](type-aliases/ManagedAgentsDeploymentSystemMessageEventType.md) +- [ManagedAgentsDeploymentType](type-aliases/ManagedAgentsDeploymentType.md) +- [ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion](type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion.md) +- [ManagedAgentsDeploymentUserDefineOutcomeEventType](type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventType.md) +- [ManagedAgentsDeploymentUserMessageEventContentUnion](type-aliases/ManagedAgentsDeploymentUserMessageEventContentUnion.md) +- [ManagedAgentsDeploymentUserMessageEventType](type-aliases/ManagedAgentsDeploymentUserMessageEventType.md) +- [ManagedAgentsDocumentBlockSourceUnion](type-aliases/ManagedAgentsDocumentBlockSourceUnion.md) +- [ManagedAgentsDocumentBlockSourceUnionParam](type-aliases/ManagedAgentsDocumentBlockSourceUnionParam.md) +- [ManagedAgentsDocumentBlockType](type-aliases/ManagedAgentsDocumentBlockType.md) +- [ManagedAgentsEditToolConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsEditToolConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsEditToolConfigParamsType](type-aliases/ManagedAgentsEditToolConfigParamsType.md) +- [ManagedAgentsEditToolConfigPermissionPolicyUnion](type-aliases/ManagedAgentsEditToolConfigPermissionPolicyUnion.md) +- [ManagedAgentsEffortHighType](type-aliases/ManagedAgentsEffortHighType.md) +- [ManagedAgentsEffortLowType](type-aliases/ManagedAgentsEffortLowType.md) +- [ManagedAgentsEffortMaxType](type-aliases/ManagedAgentsEffortMaxType.md) +- [ManagedAgentsEffortMediumType](type-aliases/ManagedAgentsEffortMediumType.md) +- [ManagedAgentsEffortXhighType](type-aliases/ManagedAgentsEffortXhighType.md) +- [ManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorType.md) +- [ManagedAgentsEnvironmentArchivedRunErrorType](type-aliases/ManagedAgentsEnvironmentArchivedRunErrorType.md) +- [ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorType.md) +- [ManagedAgentsEnvironmentNotFoundRunErrorType](type-aliases/ManagedAgentsEnvironmentNotFoundRunErrorType.md) +- [ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion](type-aliases/ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion.md) +- [ManagedAgentsEnvironmentVariableAuthResponseType](type-aliases/ManagedAgentsEnvironmentVariableAuthResponseType.md) +- [ManagedAgentsEnvironmentVariableCreateParamsType](type-aliases/ManagedAgentsEnvironmentVariableCreateParamsType.md) +- [ManagedAgentsEnvironmentVariableUpdateParamsType](type-aliases/ManagedAgentsEnvironmentVariableUpdateParamsType.md) +- [ManagedAgentsErrorDeploymentPausedReasonType](type-aliases/ManagedAgentsErrorDeploymentPausedReasonType.md) +- [ManagedAgentsEventParamsUnion](type-aliases/ManagedAgentsEventParamsUnion.md) +- [ManagedAgentsFileDocumentSourceType](type-aliases/ManagedAgentsFileDocumentSourceType.md) +- [ManagedAgentsFileImageSourceType](type-aliases/ManagedAgentsFileImageSourceType.md) +- [ManagedAgentsFileNotFoundDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsFileNotFoundDeploymentPausedReasonErrorType.md) +- [ManagedAgentsFileNotFoundRunErrorType](type-aliases/ManagedAgentsFileNotFoundRunErrorType.md) +- [ManagedAgentsFileResourceConfigType](type-aliases/ManagedAgentsFileResourceConfigType.md) +- [ManagedAgentsFileResourceParamsType](type-aliases/ManagedAgentsFileResourceParamsType.md) +- [ManagedAgentsFileResourceType](type-aliases/ManagedAgentsFileResourceType.md) +- [ManagedAgentsFileRubricParamsType](type-aliases/ManagedAgentsFileRubricParamsType.md) +- [ManagedAgentsFileRubricType](type-aliases/ManagedAgentsFileRubricType.md) +- [ManagedAgentsGitHubRepositoryResourceCheckoutUnion](type-aliases/ManagedAgentsGitHubRepositoryResourceCheckoutUnion.md) +- [ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion](type-aliases/ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion.md) +- [ManagedAgentsGitHubRepositoryResourceConfigType](type-aliases/ManagedAgentsGitHubRepositoryResourceConfigType.md) +- [ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion](type-aliases/ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion.md) +- [ManagedAgentsGitHubRepositoryResourceParamsType](type-aliases/ManagedAgentsGitHubRepositoryResourceParamsType.md) +- [ManagedAgentsGitHubRepositoryResourceType](type-aliases/ManagedAgentsGitHubRepositoryResourceType.md) +- [ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsGlobToolConfigParamsType](type-aliases/ManagedAgentsGlobToolConfigParamsType.md) +- [ManagedAgentsGlobToolConfigPermissionPolicyUnion](type-aliases/ManagedAgentsGlobToolConfigPermissionPolicyUnion.md) +- [ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsGrepToolConfigParamsType](type-aliases/ManagedAgentsGrepToolConfigParamsType.md) +- [ManagedAgentsGrepToolConfigPermissionPolicyUnion](type-aliases/ManagedAgentsGrepToolConfigPermissionPolicyUnion.md) +- [ManagedAgentsImageBlockSourceUnion](type-aliases/ManagedAgentsImageBlockSourceUnion.md) +- [ManagedAgentsImageBlockSourceUnionParam](type-aliases/ManagedAgentsImageBlockSourceUnionParam.md) +- [ManagedAgentsImageBlockType](type-aliases/ManagedAgentsImageBlockType.md) +- [ManagedAgentsLimitedCredentialNetworkingParamsType](type-aliases/ManagedAgentsLimitedCredentialNetworkingParamsType.md) +- [ManagedAgentsLimitedCredentialNetworkingResponseType](type-aliases/ManagedAgentsLimitedCredentialNetworkingResponseType.md) +- [ManagedAgentsManualDeploymentPausedReasonType](type-aliases/ManagedAgentsManualDeploymentPausedReasonType.md) +- [ManagedAgentsManualTriggerContextType](type-aliases/ManagedAgentsManualTriggerContextType.md) +- [ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion](type-aliases/ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion.md) +- [ManagedAgentsMCPAuthenticationFailedErrorType](type-aliases/ManagedAgentsMCPAuthenticationFailedErrorType.md) +- [ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion](type-aliases/ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion.md) +- [ManagedAgentsMCPConnectionFailedErrorType](type-aliases/ManagedAgentsMCPConnectionFailedErrorType.md) +- [ManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorType.md) +- [ManagedAgentsMCPEgressBlockedRunErrorType](type-aliases/ManagedAgentsMCPEgressBlockedRunErrorType.md) +- [ManagedAgentsMCPOAuthAuthResponseType](type-aliases/ManagedAgentsMCPOAuthAuthResponseType.md) +- [ManagedAgentsMCPOAuthCreateParamsType](type-aliases/ManagedAgentsMCPOAuthCreateParamsType.md) +- [ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion](type-aliases/ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion.md) +- [ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion](type-aliases/ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion.md) +- [ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion](type-aliases/ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion.md) +- [ManagedAgentsMCPOAuthUpdateParamsType](type-aliases/ManagedAgentsMCPOAuthUpdateParamsType.md) +- [ManagedAgentsMCPServerURLDefinitionType](type-aliases/ManagedAgentsMCPServerURLDefinitionType.md) +- [ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsMCPToolConfigPermissionPolicyUnion](type-aliases/ManagedAgentsMCPToolConfigPermissionPolicyUnion.md) +- [ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion](type-aliases/ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion.md) +- [ManagedAgentsMCPToolsetParamsType](type-aliases/ManagedAgentsMCPToolsetParamsType.md) +- [ManagedAgentsMCPToolsetType](type-aliases/ManagedAgentsMCPToolsetType.md) +- [ManagedAgentsMemoryListItemUnion](type-aliases/ManagedAgentsMemoryListItemUnion.md) +- [ManagedAgentsMemoryPrefixType](type-aliases/ManagedAgentsMemoryPrefixType.md) +- [ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorType.md) +- [ManagedAgentsMemoryStoreArchivedRunErrorType](type-aliases/ManagedAgentsMemoryStoreArchivedRunErrorType.md) +- [ManagedAgentsMemoryStoreResourceAccess](type-aliases/ManagedAgentsMemoryStoreResourceAccess.md) +- [ManagedAgentsMemoryStoreResourceConfigAccess](type-aliases/ManagedAgentsMemoryStoreResourceConfigAccess.md) +- [ManagedAgentsMemoryStoreResourceConfigType](type-aliases/ManagedAgentsMemoryStoreResourceConfigType.md) +- [ManagedAgentsMemoryStoreResourceParamAccess](type-aliases/ManagedAgentsMemoryStoreResourceParamAccess.md) +- [ManagedAgentsMemoryStoreResourceParamType](type-aliases/ManagedAgentsMemoryStoreResourceParamType.md) +- [ManagedAgentsMemoryStoreResourceType](type-aliases/ManagedAgentsMemoryStoreResourceType.md) +- [ManagedAgentsMemoryStoreType](type-aliases/ManagedAgentsMemoryStoreType.md) +- [ManagedAgentsMemoryType](type-aliases/ManagedAgentsMemoryType.md) +- [ManagedAgentsMemoryVersionOperation](type-aliases/ManagedAgentsMemoryVersionOperation.md) +- [ManagedAgentsMemoryVersionType](type-aliases/ManagedAgentsMemoryVersionType.md) +- [ManagedAgentsMemoryView](type-aliases/ManagedAgentsMemoryView.md) +- [ManagedAgentsModel](type-aliases/ManagedAgentsModel.md) +- [ManagedAgentsModelConfig](type-aliases/ManagedAgentsModelConfig.md) +- [ManagedAgentsModelConfigEffortUnion](type-aliases/ManagedAgentsModelConfigEffortUnion.md) +- [ManagedAgentsModelConfigParams](type-aliases/ManagedAgentsModelConfigParams.md) +- [ManagedAgentsModelConfigParamsEffortManagedAgentsEffortLevel](type-aliases/ManagedAgentsModelConfigParamsEffortManagedAgentsEffortLevel.md) +- [ManagedAgentsModelConfigParamsEffortUnion](type-aliases/ManagedAgentsModelConfigParamsEffortUnion.md) +- [ManagedAgentsModelConfigParamsSpeed](type-aliases/ManagedAgentsModelConfigParamsSpeed.md) +- [ManagedAgentsModelConfigSpeed](type-aliases/ManagedAgentsModelConfigSpeed.md) +- [ManagedAgentsModelOverloadedErrorRetryStatusUnion](type-aliases/ManagedAgentsModelOverloadedErrorRetryStatusUnion.md) +- [ManagedAgentsModelOverloadedErrorType](type-aliases/ManagedAgentsModelOverloadedErrorType.md) +- [ManagedAgentsModelRateLimitedErrorRetryStatusUnion](type-aliases/ManagedAgentsModelRateLimitedErrorRetryStatusUnion.md) +- [ManagedAgentsModelRateLimitedErrorType](type-aliases/ManagedAgentsModelRateLimitedErrorType.md) +- [ManagedAgentsModelRequestFailedErrorRetryStatusUnion](type-aliases/ManagedAgentsModelRequestFailedErrorRetryStatusUnion.md) +- [ManagedAgentsModelRequestFailedErrorType](type-aliases/ManagedAgentsModelRequestFailedErrorType.md) +- [ManagedAgentsMultiagentAgentUnion](type-aliases/ManagedAgentsMultiagentAgentUnion.md) +- [ManagedAgentsMultiagentParamsType](type-aliases/ManagedAgentsMultiagentParamsType.md) +- [ManagedAgentsMultiagentRosterEntryParamsUnion](type-aliases/ManagedAgentsMultiagentRosterEntryParamsUnion.md) +- [ManagedAgentsMultiagentSelfParamsType](type-aliases/ManagedAgentsMultiagentSelfParamsType.md) +- [ManagedAgentsMultiagentType](type-aliases/ManagedAgentsMultiagentType.md) +- [ManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorType.md) +- [ManagedAgentsOrganizationDisabledRunErrorType](type-aliases/ManagedAgentsOrganizationDisabledRunErrorType.md) +- [ManagedAgentsOutcomeEvaluationResourceType](type-aliases/ManagedAgentsOutcomeEvaluationResourceType.md) +- [ManagedAgentsPlainTextDocumentSourceMediaType](type-aliases/ManagedAgentsPlainTextDocumentSourceMediaType.md) +- [ManagedAgentsPlainTextDocumentSourceType](type-aliases/ManagedAgentsPlainTextDocumentSourceType.md) +- [ManagedAgentsPreconditionType](type-aliases/ManagedAgentsPreconditionType.md) +- [ManagedAgentsQoderSkillParamsType](type-aliases/ManagedAgentsQoderSkillParamsType.md) +- [ManagedAgentsQoderSkillType](type-aliases/ManagedAgentsQoderSkillType.md) +- [ManagedAgentsReadToolConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsReadToolConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsReadToolConfigParamsType](type-aliases/ManagedAgentsReadToolConfigParamsType.md) +- [ManagedAgentsReadToolConfigPermissionPolicyUnion](type-aliases/ManagedAgentsReadToolConfigPermissionPolicyUnion.md) +- [ManagedAgentsRedactedBlockType](type-aliases/ManagedAgentsRedactedBlockType.md) +- [ManagedAgentsRefreshObjectStatus](type-aliases/ManagedAgentsRefreshObjectStatus.md) +- [ManagedAgentsRetryStatusExhaustedType](type-aliases/ManagedAgentsRetryStatusExhaustedType.md) +- [ManagedAgentsRetryStatusRetryingType](type-aliases/ManagedAgentsRetryStatusRetryingType.md) +- [ManagedAgentsRetryStatusTerminalType](type-aliases/ManagedAgentsRetryStatusTerminalType.md) +- [ManagedAgentsScheduleParamsType](type-aliases/ManagedAgentsScheduleParamsType.md) +- [ManagedAgentsScheduleTriggerContextType](type-aliases/ManagedAgentsScheduleTriggerContextType.md) +- [ManagedAgentsScheduleType](type-aliases/ManagedAgentsScheduleType.md) +- [ManagedAgentsSearchResultBlockType](type-aliases/ManagedAgentsSearchResultBlockType.md) +- [ManagedAgentsSearchResultContentType](type-aliases/ManagedAgentsSearchResultContentType.md) +- [ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorType.md) +- [ManagedAgentsSelfHostedResourcesUnsupportedRunErrorType](type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedRunErrorType.md) +- [ManagedAgentsSendSessionEventsDataUnion](type-aliases/ManagedAgentsSendSessionEventsDataUnion.md) +- [ManagedAgentsSendSessionEventsDataUnionContent](type-aliases/ManagedAgentsSendSessionEventsDataUnionContent.md) +- [ManagedAgentsSessionActorType](type-aliases/ManagedAgentsSessionActorType.md) +- [ManagedAgentsSessionAgentSkillUnion](type-aliases/ManagedAgentsSessionAgentSkillUnion.md) +- [ManagedAgentsSessionAgentToolUnion](type-aliases/ManagedAgentsSessionAgentToolUnion.md) +- [ManagedAgentsSessionAgentToolUnionConfigs](type-aliases/ManagedAgentsSessionAgentToolUnionConfigs.md) +- [ManagedAgentsSessionAgentType](type-aliases/ManagedAgentsSessionAgentType.md) +- [ManagedAgentsSessionAgentUpdateToolUnionParam](type-aliases/ManagedAgentsSessionAgentUpdateToolUnionParam.md) +- [ManagedAgentsSessionBudgetReachedType](type-aliases/ManagedAgentsSessionBudgetReachedType.md) +- [ManagedAgentsSessionCreationRejectedRunErrorType](type-aliases/ManagedAgentsSessionCreationRejectedRunErrorType.md) +- [ManagedAgentsSessionDeletedEventType](type-aliases/ManagedAgentsSessionDeletedEventType.md) +- [ManagedAgentsSessionEndTurnType](type-aliases/ManagedAgentsSessionEndTurnType.md) +- [ManagedAgentsSessionErrorEventErrorUnion](type-aliases/ManagedAgentsSessionErrorEventErrorUnion.md) +- [ManagedAgentsSessionErrorEventType](type-aliases/ManagedAgentsSessionErrorEventType.md) +- [ManagedAgentsSessionEventUnion](type-aliases/ManagedAgentsSessionEventUnion.md) +- [ManagedAgentsSessionEventUnionContent](type-aliases/ManagedAgentsSessionEventUnionContent.md) +- [ManagedAgentsSessionMultiagentCoordinatorAgentUnion](type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnion.md) +- [ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel](type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel.md) +- [ManagedAgentsSessionMultiagentCoordinatorType](type-aliases/ManagedAgentsSessionMultiagentCoordinatorType.md) +- [ManagedAgentsSessionRateLimitedRunErrorType](type-aliases/ManagedAgentsSessionRateLimitedRunErrorType.md) +- [ManagedAgentsSessionRequiresActionType](type-aliases/ManagedAgentsSessionRequiresActionType.md) +- [ManagedAgentsSessionResourceConfigUnion](type-aliases/ManagedAgentsSessionResourceConfigUnion.md) +- [ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorType.md) +- [ManagedAgentsSessionResourceNotFoundRunErrorType](type-aliases/ManagedAgentsSessionResourceNotFoundRunErrorType.md) +- [ManagedAgentsSessionResourceUnion](type-aliases/ManagedAgentsSessionResourceUnion.md) +- [ManagedAgentsSessionRetriesExhaustedType](type-aliases/ManagedAgentsSessionRetriesExhaustedType.md) +- [ManagedAgentsSessionStatus](type-aliases/ManagedAgentsSessionStatus.md) +- [ManagedAgentsSessionStatusIdleEventStopReasonUnion](type-aliases/ManagedAgentsSessionStatusIdleEventStopReasonUnion.md) +- [ManagedAgentsSessionStatusIdleEventType](type-aliases/ManagedAgentsSessionStatusIdleEventType.md) +- [ManagedAgentsSessionStatusRescheduledEventType](type-aliases/ManagedAgentsSessionStatusRescheduledEventType.md) +- [ManagedAgentsSessionStatusRunningEventType](type-aliases/ManagedAgentsSessionStatusRunningEventType.md) +- [ManagedAgentsSessionStatusTerminatedEventType](type-aliases/ManagedAgentsSessionStatusTerminatedEventType.md) +- [ManagedAgentsSessionThreadAgentSkillUnion](type-aliases/ManagedAgentsSessionThreadAgentSkillUnion.md) +- [ManagedAgentsSessionThreadAgentToolUnion](type-aliases/ManagedAgentsSessionThreadAgentToolUnion.md) +- [ManagedAgentsSessionThreadAgentToolUnionConfigs](type-aliases/ManagedAgentsSessionThreadAgentToolUnionConfigs.md) +- [ManagedAgentsSessionThreadAgentType](type-aliases/ManagedAgentsSessionThreadAgentType.md) +- [ManagedAgentsSessionThreadAgentUnion](type-aliases/ManagedAgentsSessionThreadAgentUnion.md) +- [ManagedAgentsSessionThreadAgentUnionModel](type-aliases/ManagedAgentsSessionThreadAgentUnionModel.md) +- [ManagedAgentsSessionThreadCreatedEventType](type-aliases/ManagedAgentsSessionThreadCreatedEventType.md) +- [ManagedAgentsSessionThreadStatus](type-aliases/ManagedAgentsSessionThreadStatus.md) +- [ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion](type-aliases/ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion.md) +- [ManagedAgentsSessionThreadStatusIdleEventType](type-aliases/ManagedAgentsSessionThreadStatusIdleEventType.md) +- [ManagedAgentsSessionThreadStatusRescheduledEventType](type-aliases/ManagedAgentsSessionThreadStatusRescheduledEventType.md) +- [ManagedAgentsSessionThreadStatusRunningEventType](type-aliases/ManagedAgentsSessionThreadStatusRunningEventType.md) +- [ManagedAgentsSessionThreadStatusTerminatedEventType](type-aliases/ManagedAgentsSessionThreadStatusTerminatedEventType.md) +- [ManagedAgentsSessionThreadType](type-aliases/ManagedAgentsSessionThreadType.md) +- [ManagedAgentsSessionType](type-aliases/ManagedAgentsSessionType.md) +- [ManagedAgentsSessionUpdatedEventType](type-aliases/ManagedAgentsSessionUpdatedEventType.md) +- [ManagedAgentsSessionUsageEventType](type-aliases/ManagedAgentsSessionUsageEventType.md) +- [ManagedAgentsSkillNotFoundDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsSkillNotFoundDeploymentPausedReasonErrorType.md) +- [ManagedAgentsSkillNotFoundRunErrorType](type-aliases/ManagedAgentsSkillNotFoundRunErrorType.md) +- [ManagedAgentsSkillParamsUnion](type-aliases/ManagedAgentsSkillParamsUnion.md) +- [ManagedAgentsSpanModelRequestEndEventType](type-aliases/ManagedAgentsSpanModelRequestEndEventType.md) +- [ManagedAgentsSpanModelRequestStartEventType](type-aliases/ManagedAgentsSpanModelRequestStartEventType.md) +- [ManagedAgentsSpanModelUsageSpeed](type-aliases/ManagedAgentsSpanModelUsageSpeed.md) +- [ManagedAgentsSpanOutcomeEvaluationEndEventType](type-aliases/ManagedAgentsSpanOutcomeEvaluationEndEventType.md) +- [ManagedAgentsSpanOutcomeEvaluationOngoingEventType](type-aliases/ManagedAgentsSpanOutcomeEvaluationOngoingEventType.md) +- [ManagedAgentsSpanOutcomeEvaluationStartEventType](type-aliases/ManagedAgentsSpanOutcomeEvaluationStartEventType.md) +- [ManagedAgentsStartEventPreviewUnion](type-aliases/ManagedAgentsStartEventPreviewUnion.md) +- [ManagedAgentsStartEventType](type-aliases/ManagedAgentsStartEventType.md) +- [ManagedAgentsStaticBearerAuthResponseType](type-aliases/ManagedAgentsStaticBearerAuthResponseType.md) +- [ManagedAgentsStaticBearerCreateParamsType](type-aliases/ManagedAgentsStaticBearerCreateParamsType.md) +- [ManagedAgentsStaticBearerUpdateParamsType](type-aliases/ManagedAgentsStaticBearerUpdateParamsType.md) +- [ManagedAgentsStreamSessionEventsUnion](type-aliases/ManagedAgentsStreamSessionEventsUnion.md) +- [ManagedAgentsStreamSessionEventsUnionContent](type-aliases/ManagedAgentsStreamSessionEventsUnionContent.md) +- [ManagedAgentsStreamSessionThreadEventsUnion](type-aliases/ManagedAgentsStreamSessionThreadEventsUnion.md) +- [ManagedAgentsStreamSessionThreadEventsUnionContent](type-aliases/ManagedAgentsStreamSessionThreadEventsUnionContent.md) +- [ManagedAgentsSystemContentBlockType](type-aliases/ManagedAgentsSystemContentBlockType.md) +- [ManagedAgentsSystemMessageEventParamsType](type-aliases/ManagedAgentsSystemMessageEventParamsType.md) +- [ManagedAgentsSystemMessageEventType](type-aliases/ManagedAgentsSystemMessageEventType.md) +- [ManagedAgentsTextBlockType](type-aliases/ManagedAgentsTextBlockType.md) +- [ManagedAgentsTextRubricParamsType](type-aliases/ManagedAgentsTextRubricParamsType.md) +- [ManagedAgentsTextRubricType](type-aliases/ManagedAgentsTextRubricType.md) +- [ManagedAgentsTokenEndpointAuthBasicParamType](type-aliases/ManagedAgentsTokenEndpointAuthBasicParamType.md) +- [ManagedAgentsTokenEndpointAuthBasicResponseType](type-aliases/ManagedAgentsTokenEndpointAuthBasicResponseType.md) +- [ManagedAgentsTokenEndpointAuthBasicUpdateParamType](type-aliases/ManagedAgentsTokenEndpointAuthBasicUpdateParamType.md) +- [ManagedAgentsTokenEndpointAuthNoneParamType](type-aliases/ManagedAgentsTokenEndpointAuthNoneParamType.md) +- [ManagedAgentsTokenEndpointAuthNoneResponseType](type-aliases/ManagedAgentsTokenEndpointAuthNoneResponseType.md) +- [ManagedAgentsTokenEndpointAuthPostParamType](type-aliases/ManagedAgentsTokenEndpointAuthPostParamType.md) +- [ManagedAgentsTokenEndpointAuthPostResponseType](type-aliases/ManagedAgentsTokenEndpointAuthPostResponseType.md) +- [ManagedAgentsTokenEndpointAuthPostUpdateParamType](type-aliases/ManagedAgentsTokenEndpointAuthPostUpdateParamType.md) +- [ManagedAgentsTriggerContextUnion](type-aliases/ManagedAgentsTriggerContextUnion.md) +- [ManagedAgentsTriggerType](type-aliases/ManagedAgentsTriggerType.md) +- [ManagedAgentsUnknownDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsUnknownDeploymentPausedReasonErrorType.md) +- [ManagedAgentsUnknownErrorRetryStatusUnion](type-aliases/ManagedAgentsUnknownErrorRetryStatusUnion.md) +- [ManagedAgentsUnknownErrorType](type-aliases/ManagedAgentsUnknownErrorType.md) +- [ManagedAgentsUnknownRunErrorType](type-aliases/ManagedAgentsUnknownRunErrorType.md) +- [ManagedAgentsUnrestrictedCredentialNetworkingParamsType](type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingParamsType.md) +- [ManagedAgentsUnrestrictedCredentialNetworkingResponseType](type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingResponseType.md) +- [ManagedAgentsURLDocumentSourceType](type-aliases/ManagedAgentsURLDocumentSourceType.md) +- [ManagedAgentsURLImageSourceType](type-aliases/ManagedAgentsURLImageSourceType.md) +- [ManagedAgentsURLMCPServerParamsType](type-aliases/ManagedAgentsURLMCPServerParamsType.md) +- [ManagedAgentsUserActorType](type-aliases/ManagedAgentsUserActorType.md) +- [ManagedAgentsUserCustomToolResultEventContentUnion](type-aliases/ManagedAgentsUserCustomToolResultEventContentUnion.md) +- [ManagedAgentsUserCustomToolResultEventContentUnionSource](type-aliases/ManagedAgentsUserCustomToolResultEventContentUnionSource.md) +- [ManagedAgentsUserCustomToolResultEventParamsContentUnion](type-aliases/ManagedAgentsUserCustomToolResultEventParamsContentUnion.md) +- [ManagedAgentsUserCustomToolResultEventParamsType](type-aliases/ManagedAgentsUserCustomToolResultEventParamsType.md) +- [ManagedAgentsUserCustomToolResultEventType](type-aliases/ManagedAgentsUserCustomToolResultEventType.md) +- [ManagedAgentsUserDefineOutcomeEventParamsRubricUnion](type-aliases/ManagedAgentsUserDefineOutcomeEventParamsRubricUnion.md) +- [ManagedAgentsUserDefineOutcomeEventParamsType](type-aliases/ManagedAgentsUserDefineOutcomeEventParamsType.md) +- [ManagedAgentsUserDefineOutcomeEventRubricUnion](type-aliases/ManagedAgentsUserDefineOutcomeEventRubricUnion.md) +- [ManagedAgentsUserDefineOutcomeEventType](type-aliases/ManagedAgentsUserDefineOutcomeEventType.md) +- [ManagedAgentsUserInterruptEventParamsType](type-aliases/ManagedAgentsUserInterruptEventParamsType.md) +- [ManagedAgentsUserInterruptEventType](type-aliases/ManagedAgentsUserInterruptEventType.md) +- [ManagedAgentsUserMessageEventContentUnion](type-aliases/ManagedAgentsUserMessageEventContentUnion.md) +- [ManagedAgentsUserMessageEventParamsContentUnion](type-aliases/ManagedAgentsUserMessageEventParamsContentUnion.md) +- [ManagedAgentsUserMessageEventParamsType](type-aliases/ManagedAgentsUserMessageEventParamsType.md) +- [ManagedAgentsUserMessageEventType](type-aliases/ManagedAgentsUserMessageEventType.md) +- [ManagedAgentsUserToolConfirmationEventParamsResult](type-aliases/ManagedAgentsUserToolConfirmationEventParamsResult.md) +- [ManagedAgentsUserToolConfirmationEventParamsType](type-aliases/ManagedAgentsUserToolConfirmationEventParamsType.md) +- [ManagedAgentsUserToolConfirmationEventResult](type-aliases/ManagedAgentsUserToolConfirmationEventResult.md) +- [ManagedAgentsUserToolConfirmationEventType](type-aliases/ManagedAgentsUserToolConfirmationEventType.md) +- [ManagedAgentsUserToolResultEventContentUnion](type-aliases/ManagedAgentsUserToolResultEventContentUnion.md) +- [ManagedAgentsUserToolResultEventContentUnionSource](type-aliases/ManagedAgentsUserToolResultEventContentUnionSource.md) +- [ManagedAgentsUserToolResultEventParamsContentUnion](type-aliases/ManagedAgentsUserToolResultEventParamsContentUnion.md) +- [ManagedAgentsUserToolResultEventParamsType](type-aliases/ManagedAgentsUserToolResultEventParamsType.md) +- [ManagedAgentsUserToolResultEventType](type-aliases/ManagedAgentsUserToolResultEventType.md) +- [ManagedAgentsVaultArchivedDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsVaultArchivedDeploymentPausedReasonErrorType.md) +- [ManagedAgentsVaultArchivedRunErrorType](type-aliases/ManagedAgentsVaultArchivedRunErrorType.md) +- [ManagedAgentsVaultNotFoundDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsVaultNotFoundDeploymentPausedReasonErrorType.md) +- [ManagedAgentsVaultNotFoundRunErrorType](type-aliases/ManagedAgentsVaultNotFoundRunErrorType.md) +- [ManagedAgentsVaultType](type-aliases/ManagedAgentsVaultType.md) +- [ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsWebFetchToolConfigParamsType](type-aliases/ManagedAgentsWebFetchToolConfigParamsType.md) +- [ManagedAgentsWebFetchToolConfigPermissionPolicyUnion](type-aliases/ManagedAgentsWebFetchToolConfigPermissionPolicyUnion.md) +- [ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsWebSearchToolConfigParamsType](type-aliases/ManagedAgentsWebSearchToolConfigParamsType.md) +- [ManagedAgentsWebSearchToolConfigPermissionPolicyUnion](type-aliases/ManagedAgentsWebSearchToolConfigPermissionPolicyUnion.md) +- [ManagedAgentsWorkspaceArchivedDeploymentPausedReasonErrorType](type-aliases/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonErrorType.md) +- [ManagedAgentsWorkspaceArchivedRunErrorType](type-aliases/ManagedAgentsWorkspaceArchivedRunErrorType.md) +- [ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion](type-aliases/ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion.md) +- [ManagedAgentsWriteToolConfigParamsType](type-aliases/ManagedAgentsWriteToolConfigParamsType.md) +- [ManagedAgentsWriteToolConfigPermissionPolicyUnion](type-aliases/ManagedAgentsWriteToolConfigPermissionPolicyUnion.md) +- [MemoryStoreCreateParams](type-aliases/MemoryStoreCreateParams.md) +- [MemoryStoreMemoryCreateParams](type-aliases/MemoryStoreMemoryCreateParams.md) +- [MemoryStoreMemoryRetrieveParams](type-aliases/MemoryStoreMemoryRetrieveParams.md) +- [MemoryStoreMemoryVersionRetrieveParams](type-aliases/MemoryStoreMemoryVersionRetrieveParams.md) +- [MemoryStoreRetrieveParams](type-aliases/MemoryStoreRetrieveParams.md) +- [Model](type-aliases/Model.md) +- [OutputBehaviorCreateNewType](type-aliases/OutputBehaviorCreateNewType.md) +- [OutputBehaviorUnion](type-aliases/OutputBehaviorUnion.md) +- [OutputBehaviorUnionParam](type-aliases/OutputBehaviorUnionParam.md) +- [OutputBehaviorUpdateExistingType](type-aliases/OutputBehaviorUpdateExistingType.md) +- [PackagesParamsType](type-aliases/PackagesParamsType.md) +- [PackagesType](type-aliases/PackagesType.md) +- [QoderBeta](type-aliases/QoderBeta.md) +- [RequestDocumentBlockSourceUnionParam](type-aliases/RequestDocumentBlockSourceUnionParam.md) +- [RequestMCPToolResultBlockParamContentUnion](type-aliases/RequestMCPToolResultBlockParamContentUnion.md) +- [RequestToolAdditionBlockToolUnionParam](type-aliases/RequestToolAdditionBlockToolUnionParam.md) +- [RequestToolRemovalBlockToolUnionParam](type-aliases/RequestToolRemovalBlockToolUnionParam.md) +- [SelfHostedWorkHeartbeatResponseState](type-aliases/SelfHostedWorkHeartbeatResponseState.md) +- [SelfHostedWorkState](type-aliases/SelfHostedWorkState.md) +- [ServerToolUseBlockParamCallerUnion](type-aliases/ServerToolUseBlockParamCallerUnion.md) +- [ServerToolUseBlockParamName](type-aliases/ServerToolUseBlockParamName.md) +- [SessionCreateParams](type-aliases/SessionCreateParams.md) +- [SessionEventListParamsOrder](type-aliases/SessionEventListParamsOrder.md) +- [SessionListParamsOrder](type-aliases/SessionListParamsOrder.md) +- [SessionNewParamsAgentUnion](type-aliases/SessionNewParamsAgentUnion.md) +- [SessionNewParamsInitialEventUnion](type-aliases/SessionNewParamsInitialEventUnion.md) +- [SessionNewParamsResourceUnion](type-aliases/SessionNewParamsResourceUnion.md) +- [SessionResourceGetResponseUnion](type-aliases/SessionResourceGetResponseUnion.md) +- [SessionResourceRetrieveParams](type-aliases/SessionResourceRetrieveParams.md) +- [SessionResourceUpdateResponseUnion](type-aliases/SessionResourceUpdateResponseUnion.md) +- [SessionRetrieveParams](type-aliases/SessionRetrieveParams.md) +- [SessionThreadRetrieveParams](type-aliases/SessionThreadRetrieveParams.md) +- [SkillCreateParams](type-aliases/SkillCreateParams.md) +- [SkillRetrieveParams](type-aliases/SkillRetrieveParams.md) +- [SkillSource](type-aliases/SkillSource.md) +- [SkillSourceType](type-aliases/SkillSourceType.md) +- [SkillVersionCreateParams](type-aliases/SkillVersionCreateParams.md) +- [SkillVersionRetrieveParams](type-aliases/SkillVersionRetrieveParams.md) +- [TextCitationParamUnion](type-aliases/TextCitationParamUnion.md) +- [TextEditorCodeExecutionToolResultBlockParamContentUnion](type-aliases/TextEditorCodeExecutionToolResultBlockParamContentUnion.md) +- [TextEditorCodeExecutionToolResultErrorParamErrorCode](type-aliases/TextEditorCodeExecutionToolResultErrorParamErrorCode.md) +- [TextEditorCodeExecutionViewResultBlockParamFileType](type-aliases/TextEditorCodeExecutionViewResultBlockParamFileType.md) +- [ToolResultBlockParamContentUnion](type-aliases/ToolResultBlockParamContentUnion.md) +- [ToolSearchToolResultBlockParamContentUnion](type-aliases/ToolSearchToolResultBlockParamContentUnion.md) +- [ToolSearchToolResultErrorParamErrorCode](type-aliases/ToolSearchToolResultErrorParamErrorCode.md) +- [ToolUseBlockParamCallerUnion](type-aliases/ToolUseBlockParamCallerUnion.md) +- [VaultCreateParams](type-aliases/VaultCreateParams.md) +- [VaultCredentialCreateParams](type-aliases/VaultCredentialCreateParams.md) +- [VaultCredentialNewParamsAuthUnion](type-aliases/VaultCredentialNewParamsAuthUnion.md) +- [VaultCredentialRetrieveParams](type-aliases/VaultCredentialRetrieveParams.md) +- [VaultCredentialUpdateParamsAuthUnion](type-aliases/VaultCredentialUpdateParamsAuthUnion.md) +- [VaultRetrieveParams](type-aliases/VaultRetrieveParams.md) +- [WebFetchToolResultBlockParamCallerUnion](type-aliases/WebFetchToolResultBlockParamCallerUnion.md) +- [WebFetchToolResultBlockParamContentUnion](type-aliases/WebFetchToolResultBlockParamContentUnion.md) +- [WebFetchToolResultErrorCode](type-aliases/WebFetchToolResultErrorCode.md) +- [WebSearchToolResultBlockParamCallerUnion](type-aliases/WebSearchToolResultBlockParamCallerUnion.md) +- [WebSearchToolResultBlockParamContentUnion](type-aliases/WebSearchToolResultBlockParamContentUnion.md) +- [WebSearchToolResultErrorCode](type-aliases/WebSearchToolResultErrorCode.md) + +## References + +### APIConnectionError + +Re-exports [APIConnectionError](../index/classes/APIConnectionError.md) + +*** + +### APIConnectionTimeoutError + +Re-exports [APIConnectionTimeoutError](../index/classes/APIConnectionTimeoutError.md) + +*** + +### APIError + +Re-exports [APIError](../index/classes/APIError.md) + +*** + +### APIPromise + +Re-exports [APIPromise](../index/classes/APIPromise.md) + +*** + +### APIUserAbortError + +Re-exports [APIUserAbortError](../index/classes/APIUserAbortError.md) + +*** + +### AuthenticationError + +Re-exports [AuthenticationError](../index/classes/AuthenticationError.md) + +*** + +### BadRequestError + +Re-exports [BadRequestError](../index/classes/BadRequestError.md) + +*** + +### ClientOptions + +Re-exports [ClientOptions](../index/interfaces/ClientOptions.md) + +*** + +### ConflictError + +Re-exports [ConflictError](../index/classes/ConflictError.md) + +*** + +### Credential + +Re-exports [Credential](../index/interfaces/Credential.md) + +*** + +### default + +Renames and re-exports [ManagedClient](../index/classes/ManagedClient.md) + +*** + +### InternalServerError + +Re-exports [InternalServerError](../index/classes/InternalServerError.md) + +*** + +### ManagedClient + +Re-exports [ManagedClient](../index/classes/ManagedClient.md) + +*** + +### ManagedClientOptions + +Renames and re-exports [ClientOptions](../index/interfaces/ClientOptions.md) + +*** + +### NotFoundError + +Re-exports [NotFoundError](../index/classes/NotFoundError.md) + +*** + +### Page + +Re-exports [Page](../index/classes/Page.md) + +*** + +### PagePromise + +Re-exports [PagePromise](../index/classes/PagePromise.md) + +*** + +### PATCredential + +Re-exports [PATCredential](../index/classes/PATCredential.md) + +*** + +### PermissionDeniedError + +Re-exports [PermissionDeniedError](../index/classes/PermissionDeniedError.md) + +*** + +### QoderError + +Re-exports [QoderError](../index/classes/QoderError.md) + +*** + +### RateLimitError + +Re-exports [RateLimitError](../index/classes/RateLimitError.md) + +*** + +### readEnv + +Re-exports [readEnv](../index/functions/readEnv.md) + +*** + +### RequestOptions + +Re-exports [RequestOptions](../index/interfaces/RequestOptions.md) + +*** + +### ResumableSessionEventStream + +Re-exports [ResumableSessionEventStream](../index/classes/ResumableSessionEventStream.md) + +*** + +### Stream + +Re-exports [Stream](../index/classes/Stream.md) + +*** + +### toFile + +Re-exports [toFile](../index/functions/toFile.md) + +*** + +### UnprocessableEntityError + +Re-exports [UnprocessableEntityError](../index/classes/UnprocessableEntityError.md) + +*** + +### Uploadable + +Re-exports [Uploadable](../index/type-aliases/Uploadable.md) diff --git a/docs/api/managed/classes/Agents.md b/docs/api/managed/classes/Agents.md new file mode 100644 index 0000000..f1c3038 --- /dev/null +++ b/docs/api/managed/classes/Agents.md @@ -0,0 +1,169 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Agents + +# Class: Agents + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Agents**(`_client`): `Agents` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Agents` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### versions + +> `readonly` **versions**: [`AgentsVersions`](AgentsVersions.md) + +## Methods + +### archive() + +> **archive**(`agentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +Archive Agent + +#### Parameters + +##### agentID + +`string` + +##### params? + +[`AgentArchiveParams`](../interfaces/AgentArchiveParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +Create Agent + +#### Parameters + +##### params + +[`AgentNewParams`](../interfaces/AgentNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +List Agents + +#### Parameters + +##### params? + +[`AgentListParams`](../interfaces/AgentListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +*** + +### retrieve() + +> **retrieve**(`agentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +Get Agent + +#### Parameters + +##### agentID + +`string` + +##### params? + +[`AgentGetParams`](../interfaces/AgentGetParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +*** + +### update() + +> **update**(`agentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +Update Agent + +#### Parameters + +##### agentID + +`string` + +##### params? + +[`AgentUpdateParams`](../interfaces/AgentUpdateParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> diff --git a/docs/api/managed/classes/AgentsVersions.md b/docs/api/managed/classes/AgentsVersions.md new file mode 100644 index 0000000..f5a0b5e --- /dev/null +++ b/docs/api/managed/classes/AgentsVersions.md @@ -0,0 +1,67 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentsVersions + +# Class: AgentsVersions + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new AgentsVersions**(`_client`): `AgentsVersions` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`AgentsVersions` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`agentID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> + +List Agent Versions + +#### Parameters + +##### agentID + +`string` + +##### params? + +[`AgentVersionListParams`](../interfaces/AgentVersionListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsAgent`](../interfaces/ManagedAgentsAgent.md)\> diff --git a/docs/api/managed/classes/DeploymentRuns.md b/docs/api/managed/classes/DeploymentRuns.md new file mode 100644 index 0000000..670d9ac --- /dev/null +++ b/docs/api/managed/classes/DeploymentRuns.md @@ -0,0 +1,89 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentRuns + +# Class: DeploymentRuns + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new DeploymentRuns**(`_client`): `DeploymentRuns` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`DeploymentRuns` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsDeploymentRun`](../interfaces/ManagedAgentsDeploymentRun.md)\> + +List Deployment Runs + +#### Parameters + +##### params? + +[`DeploymentRunListParams`](../interfaces/DeploymentRunListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsDeploymentRun`](../interfaces/ManagedAgentsDeploymentRun.md)\> + +*** + +### retrieve() + +> **retrieve**(`deploymentRunID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeploymentRun`](../interfaces/ManagedAgentsDeploymentRun.md)\> + +Get Deployment Run + +#### Parameters + +##### deploymentRunID + +`string` + +##### params? + +[`DeploymentRunGetParams`](../interfaces/DeploymentRunGetParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeploymentRun`](../interfaces/ManagedAgentsDeploymentRun.md)\> diff --git a/docs/api/managed/classes/Deployments.md b/docs/api/managed/classes/Deployments.md new file mode 100644 index 0000000..f78aa67 --- /dev/null +++ b/docs/api/managed/classes/Deployments.md @@ -0,0 +1,241 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Deployments + +# Class: Deployments + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Deployments**(`_client`): `Deployments` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Deployments` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### archive() + +> **archive**(`deploymentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +Archive Deployment + +#### Parameters + +##### deploymentID + +`string` + +##### params? + +[`DeploymentArchiveParams`](../interfaces/DeploymentArchiveParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +Create Deployment + +#### Parameters + +##### params + +[`DeploymentNewParams`](../interfaces/DeploymentNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +List Deployments + +#### Parameters + +##### params? + +[`DeploymentListParams`](../interfaces/DeploymentListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +*** + +### pause() + +> **pause**(`deploymentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +Pause Deployment + +#### Parameters + +##### deploymentID + +`string` + +##### params? + +[`DeploymentPauseParams`](../interfaces/DeploymentPauseParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +*** + +### retrieve() + +> **retrieve**(`deploymentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +Get Deployment + +#### Parameters + +##### deploymentID + +`string` + +##### params? + +[`DeploymentGetParams`](../interfaces/DeploymentGetParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +*** + +### run() + +> **run**(`deploymentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeploymentRun`](../interfaces/ManagedAgentsDeploymentRun.md)\> + +Run Deployment Now + +#### Parameters + +##### deploymentID + +`string` + +##### params? + +[`DeploymentRunParams`](../interfaces/DeploymentRunParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeploymentRun`](../interfaces/ManagedAgentsDeploymentRun.md)\> + +*** + +### unpause() + +> **unpause**(`deploymentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +Unpause Deployment + +#### Parameters + +##### deploymentID + +`string` + +##### params? + +[`DeploymentUnpauseParams`](../interfaces/DeploymentUnpauseParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +*** + +### update() + +> **update**(`deploymentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> + +Update Deployment + +#### Parameters + +##### deploymentID + +`string` + +##### params? + +[`DeploymentUpdateParams`](../interfaces/DeploymentUpdateParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeployment`](../interfaces/ManagedAgentsDeployment.md)\> diff --git a/docs/api/managed/classes/Dreams.md b/docs/api/managed/classes/Dreams.md new file mode 100644 index 0000000..11e8448 --- /dev/null +++ b/docs/api/managed/classes/Dreams.md @@ -0,0 +1,163 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Dreams + +# Class: Dreams + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Dreams**(`_client`): `Dreams` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Dreams` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### archive() + +> **archive**(`dreamID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Dream`](../interfaces/Dream.md)\> + +Archive a Dream + +#### Parameters + +##### dreamID + +`string` + +##### params? + +[`DreamArchiveParams`](../interfaces/DreamArchiveParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Dream`](../interfaces/Dream.md)\> + +*** + +### cancel() + +> **cancel**(`dreamID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Dream`](../interfaces/Dream.md)\> + +Cancel a Dream + +#### Parameters + +##### dreamID + +`string` + +##### params? + +[`DreamCancelParams`](../interfaces/DreamCancelParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Dream`](../interfaces/Dream.md)\> + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Dream`](../interfaces/Dream.md)\> + +Create a Dream + +#### Parameters + +##### params + +[`DreamNewParams`](../interfaces/DreamNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Dream`](../interfaces/Dream.md)\> + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Dream`](../interfaces/Dream.md)\> + +List Dreams + +#### Parameters + +##### params? + +[`DreamListParams`](../interfaces/DreamListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Dream`](../interfaces/Dream.md)\> + +*** + +### retrieve() + +> **retrieve**(`dreamID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Dream`](../interfaces/Dream.md)\> + +Get a Dream + +#### Parameters + +##### dreamID + +`string` + +##### params? + +[`DreamGetParams`](../interfaces/DreamGetParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Dream`](../interfaces/Dream.md)\> diff --git a/docs/api/managed/classes/Environments.md b/docs/api/managed/classes/Environments.md new file mode 100644 index 0000000..de7f133 --- /dev/null +++ b/docs/api/managed/classes/Environments.md @@ -0,0 +1,196 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Environments + +# Class: Environments + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Environments**(`_client`): `Environments` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Environments` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### work + +> `readonly` **work**: [`EnvironmentsWork`](EnvironmentsWork.md) + +## Methods + +### archive() + +> **archive**(`environmentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +Archive an environment by ID. Archived environments cannot be used to create new +sessions. + +#### Parameters + +##### environmentID + +`string` + +##### params? + +[`EnvironmentArchiveParams`](../interfaces/EnvironmentArchiveParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +Create a new environment with the specified configuration. + +#### Parameters + +##### params + +[`EnvironmentNewParams`](../interfaces/EnvironmentNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +*** + +### delete() + +> **delete**(`environmentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`EnvironmentDeleteResponse`](../interfaces/EnvironmentDeleteResponse.md)\> + +Delete an environment by ID. Returns a confirmation of the deletion. + +#### Parameters + +##### environmentID + +`string` + +##### params? + +[`EnvironmentDeleteParams`](../interfaces/EnvironmentDeleteParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`EnvironmentDeleteResponse`](../interfaces/EnvironmentDeleteResponse.md)\> + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +List environments with pagination support. + +#### Parameters + +##### params? + +[`EnvironmentListParams`](../interfaces/EnvironmentListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +*** + +### retrieve() + +> **retrieve**(`environmentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +Retrieve a specific environment by ID. + +#### Parameters + +##### environmentID + +`string` + +##### params? + +[`EnvironmentGetParams`](../interfaces/EnvironmentGetParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +*** + +### update() + +> **update**(`environmentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> + +Update an existing environment's configuration. + +#### Parameters + +##### environmentID + +`string` + +##### params? + +[`EnvironmentUpdateParams`](../interfaces/EnvironmentUpdateParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Environment`](../interfaces/Environment.md)\> diff --git a/docs/api/managed/classes/EnvironmentsWork.md b/docs/api/managed/classes/EnvironmentsWork.md new file mode 100644 index 0000000..f172c9b --- /dev/null +++ b/docs/api/managed/classes/EnvironmentsWork.md @@ -0,0 +1,285 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentsWork + +# Class: EnvironmentsWork + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new EnvironmentsWork**(`_client`): `EnvironmentsWork` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`EnvironmentsWork` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### ack() + +> **ack**(`workID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +Note: these endpoints are called automatically by the pre-built environment +worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted +sandbox environments. They are included here as a reference; you do not need to +invoke them directly. + +Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' +and removing it from the queue. + +#### Parameters + +##### workID + +`string` + +##### params + +[`EnvironmentWorkAckParams`](../interfaces/EnvironmentWorkAckParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +*** + +### heartbeat() + +> **heartbeat**(`workID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWorkHeartbeatResponse`](../interfaces/SelfHostedWorkHeartbeatResponse.md)\> + +Note: these endpoints are called automatically by the pre-built environment +worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted +sandbox environments. They are included here as a reference; you do not need to +invoke them directly. + +Record a heartbeat for a work item to maintain the lease. + +#### Parameters + +##### workID + +`string` + +##### params + +[`EnvironmentWorkHeartbeatParams`](../interfaces/EnvironmentWorkHeartbeatParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWorkHeartbeatResponse`](../interfaces/SelfHostedWorkHeartbeatResponse.md)\> + +*** + +### list() + +> **list**(`environmentID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +Note: these endpoints are called automatically by the pre-built environment +worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted +sandbox environments. They are included here as a reference; you do not need to +invoke them directly. + +List work items in an environment. + +#### Parameters + +##### environmentID + +`string` + +##### params? + +[`EnvironmentWorkListParams`](../interfaces/EnvironmentWorkListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +*** + +### poll() + +> **poll**(`environmentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +Note: these endpoints are called automatically by the pre-built environment +worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted +sandbox environments. They are included here as a reference; you do not need to +invoke them directly. + +Long poll for work items in the queue. + +#### Parameters + +##### environmentID + +`string` + +##### params? + +[`EnvironmentWorkPollParams`](../interfaces/EnvironmentWorkPollParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +*** + +### retrieve() + +> **retrieve**(`workID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +Note: these endpoints are called automatically by the pre-built environment +worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted +sandbox environments. They are included here as a reference; you do not need to +invoke them directly. + +Retrieve detailed information about a specific work item. + +#### Parameters + +##### workID + +`string` + +##### params + +[`EnvironmentWorkGetParams`](../interfaces/EnvironmentWorkGetParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +*** + +### stats() + +> **stats**(`environmentID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWorkQueueStats`](../interfaces/SelfHostedWorkQueueStats.md)\> + +Get statistics about the work queue for an environment. + +#### Parameters + +##### environmentID + +`string` + +##### params? + +[`EnvironmentWorkStatsParams`](../interfaces/EnvironmentWorkStatsParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWorkQueueStats`](../interfaces/SelfHostedWorkQueueStats.md)\> + +*** + +### stop() + +> **stop**(`workID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +Note: these endpoints are called automatically by the pre-built environment +worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted +sandbox environments. They are included here as a reference; you do not need to +invoke them directly. + +Stop a work item, initiating graceful or forced shutdown. + +#### Parameters + +##### workID + +`string` + +##### params + +[`EnvironmentWorkStopParams`](../interfaces/EnvironmentWorkStopParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +*** + +### update() + +> **update**(`workID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> + +Note: these endpoints are called automatically by the pre-built environment +worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted +sandbox environments. They are included here as a reference; you do not need to +invoke them directly. + +Update work item metadata with merge semantics. + +#### Parameters + +##### workID + +`string` + +##### params + +[`EnvironmentWorkUpdateParams`](../interfaces/EnvironmentWorkUpdateParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SelfHostedWork`](../interfaces/SelfHostedWork.md)\> diff --git a/docs/api/managed/classes/Files.md b/docs/api/managed/classes/Files.md new file mode 100644 index 0000000..68266df --- /dev/null +++ b/docs/api/managed/classes/Files.md @@ -0,0 +1,163 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Files + +# Class: Files + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Files**(`_client`): `Files` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Files` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### delete() + +> **delete**(`fileID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedFile`](../interfaces/DeletedFile.md)\> + +Delete File + +#### Parameters + +##### fileID + +`string` + +##### params? + +[`FileDeleteParams`](../interfaces/FileDeleteParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedFile`](../interfaces/DeletedFile.md)\> + +*** + +### download() + +> **download**(`fileID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<`Response`\> + +Download File + +#### Parameters + +##### fileID + +`string` + +##### params? + +[`FileDownloadParams`](../interfaces/FileDownloadParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<`Response`\> + +*** + +### getMetadata() + +> **getMetadata**(`fileID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +Get File Metadata + +#### Parameters + +##### fileID + +`string` + +##### params? + +[`FileGetMetadataParams`](../interfaces/FileGetMetadataParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +List Files + +#### Parameters + +##### params? + +[`FileListParams`](../interfaces/FileListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +*** + +### upload() + +> **upload**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> + +Upload File + +#### Parameters + +##### params + +[`FileUploadParams`](../interfaces/FileUploadParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`FileMetadata`](../interfaces/FileMetadata.md)\> diff --git a/docs/api/managed/classes/MemoryStores.md b/docs/api/managed/classes/MemoryStores.md new file mode 100644 index 0000000..9cd1f6d --- /dev/null +++ b/docs/api/managed/classes/MemoryStores.md @@ -0,0 +1,201 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStores + +# Class: MemoryStores + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new MemoryStores**(`_client`): `MemoryStores` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`MemoryStores` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### memories + +> `readonly` **memories**: [`MemoryStoresMemories`](MemoryStoresMemories.md) + +*** + +### memoryVersions + +> `readonly` **memoryVersions**: [`MemoryStoresMemoryVersions`](MemoryStoresMemoryVersions.md) + +## Methods + +### archive() + +> **archive**(`memoryStoreID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> + +Archive a memory store + +#### Parameters + +##### memoryStoreID + +`string` + +##### params? + +[`MemoryStoreArchiveParams`](../interfaces/MemoryStoreArchiveParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> + +Create a memory store + +#### Parameters + +##### params + +[`MemoryStoreNewParams`](../interfaces/MemoryStoreNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> + +*** + +### delete() + +> **delete**(`memoryStoreID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedMemoryStore`](../interfaces/ManagedAgentsDeletedMemoryStore.md)\> + +Delete a memory store + +#### Parameters + +##### memoryStoreID + +`string` + +##### params? + +[`MemoryStoreDeleteParams`](../interfaces/MemoryStoreDeleteParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedMemoryStore`](../interfaces/ManagedAgentsDeletedMemoryStore.md)\> + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> + +List memory stores + +#### Parameters + +##### params? + +[`MemoryStoreListParams`](../interfaces/MemoryStoreListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> + +*** + +### retrieve() + +> **retrieve**(`memoryStoreID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> + +Retrieve a memory store + +#### Parameters + +##### memoryStoreID + +`string` + +##### params? + +[`MemoryStoreGetParams`](../interfaces/MemoryStoreGetParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> + +*** + +### update() + +> **update**(`memoryStoreID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> + +Update a memory store + +#### Parameters + +##### memoryStoreID + +`string` + +##### params? + +[`MemoryStoreUpdateParams`](../interfaces/MemoryStoreUpdateParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryStore`](../interfaces/ManagedAgentsMemoryStore.md)\> diff --git a/docs/api/managed/classes/MemoryStoresMemories.md b/docs/api/managed/classes/MemoryStoresMemories.md new file mode 100644 index 0000000..0f5e915 --- /dev/null +++ b/docs/api/managed/classes/MemoryStoresMemories.md @@ -0,0 +1,171 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoresMemories + +# Class: MemoryStoresMemories + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new MemoryStoresMemories**(`_client`): `MemoryStoresMemories` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`MemoryStoresMemories` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### create() + +> **create**(`memoryStoreID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemory`](../interfaces/ManagedAgentsMemory.md)\> + +Create a memory + +#### Parameters + +##### memoryStoreID + +`string` + +##### params + +[`MemoryStoreMemoryNewParams`](../interfaces/MemoryStoreMemoryNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemory`](../interfaces/ManagedAgentsMemory.md)\> + +*** + +### delete() + +> **delete**(`memoryID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedMemory`](../interfaces/ManagedAgentsDeletedMemory.md)\> + +Delete a memory + +#### Parameters + +##### memoryID + +`string` + +##### params + +[`MemoryStoreMemoryDeleteParams`](../interfaces/MemoryStoreMemoryDeleteParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedMemory`](../interfaces/ManagedAgentsDeletedMemory.md)\> + +*** + +### list() + +> **list**(`memoryStoreID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsMemoryListItemUnion`](../type-aliases/ManagedAgentsMemoryListItemUnion.md)\> + +List memories + +#### Parameters + +##### memoryStoreID + +`string` + +##### params? + +[`MemoryStoreMemoryListParams`](../interfaces/MemoryStoreMemoryListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsMemoryListItemUnion`](../type-aliases/ManagedAgentsMemoryListItemUnion.md)\> + +*** + +### retrieve() + +> **retrieve**(`memoryID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemory`](../interfaces/ManagedAgentsMemory.md)\> + +Retrieve a memory + +#### Parameters + +##### memoryID + +`string` + +##### params + +[`MemoryStoreMemoryGetParams`](../interfaces/MemoryStoreMemoryGetParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemory`](../interfaces/ManagedAgentsMemory.md)\> + +*** + +### update() + +> **update**(`memoryID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemory`](../interfaces/ManagedAgentsMemory.md)\> + +Update a memory + +#### Parameters + +##### memoryID + +`string` + +##### params + +[`MemoryStoreMemoryUpdateParams`](../interfaces/MemoryStoreMemoryUpdateParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemory`](../interfaces/ManagedAgentsMemory.md)\> diff --git a/docs/api/managed/classes/MemoryStoresMemoryVersions.md b/docs/api/managed/classes/MemoryStoresMemoryVersions.md new file mode 100644 index 0000000..c37516e --- /dev/null +++ b/docs/api/managed/classes/MemoryStoresMemoryVersions.md @@ -0,0 +1,119 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoresMemoryVersions + +# Class: MemoryStoresMemoryVersions + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new MemoryStoresMemoryVersions**(`_client`): `MemoryStoresMemoryVersions` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`MemoryStoresMemoryVersions` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`memoryStoreID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsMemoryVersion`](../interfaces/ManagedAgentsMemoryVersion.md)\> + +List memory versions + +#### Parameters + +##### memoryStoreID + +`string` + +##### params? + +[`MemoryStoreMemoryVersionListParams`](../interfaces/MemoryStoreMemoryVersionListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsMemoryVersion`](../interfaces/ManagedAgentsMemoryVersion.md)\> + +*** + +### redact() + +> **redact**(`memoryVersionID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryVersion`](../interfaces/ManagedAgentsMemoryVersion.md)\> + +Redact a memory version + +#### Parameters + +##### memoryVersionID + +`string` + +##### params + +[`MemoryStoreMemoryVersionRedactParams`](../interfaces/MemoryStoreMemoryVersionRedactParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryVersion`](../interfaces/ManagedAgentsMemoryVersion.md)\> + +*** + +### retrieve() + +> **retrieve**(`memoryVersionID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryVersion`](../interfaces/ManagedAgentsMemoryVersion.md)\> + +Retrieve a memory version + +#### Parameters + +##### memoryVersionID + +`string` + +##### params + +[`MemoryStoreMemoryVersionGetParams`](../interfaces/MemoryStoreMemoryVersionGetParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsMemoryVersion`](../interfaces/ManagedAgentsMemoryVersion.md)\> diff --git a/docs/api/managed/classes/Models.md b/docs/api/managed/classes/Models.md new file mode 100644 index 0000000..60b4c23 --- /dev/null +++ b/docs/api/managed/classes/Models.md @@ -0,0 +1,66 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Models + +# Class: Models + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Models**(`_client`): `Models` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Models` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ModelInfo`](../interfaces/ModelInfo.md)\> + +List available models. + +The Models API response can be used to determine which models are available for +use in the API. More recently released models are listed first. + +#### Parameters + +##### params? + +[`ModelListParams`](../interfaces/ModelListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ModelInfo`](../interfaces/ModelInfo.md)\> diff --git a/docs/api/managed/classes/Sessions.md b/docs/api/managed/classes/Sessions.md new file mode 100644 index 0000000..10431b5 --- /dev/null +++ b/docs/api/managed/classes/Sessions.md @@ -0,0 +1,207 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Sessions + +# Class: Sessions + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Sessions**(`_client`): `Sessions` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Sessions` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### events + +> `readonly` **events**: [`SessionsEvents`](SessionsEvents.md) + +*** + +### resources + +> `readonly` **resources**: [`SessionsResources`](SessionsResources.md) + +*** + +### threads + +> `readonly` **threads**: [`SessionsThreads`](SessionsThreads.md) + +## Methods + +### archive() + +> **archive**(`sessionID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> + +Archive Session + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionArchiveParams`](../interfaces/SessionArchiveParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> + +Create Session + +#### Parameters + +##### params + +[`SessionNewParams`](../interfaces/SessionNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> + +*** + +### delete() + +> **delete**(`sessionID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedSession`](../interfaces/ManagedAgentsDeletedSession.md)\> + +Delete Session + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionDeleteParams`](../interfaces/SessionDeleteParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedSession`](../interfaces/ManagedAgentsDeletedSession.md)\> + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> + +List Sessions + +#### Parameters + +##### params? + +[`SessionListParams`](../interfaces/SessionListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> + +*** + +### retrieve() + +> **retrieve**(`sessionID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> + +Get Session + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionGetParams`](../interfaces/SessionGetParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> + +*** + +### update() + +> **update**(`sessionID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> + +Update Session + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionUpdateParams`](../interfaces/SessionUpdateParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSession`](../interfaces/ManagedAgentsSession.md)\> diff --git a/docs/api/managed/classes/SessionsEvents.md b/docs/api/managed/classes/SessionsEvents.md new file mode 100644 index 0000000..186a7ea --- /dev/null +++ b/docs/api/managed/classes/SessionsEvents.md @@ -0,0 +1,145 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionsEvents + +# Class: SessionsEvents + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SessionsEvents**(`_client`): `SessionsEvents` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SessionsEvents` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`sessionID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSessionEventUnion`](../type-aliases/ManagedAgentsSessionEventUnion.md)\> + +List Events + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionEventListParams`](../interfaces/SessionEventListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSessionEventUnion`](../type-aliases/ManagedAgentsSessionEventUnion.md)\> + +*** + +### resumableStream() + +> **resumableStream**(`sessionID`, `params?`, `options?`): [`ResumableSessionEventStream`](../../index/classes/ResumableSessionEventStream.md)\<[`ManagedAgentsStreamSessionEventsUnion`](../type-aliases/ManagedAgentsStreamSessionEventsUnion.md)\> + +Subscribe to Session Events and reconnect from the latest delivered SSE frame. + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionEventStreamParams`](../interfaces/SessionEventStreamParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`ResumableSessionEventStream`](../../index/classes/ResumableSessionEventStream.md)\<[`ManagedAgentsStreamSessionEventsUnion`](../type-aliases/ManagedAgentsStreamSessionEventsUnion.md)\> + +*** + +### send() + +> **send**(`sessionID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSendSessionEvents`](../interfaces/ManagedAgentsSendSessionEvents.md)\> + +Send Events + +#### Parameters + +##### sessionID + +`string` + +##### params + +[`SessionEventSendParams`](../interfaces/SessionEventSendParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSendSessionEvents`](../interfaces/ManagedAgentsSendSessionEvents.md)\> + +*** + +### streamEvents() + +> **streamEvents**(`sessionID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Stream`](../../index/classes/Stream.md)\<[`ManagedAgentsStreamSessionEventsUnion`](../type-aliases/ManagedAgentsStreamSessionEventsUnion.md)\>\> + +Stream Events + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionEventStreamParams`](../interfaces/SessionEventStreamParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Stream`](../../index/classes/Stream.md)\<[`ManagedAgentsStreamSessionEventsUnion`](../type-aliases/ManagedAgentsStreamSessionEventsUnion.md)\>\> diff --git a/docs/api/managed/classes/SessionsResources.md b/docs/api/managed/classes/SessionsResources.md new file mode 100644 index 0000000..77b7214 --- /dev/null +++ b/docs/api/managed/classes/SessionsResources.md @@ -0,0 +1,171 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionsResources + +# Class: SessionsResources + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SessionsResources**(`_client`): `SessionsResources` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SessionsResources` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### add() + +> **add**(`sessionID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsFileResource`](../interfaces/ManagedAgentsFileResource.md)\> + +Add Session Resource + +#### Parameters + +##### sessionID + +`string` + +##### params + +[`SessionResourceAddParams`](../interfaces/SessionResourceAddParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsFileResource`](../interfaces/ManagedAgentsFileResource.md)\> + +*** + +### delete() + +> **delete**(`resourceID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeleteSessionResource`](../interfaces/ManagedAgentsDeleteSessionResource.md)\> + +Delete Session Resource + +#### Parameters + +##### resourceID + +`string` + +##### params + +[`SessionResourceDeleteParams`](../interfaces/SessionResourceDeleteParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeleteSessionResource`](../interfaces/ManagedAgentsDeleteSessionResource.md)\> + +*** + +### list() + +> **list**(`sessionID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSessionResourceUnion`](../type-aliases/ManagedAgentsSessionResourceUnion.md)\> + +List Session Resources + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionResourceListParams`](../interfaces/SessionResourceListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSessionResourceUnion`](../type-aliases/ManagedAgentsSessionResourceUnion.md)\> + +*** + +### retrieve() + +> **retrieve**(`resourceID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionResourceGetResponseUnion`](../type-aliases/SessionResourceGetResponseUnion.md)\> + +Get Session Resource + +#### Parameters + +##### resourceID + +`string` + +##### params + +[`SessionResourceGetParams`](../interfaces/SessionResourceGetParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionResourceGetResponseUnion`](../type-aliases/SessionResourceGetResponseUnion.md)\> + +*** + +### update() + +> **update**(`resourceID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionResourceUpdateResponseUnion`](../type-aliases/SessionResourceUpdateResponseUnion.md)\> + +Update Session Resource + +#### Parameters + +##### resourceID + +`string` + +##### params + +[`SessionResourceUpdateParams`](../interfaces/SessionResourceUpdateParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SessionResourceUpdateResponseUnion`](../type-aliases/SessionResourceUpdateResponseUnion.md)\> diff --git a/docs/api/managed/classes/SessionsThreads.md b/docs/api/managed/classes/SessionsThreads.md new file mode 100644 index 0000000..32b9812 --- /dev/null +++ b/docs/api/managed/classes/SessionsThreads.md @@ -0,0 +1,125 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionsThreads + +# Class: SessionsThreads + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SessionsThreads**(`_client`): `SessionsThreads` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SessionsThreads` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### events + +> `readonly` **events**: [`SessionsThreadsEvents`](SessionsThreadsEvents.md) + +## Methods + +### archive() + +> **archive**(`threadID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSessionThread`](../interfaces/ManagedAgentsSessionThread.md)\> + +Archive Session Thread + +#### Parameters + +##### threadID + +`string` + +##### params + +[`SessionThreadArchiveParams`](../interfaces/SessionThreadArchiveParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSessionThread`](../interfaces/ManagedAgentsSessionThread.md)\> + +*** + +### list() + +> **list**(`sessionID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSessionThread`](../interfaces/ManagedAgentsSessionThread.md)\> + +List Session Threads + +#### Parameters + +##### sessionID + +`string` + +##### params? + +[`SessionThreadListParams`](../interfaces/SessionThreadListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSessionThread`](../interfaces/ManagedAgentsSessionThread.md)\> + +*** + +### retrieve() + +> **retrieve**(`threadID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSessionThread`](../interfaces/ManagedAgentsSessionThread.md)\> + +Get Session Thread + +#### Parameters + +##### threadID + +`string` + +##### params + +[`SessionThreadGetParams`](../interfaces/SessionThreadGetParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsSessionThread`](../interfaces/ManagedAgentsSessionThread.md)\> diff --git a/docs/api/managed/classes/SessionsThreadsEvents.md b/docs/api/managed/classes/SessionsThreadsEvents.md new file mode 100644 index 0000000..5dd9a3e --- /dev/null +++ b/docs/api/managed/classes/SessionsThreadsEvents.md @@ -0,0 +1,93 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionsThreadsEvents + +# Class: SessionsThreadsEvents + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SessionsThreadsEvents**(`_client`): `SessionsThreadsEvents` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SessionsThreadsEvents` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### list() + +> **list**(`threadID`, `params`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSessionEventUnion`](../type-aliases/ManagedAgentsSessionEventUnion.md)\> + +List Session Thread Events + +#### Parameters + +##### threadID + +`string` + +##### params + +[`SessionThreadEventListParams`](../interfaces/SessionThreadEventListParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsSessionEventUnion`](../type-aliases/ManagedAgentsSessionEventUnion.md)\> + +*** + +### streamEvents() + +> **streamEvents**(`threadID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Stream`](../../index/classes/Stream.md)\<[`ManagedAgentsStreamSessionThreadEventsUnion`](../type-aliases/ManagedAgentsStreamSessionThreadEventsUnion.md)\>\> + +Stream Session Thread Events + +#### Parameters + +##### threadID + +`string` + +##### params + +[`SessionThreadEventStreamParams`](../interfaces/SessionThreadEventStreamParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Stream`](../../index/classes/Stream.md)\<[`ManagedAgentsStreamSessionThreadEventsUnion`](../type-aliases/ManagedAgentsStreamSessionThreadEventsUnion.md)\>\> diff --git a/docs/api/managed/classes/Skills.md b/docs/api/managed/classes/Skills.md new file mode 100644 index 0000000..a3af7a1 --- /dev/null +++ b/docs/api/managed/classes/Skills.md @@ -0,0 +1,143 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Skills + +# Class: Skills + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Skills**(`_client`): `Skills` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Skills` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### versions + +> `readonly` **versions**: [`SkillsVersions`](SkillsVersions.md) + +## Methods + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +Create Skill + +#### Parameters + +##### params + +[`SkillNewParams`](../interfaces/SkillNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +*** + +### delete() + +> **delete**(`skillID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedSkill`](../interfaces/DeletedSkill.md)\> + +Delete Skill + +#### Parameters + +##### skillID + +`string` + +##### params? + +[`SkillDeleteParams`](../interfaces/SkillDeleteParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedSkill`](../interfaces/DeletedSkill.md)\> + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +List Skills + +#### Parameters + +##### params? + +[`SkillListParams`](../interfaces/SkillListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +*** + +### retrieve() + +> **retrieve**(`skillID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> + +Get Skill + +#### Parameters + +##### skillID + +`string` + +##### params? + +[`SkillGetParams`](../interfaces/SkillGetParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`Skill`](../interfaces/Skill.md)\> diff --git a/docs/api/managed/classes/SkillsVersions.md b/docs/api/managed/classes/SkillsVersions.md new file mode 100644 index 0000000..d9c97d2 --- /dev/null +++ b/docs/api/managed/classes/SkillsVersions.md @@ -0,0 +1,171 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillsVersions + +# Class: SkillsVersions + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new SkillsVersions**(`_client`): `SkillsVersions` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`SkillsVersions` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### create() + +> **create**(`skillID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +Create Skill Version + +#### Parameters + +##### skillID + +`string` + +##### params + +[`SkillVersionNewParams`](../interfaces/SkillVersionNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +*** + +### delete() + +> **delete**(`version`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedSkillVersion`](../interfaces/DeletedSkillVersion.md)\> + +Delete Skill Version + +#### Parameters + +##### version + +`string` + +##### params + +[`SkillVersionDeleteParams`](../interfaces/SkillVersionDeleteParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`DeletedSkillVersion`](../interfaces/DeletedSkillVersion.md)\> + +*** + +### download() + +> **download**(`version`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<`Response`\> + +Download a skill version's content as a zip archive. + +#### Parameters + +##### version + +`string` + +##### params + +[`SkillVersionDownloadParams`](../interfaces/SkillVersionDownloadParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<`Response`\> + +*** + +### list() + +> **list**(`skillID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +List Skill Versions + +#### Parameters + +##### skillID + +`string` + +##### params? + +[`SkillVersionListParams`](../interfaces/SkillVersionListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +*** + +### retrieve() + +> **retrieve**(`version`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> + +Get Skill Version + +#### Parameters + +##### version + +`string` + +##### params + +[`SkillVersionGetParams`](../interfaces/SkillVersionGetParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`SkillVersion`](../interfaces/SkillVersion.md)\> diff --git a/docs/api/managed/classes/Vaults.md b/docs/api/managed/classes/Vaults.md new file mode 100644 index 0000000..6f98fc8 --- /dev/null +++ b/docs/api/managed/classes/Vaults.md @@ -0,0 +1,169 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Vaults + +# Class: Vaults + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new Vaults**(`_client`): `Vaults` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`Vaults` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +*** + +### credentials + +> `readonly` **credentials**: [`VaultsCredentials`](VaultsCredentials.md) + +## Methods + +### archive() + +> **archive**(`vaultID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsVault`](../interfaces/ManagedAgentsVault.md)\> + +Archive Vault + +#### Parameters + +##### vaultID + +`string` + +##### params? + +[`VaultArchiveParams`](../interfaces/VaultArchiveParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsVault`](../interfaces/ManagedAgentsVault.md)\> + +*** + +### create() + +> **create**(`params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsVault`](../interfaces/ManagedAgentsVault.md)\> + +Create Vault + +#### Parameters + +##### params + +[`VaultNewParams`](../interfaces/VaultNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsVault`](../interfaces/ManagedAgentsVault.md)\> + +*** + +### delete() + +> **delete**(`vaultID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedVault`](../interfaces/ManagedAgentsDeletedVault.md)\> + +Delete Vault + +#### Parameters + +##### vaultID + +`string` + +##### params? + +[`VaultDeleteParams`](../interfaces/VaultDeleteParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedVault`](../interfaces/ManagedAgentsDeletedVault.md)\> + +*** + +### list() + +> **list**(`params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsVault`](../interfaces/ManagedAgentsVault.md)\> + +List Vaults + +#### Parameters + +##### params? + +[`VaultListParams`](../interfaces/VaultListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsVault`](../interfaces/ManagedAgentsVault.md)\> + +*** + +### retrieve() + +> **retrieve**(`vaultID`, `params?`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsVault`](../interfaces/ManagedAgentsVault.md)\> + +Get Vault + +#### Parameters + +##### vaultID + +`string` + +##### params? + +[`VaultGetParams`](../interfaces/VaultGetParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsVault`](../interfaces/ManagedAgentsVault.md)\> diff --git a/docs/api/managed/classes/VaultsCredentials.md b/docs/api/managed/classes/VaultsCredentials.md new file mode 100644 index 0000000..c358ac1 --- /dev/null +++ b/docs/api/managed/classes/VaultsCredentials.md @@ -0,0 +1,223 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultsCredentials + +# Class: VaultsCredentials + +## Extends + +- `APIResource` + +## Constructors + +### Constructor + +> **new VaultsCredentials**(`_client`): `VaultsCredentials` + +#### Parameters + +##### \_client + +[`APIClient`](../../index/classes/APIClient.md) + +#### Returns + +`VaultsCredentials` + +#### Inherited from + +`APIResource.constructor` + +## Properties + +### \_client + +> `protected` `readonly` **\_client**: [`APIClient`](../../index/classes/APIClient.md) + +#### Inherited from + +`APIResource._client` + +## Methods + +### archive() + +> **archive**(`credentialID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> + +Archive Credential + +#### Parameters + +##### credentialID + +`string` + +##### params + +[`VaultCredentialArchiveParams`](../interfaces/VaultCredentialArchiveParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> + +*** + +### create() + +> **create**(`vaultID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> + +Create Credential + +#### Parameters + +##### vaultID + +`string` + +##### params + +[`VaultCredentialNewParams`](../interfaces/VaultCredentialNewParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> + +*** + +### delete() + +> **delete**(`credentialID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedCredential`](../interfaces/ManagedAgentsDeletedCredential.md)\> + +Delete Credential + +#### Parameters + +##### credentialID + +`string` + +##### params + +[`VaultCredentialDeleteParams`](../interfaces/VaultCredentialDeleteParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsDeletedCredential`](../interfaces/ManagedAgentsDeletedCredential.md)\> + +*** + +### list() + +> **list**(`vaultID`, `params?`, `options?`): [`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> + +List Credentials + +#### Parameters + +##### vaultID + +`string` + +##### params? + +[`VaultCredentialListParams`](../interfaces/VaultCredentialListParams.md) \| `null` \| `undefined` + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`PagePromise`](../../index/classes/PagePromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> + +*** + +### mcpOAuthValidate() + +> **mcpOAuthValidate**(`credentialID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredentialValidation`](../interfaces/ManagedAgentsCredentialValidation.md)\> + +Validate Credential + +#### Parameters + +##### credentialID + +`string` + +##### params + +[`VaultCredentialMCPOAuthValidateParams`](../interfaces/VaultCredentialMCPOAuthValidateParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredentialValidation`](../interfaces/ManagedAgentsCredentialValidation.md)\> + +*** + +### retrieve() + +> **retrieve**(`credentialID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> + +Get Credential + +#### Parameters + +##### credentialID + +`string` + +##### params + +[`VaultCredentialGetParams`](../interfaces/VaultCredentialGetParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> + +*** + +### update() + +> **update**(`credentialID`, `params`, `options?`): [`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> + +Update Credential + +#### Parameters + +##### credentialID + +`string` + +##### params + +[`VaultCredentialUpdateParams`](../interfaces/VaultCredentialUpdateParams.md) + +##### options? + +[`RequestOptions`](../../index/interfaces/RequestOptions.md) + +#### Returns + +[`APIPromise`](../../index/classes/APIPromise.md)\<[`ManagedAgentsCredential`](../interfaces/ManagedAgentsCredential.md)\> diff --git a/docs/api/managed/interfaces/AdvisorRedactedResultBlockParam.md b/docs/api/managed/interfaces/AdvisorRedactedResultBlockParam.md new file mode 100644 index 0000000..5625f78 --- /dev/null +++ b/docs/api/managed/interfaces/AdvisorRedactedResultBlockParam.md @@ -0,0 +1,32 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AdvisorRedactedResultBlockParam + +# Interface: AdvisorRedactedResultBlockParam + +The properties EncryptedContent, Type are required. + +## Properties + +### encrypted\_content + +> **encrypted\_content**: `string` + +Opaque blob produced by a prior response; must be round-tripped verbatim. + +*** + +### stop\_reason? + +> `optional` **stop\_reason?**: `string` \| `null` + +*** + +### type? + +> `optional` **type?**: `"advisor_redacted_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"advisor_redacted_result". diff --git a/docs/api/managed/interfaces/AdvisorResultBlockParam.md b/docs/api/managed/interfaces/AdvisorResultBlockParam.md new file mode 100644 index 0000000..0d59857 --- /dev/null +++ b/docs/api/managed/interfaces/AdvisorResultBlockParam.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AdvisorResultBlockParam + +# Interface: AdvisorResultBlockParam + +The properties Text, Type are required. + +## Properties + +### stop\_reason? + +> `optional` **stop\_reason?**: `string` \| `null` + +*** + +### text + +> **text**: `string` + +*** + +### type? + +> `optional` **type?**: `"advisor_result"` \| `null` + +This field can be elided, and will marshal its zero value as "advisor_result". diff --git a/docs/api/managed/interfaces/AdvisorToolResultBlockParam.md b/docs/api/managed/interfaces/AdvisorToolResultBlockParam.md new file mode 100644 index 0000000..930a462 --- /dev/null +++ b/docs/api/managed/interfaces/AdvisorToolResultBlockParam.md @@ -0,0 +1,38 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AdvisorToolResultBlockParam + +# Interface: AdvisorToolResultBlockParam + +The properties Content, ToolUseID, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### content + +> **content**: [`AdvisorToolResultBlockParamContentUnion`](../type-aliases/AdvisorToolResultBlockParamContentUnion.md) + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"advisor_tool_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"advisor_tool_result". diff --git a/docs/api/managed/interfaces/AdvisorToolResultErrorParam.md b/docs/api/managed/interfaces/AdvisorToolResultErrorParam.md new file mode 100644 index 0000000..9afc254 --- /dev/null +++ b/docs/api/managed/interfaces/AdvisorToolResultErrorParam.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AdvisorToolResultErrorParam + +# Interface: AdvisorToolResultErrorParam + +The properties ErrorCode, Type are required. + +## Properties + +### error\_code + +> **error\_code**: `string` + +Any of "max_uses_exceeded", "prompt_too_long", "too_many_requests", +"overloaded", "unavailable", "execution_time_exceeded", "model_not_found". + +*** + +### type? + +> `optional` **type?**: `"advisor_tool_result_error"` \| `null` + +This field can be elided, and will marshal its zero value as +"advisor_tool_result_error". diff --git a/docs/api/managed/interfaces/AgentArchiveParams.md b/docs/api/managed/interfaces/AgentArchiveParams.md new file mode 100644 index 0000000..2240505 --- /dev/null +++ b/docs/api/managed/interfaces/AgentArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentArchiveParams + +# Interface: AgentArchiveParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/AgentGetParams.md b/docs/api/managed/interfaces/AgentGetParams.md new file mode 100644 index 0000000..05658bd --- /dev/null +++ b/docs/api/managed/interfaces/AgentGetParams.md @@ -0,0 +1,30 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentGetParams + +# Interface: AgentGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### version? + +> `optional` **version?**: `number` + +Agent version. Omit for the most recent version. Must be at least 1 if +specified. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/AgentListParams.md b/docs/api/managed/interfaces/AgentListParams.md new file mode 100644 index 0000000..afa9912 --- /dev/null +++ b/docs/api/managed/interfaces/AgentListParams.md @@ -0,0 +1,61 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentListParams + +# Interface: AgentListParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### created\_at\[gte\]? + +> `optional` **created\_at\[gte\]?**: `string` + +Return agents created at or after this time (inclusive). + +*** + +### created\_at\[lte\]? + +> `optional` **created\_at\[lte\]?**: `string` + +Return agents created at or before this time (inclusive). + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` + +Include archived agents in results. Defaults to false. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum results per page. Default 20, maximum 100. + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination cursor from a previous response. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/AgentNewParams.md b/docs/api/managed/interfaces/AgentNewParams.md new file mode 100644 index 0000000..7c1e063 --- /dev/null +++ b/docs/api/managed/interfaces/AgentNewParams.md @@ -0,0 +1,102 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentNewParams + +# Interface: AgentNewParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +Description of what the agent does. + +*** + +### mcp\_servers? + +> `optional` **mcp\_servers?**: [`ManagedAgentsURLMCPServerParams`](ManagedAgentsURLMCPServerParams.md)[] \| `null` + +MCP servers this agent connects to. Maximum 20. Names must be unique within the +array. Every server must be referenced by an `mcp_toolset` in `tools`; +unreferenced servers are rejected. See the +[MCP connector guide](https://docs.qoder.com/cloud-agents/api/agents/schemas). + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up +to 512 chars. + +*** + +### model + +> **model**: [`ManagedAgentsModelConfigParams`](../type-aliases/ManagedAgentsModelConfigParams.md) + +Model identifier. Accepts the +[model string](https://docs.qoder.com/cloud-agents/api/models/list), +e.g. `claude-opus-5`, or a `model_config` object for additional configuration +control + +*** + +### multiagent? + +> `optional` **multiagent?**: [`ManagedAgentsMultiagentParams`](ManagedAgentsMultiagentParams.md) \| `null` + +A coordinator topology: the session's primary thread orchestrates work by +spawning session threads, each running an agent drawn from the `agents` roster. + +*** + +### name + +> **name**: `string` + +Human-readable name for the agent. + +*** + +### skills? + +> `optional` **skills?**: [`ManagedAgentsSkillParamsUnion`](../type-aliases/ManagedAgentsSkillParamsUnion.md)[] \| `null` + +Skills available to the agent. + +*** + +### system? + +> `optional` **system?**: `string` \| `null` + +System prompt for the agent. + +*** + +### tools? + +> `optional` **tools?**: [`AgentNewParamsToolUnion`](../type-aliases/AgentNewParamsToolUnion.md)[] \| `null` + +Tool configurations available to the agent. Maximum of 128 tools across all +toolsets allowed. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/AgentUpdateParams.md b/docs/api/managed/interfaces/AgentUpdateParams.md new file mode 100644 index 0000000..2a827ab --- /dev/null +++ b/docs/api/managed/interfaces/AgentUpdateParams.md @@ -0,0 +1,116 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentUpdateParams + +# Interface: AgentUpdateParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +Description. Omit to preserve; send empty string or null to clear. + +*** + +### mcp\_servers? + +> `optional` **mcp\_servers?**: [`ManagedAgentsURLMCPServerParams`](ManagedAgentsURLMCPServerParams.md)[] \| `null` + +MCP servers. Full replacement. Omit to preserve; send empty array or `null` to +clear. Names must be unique. Maximum 20. Every server must be referenced by an +`mcp_toolset` in the agent's resulting `tools`; unreferenced servers are +rejected. See the +[MCP connector guide](https://docs.qoder.com/cloud-agents/api/agents/schemas). + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +Metadata patch. Set a key to a string to upsert it, or to null to delete it. +Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars +each) with values up to 512 chars. + +*** + +### model? + +> `optional` **model?**: [`ManagedAgentsModelConfigParams`](../type-aliases/ManagedAgentsModelConfigParams.md) + +Model identifier. Accepts the +[model string](https://docs.qoder.com/cloud-agents/api/models/list), +e.g. `claude-opus-5`, or a `model_config` object for additional configuration +control. Omit to preserve. Cannot be cleared. + +*** + +### multiagent? + +> `optional` **multiagent?**: [`ManagedAgentsMultiagentParams`](ManagedAgentsMultiagentParams.md) \| `null` + +A coordinator topology: the session's primary thread orchestrates work by +spawning session threads, each running an agent drawn from the `agents` roster. + +*** + +### name? + +> `optional` **name?**: `string` + +Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared. + +*** + +### skills? + +> `optional` **skills?**: [`ManagedAgentsSkillParamsUnion`](../type-aliases/ManagedAgentsSkillParamsUnion.md)[] \| `null` + +Skills. Full replacement. Omit to preserve; send empty array or null to clear. + +*** + +### system? + +> `optional` **system?**: `string` \| `null` + +System prompt. Omit to preserve; send empty string or null to clear. + +*** + +### tools? + +> `optional` **tools?**: [`AgentUpdateParamsToolUnion`](../type-aliases/AgentUpdateParamsToolUnion.md)[] \| `null` + +Tool configurations available to the agent. Full replacement. Omit to preserve; +send empty array or null to clear. Maximum of 128 tools across all toolsets +allowed. + +*** + +### version? + +> `optional` **version?**: `number` \| `null` + +The agent's current version, used to prevent concurrent overwrites. Obtain this +value from a create or retrieve response. Must be at least 1 if specified. When +supplied, the request fails if it does not match the server's current version; +omit to apply the update unconditionally. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/AgentVersionListParams.md b/docs/api/managed/interfaces/AgentVersionListParams.md new file mode 100644 index 0000000..f85d1ae --- /dev/null +++ b/docs/api/managed/interfaces/AgentVersionListParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentVersionListParams + +# Interface: AgentVersionListParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum results per page. Default 20, maximum 100. + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination cursor. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/Base64ImageSourceParam.md b/docs/api/managed/interfaces/Base64ImageSourceParam.md new file mode 100644 index 0000000..6491c2f --- /dev/null +++ b/docs/api/managed/interfaces/Base64ImageSourceParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Base64ImageSourceParam + +# Interface: Base64ImageSourceParam + +The properties Data, MediaType, Type are required. + +## Properties + +### data + +> **data**: `string` + +*** + +### media\_type + +> **media\_type**: `string` + +Any of "image/jpeg", "image/png", "image/gif", "image/webp". + +*** + +### type? + +> `optional` **type?**: `"base64"` \| `null` + +This field can be elided, and will marshal its zero value as "base64". diff --git a/docs/api/managed/interfaces/Base64PDFSourceParam.md b/docs/api/managed/interfaces/Base64PDFSourceParam.md new file mode 100644 index 0000000..0e10775 --- /dev/null +++ b/docs/api/managed/interfaces/Base64PDFSourceParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Base64PDFSourceParam + +# Interface: Base64PDFSourceParam + +The properties Data, MediaType, Type are required. + +## Properties + +### data + +> **data**: `string` + +*** + +### media\_type? + +> `optional` **media\_type?**: `"application/pdf"` \| `null` + +This field can be elided, and will marshal its zero value as "application/pdf". + +*** + +### type? + +> `optional` **type?**: `"base64"` \| `null` + +This field can be elided, and will marshal its zero value as "base64". diff --git a/docs/api/managed/interfaces/BashCodeExecutionOutputBlockParam.md b/docs/api/managed/interfaces/BashCodeExecutionOutputBlockParam.md new file mode 100644 index 0000000..c1d3506 --- /dev/null +++ b/docs/api/managed/interfaces/BashCodeExecutionOutputBlockParam.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BashCodeExecutionOutputBlockParam + +# Interface: BashCodeExecutionOutputBlockParam + +The properties FileID, Type are required. + +## Properties + +### file\_id + +> **file\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"bash_code_execution_output"` \| `null` + +This field can be elided, and will marshal its zero value as +"bash_code_execution_output". diff --git a/docs/api/managed/interfaces/BashCodeExecutionResultBlockParam.md b/docs/api/managed/interfaces/BashCodeExecutionResultBlockParam.md new file mode 100644 index 0000000..1b02f5f --- /dev/null +++ b/docs/api/managed/interfaces/BashCodeExecutionResultBlockParam.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BashCodeExecutionResultBlockParam + +# Interface: BashCodeExecutionResultBlockParam + +The properties Content, ReturnCode, Stderr, Stdout, Type are required. + +## Properties + +### content + +> **content**: [`BashCodeExecutionOutputBlockParam`](BashCodeExecutionOutputBlockParam.md)[] + +*** + +### return\_code + +> **return\_code**: `number` + +*** + +### stderr + +> **stderr**: `string` + +*** + +### stdout + +> **stdout**: `string` + +*** + +### type? + +> `optional` **type?**: `"bash_code_execution_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"bash_code_execution_result". diff --git a/docs/api/managed/interfaces/BashCodeExecutionToolResultBlockParam.md b/docs/api/managed/interfaces/BashCodeExecutionToolResultBlockParam.md new file mode 100644 index 0000000..ea98b72 --- /dev/null +++ b/docs/api/managed/interfaces/BashCodeExecutionToolResultBlockParam.md @@ -0,0 +1,38 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BashCodeExecutionToolResultBlockParam + +# Interface: BashCodeExecutionToolResultBlockParam + +The properties Content, ToolUseID, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### content + +> **content**: [`BashCodeExecutionToolResultBlockParamContentUnion`](../type-aliases/BashCodeExecutionToolResultBlockParamContentUnion.md) + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"bash_code_execution_tool_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"bash_code_execution_tool_result". diff --git a/docs/api/managed/interfaces/BashCodeExecutionToolResultErrorParam.md b/docs/api/managed/interfaces/BashCodeExecutionToolResultErrorParam.md new file mode 100644 index 0000000..4c89999 --- /dev/null +++ b/docs/api/managed/interfaces/BashCodeExecutionToolResultErrorParam.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BashCodeExecutionToolResultErrorParam + +# Interface: BashCodeExecutionToolResultErrorParam + +The properties ErrorCode, Type are required. + +## Properties + +### error\_code + +> **error\_code**: `string` + +Any of "invalid_tool_input", "unavailable", "too_many_requests", +"execution_time_exceeded", "output_file_too_large". + +*** + +### type? + +> `optional` **type?**: `"bash_code_execution_tool_result_error"` \| `null` + +This field can be elided, and will marshal its zero value as +"bash_code_execution_tool_result_error". diff --git a/docs/api/managed/interfaces/BrowserStateBlockParam.md b/docs/api/managed/interfaces/BrowserStateBlockParam.md new file mode 100644 index 0000000..eaceb88 --- /dev/null +++ b/docs/api/managed/interfaces/BrowserStateBlockParam.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BrowserStateBlockParam + +# Interface: BrowserStateBlockParam + +The caller's browser state after a browser toolset member call — the full +inventory of open tabs, which tab is active, and any side effects (tabs opened, +download state changes) the call produced. + +At most one per `tool_result`, only on a non-error result answering a browser +toolset member `tool_use`. The server renders the model-visible text from it; +the model never sees the raw fields. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### state\_changes? + +> `optional` **state\_changes?**: [`BrowserStateChangeUnionParam`](../type-aliases/BrowserStateChangeUnionParam.md)[] \| `null` + +Tabs opened and download state changes during this call. "Nothing to report" is +expressed by omitting the field, never by an empty list. + +*** + +### tabs + +> **tabs**: [`BrowserStateTabEntryParam`](BrowserStateTabEntryParam.md)[] + +All tabs open in the browser after this call — the full inventory, not a delta. +May be empty. Whenever non-empty, exactly one entry carries `active: true`. + +*** + +### type? + +> `optional` **type?**: `"browser_state"` \| `null` + +This field can be elided, and will marshal its zero value as "browser_state". diff --git a/docs/api/managed/interfaces/BrowserStateChangeDownloadCompletedParam.md b/docs/api/managed/interfaces/BrowserStateChangeDownloadCompletedParam.md new file mode 100644 index 0000000..c11842c --- /dev/null +++ b/docs/api/managed/interfaces/BrowserStateChangeDownloadCompletedParam.md @@ -0,0 +1,55 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BrowserStateChangeDownloadCompletedParam + +# Interface: BrowserStateChangeDownloadCompletedParam + +A file download that finished during this call, reported with the same +`download_id` as its `download_started` — or without a prior `download_started`, +when the download finished during the call that started it (at most one state +change per `download_id` per result). + +## Properties + +### download\_id + +> **download\_id**: `string` + +The caller-assigned identifier for this download, stable across the state +changes reporting it. + +*** + +### path? + +> `optional` **path?**: `string` \| `null` + +Where the executor saved the file, on the executor's filesystem. Only included +when another tool in the same environment can read the file at that path. + +*** + +### size\_bytes? + +> `optional` **size\_bytes?**: `number` \| `null` + +The completed download's size. + +*** + +### type? + +> `optional` **type?**: `"download_completed"` \| `null` + +This field can be elided, and will marshal its zero value as +"download_completed". + +*** + +### url + +> **url**: `string` + +The final post-redirect URL the download was served from. diff --git a/docs/api/managed/interfaces/BrowserStateChangeDownloadFailedParam.md b/docs/api/managed/interfaces/BrowserStateChangeDownloadFailedParam.md new file mode 100644 index 0000000..9fdaf40 --- /dev/null +++ b/docs/api/managed/interfaces/BrowserStateChangeDownloadFailedParam.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BrowserStateChangeDownloadFailedParam + +# Interface: BrowserStateChangeDownloadFailedParam + +A file download that failed — or was cancelled — during this call. + +## Properties + +### download\_id + +> **download\_id**: `string` + +The caller-assigned identifier for this download, stable across the state +changes reporting it. + +*** + +### error? + +> `optional` **error?**: `string` \| `null` + +The failure or cancellation detail, when known. + +*** + +### type? + +> `optional` **type?**: `"download_failed"` \| `null` + +This field can be elided, and will marshal its zero value as "download_failed". + +*** + +### url + +> **url**: `string` + +The final post-redirect URL the download was served from. diff --git a/docs/api/managed/interfaces/BrowserStateChangeDownloadStartedParam.md b/docs/api/managed/interfaces/BrowserStateChangeDownloadStartedParam.md new file mode 100644 index 0000000..82bc58a --- /dev/null +++ b/docs/api/managed/interfaces/BrowserStateChangeDownloadStartedParam.md @@ -0,0 +1,34 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BrowserStateChangeDownloadStartedParam + +# Interface: BrowserStateChangeDownloadStartedParam + +A file download that started during this call. + +## Properties + +### download\_id + +> **download\_id**: `string` + +The caller-assigned identifier for this download, stable across the state +changes reporting it. + +*** + +### type? + +> `optional` **type?**: `"download_started"` \| `null` + +This field can be elided, and will marshal its zero value as "download_started". + +*** + +### url + +> **url**: `string` + +The final post-redirect URL the download was served from. diff --git a/docs/api/managed/interfaces/BrowserStateChangeTabOpenedParam.md b/docs/api/managed/interfaces/BrowserStateChangeTabOpenedParam.md new file mode 100644 index 0000000..3c49530 --- /dev/null +++ b/docs/api/managed/interfaces/BrowserStateChangeTabOpenedParam.md @@ -0,0 +1,30 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BrowserStateChangeTabOpenedParam + +# Interface: BrowserStateChangeTabOpenedParam + +A tab this call's execution opened that remains open at its end — the creation +delta of the `tabs` inventory, not an event log. + +Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, +which must include the same `tab_id`. A tab opened during a failed call gets no +deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. + +## Properties + +### tab\_id + +> **tab\_id**: `string` + +The `tab_id` of the opened tab, present in `tabs`. + +*** + +### type? + +> `optional` **type?**: `"tab_opened"` \| `null` + +This field can be elided, and will marshal its zero value as "tab_opened". diff --git a/docs/api/managed/interfaces/BrowserStateTabEntryParam.md b/docs/api/managed/interfaces/BrowserStateTabEntryParam.md new file mode 100644 index 0000000..05e5af7 --- /dev/null +++ b/docs/api/managed/interfaces/BrowserStateTabEntryParam.md @@ -0,0 +1,47 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BrowserStateTabEntryParam + +# Interface: BrowserStateTabEntryParam + +One open browser tab reported in a `browser_state` block's `tabs` inventory. + +`tab_id` is the caller-assigned identifier for the tab; `title` and `url` +describe the page the tab is currently showing and may be empty strings (a blank +tab legitimately has both empty). `active` marks the tab that is active after +this call; whenever `tabs` is non-empty, exactly one entry is marked. + +## Properties + +### active? + +> `optional` **active?**: `boolean` \| `null` + +Whether this tab is the active tab after this call. Whenever `tabs` is +non-empty, exactly one entry is marked `active: true`. + +*** + +### tab\_id + +> **tab\_id**: `string` + +The caller-assigned identifier for this tab, unique within the inventory. + +*** + +### title + +> **title**: `string` + +The title of the page the tab is showing. May be empty. + +*** + +### url + +> **url**: `string` + +The URL of the page the tab is showing. May be empty. diff --git a/docs/api/managed/interfaces/CacheControlEphemeralParam.md b/docs/api/managed/interfaces/CacheControlEphemeralParam.md new file mode 100644 index 0000000..d0e50fd --- /dev/null +++ b/docs/api/managed/interfaces/CacheControlEphemeralParam.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CacheControlEphemeralParam + +# Interface: CacheControlEphemeralParam + +This struct has a constant value, construct it with +`NewCacheControlEphemeralParam`. + +## Properties + +### ttl? + +> `optional` **ttl?**: `string` \| `null` + +The time-to-live for the cache control breakpoint. + +This may be one the following values: + +- `5m`: 5 minutes +- `1h`: 1 hour + +Defaults to `5m`. + +Any of "5m", "1h". + +*** + +### type? + +> `optional` **type?**: `"ephemeral"` \| `null` diff --git a/docs/api/managed/interfaces/CapabilitySupport.md b/docs/api/managed/interfaces/CapabilitySupport.md new file mode 100644 index 0000000..984114e --- /dev/null +++ b/docs/api/managed/interfaces/CapabilitySupport.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CapabilitySupport + +# Interface: CapabilitySupport + +Indicates whether a capability is supported. + +## Properties + +### supported + +> **supported**: `boolean` + +Whether this capability is supported by the model. diff --git a/docs/api/managed/interfaces/CitationCharLocationParam.md b/docs/api/managed/interfaces/CitationCharLocationParam.md new file mode 100644 index 0000000..1e753a3 --- /dev/null +++ b/docs/api/managed/interfaces/CitationCharLocationParam.md @@ -0,0 +1,48 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CitationCharLocationParam + +# Interface: CitationCharLocationParam + +The properties CitedText, DocumentIndex, DocumentTitle, EndCharIndex, +StartCharIndex, Type are required. + +## Properties + +### cited\_text + +> **cited\_text**: `string` + +*** + +### document\_index + +> **document\_index**: `number` + +*** + +### document\_title + +> **document\_title**: `string` + +*** + +### end\_char\_index + +> **end\_char\_index**: `number` + +*** + +### start\_char\_index + +> **start\_char\_index**: `number` + +*** + +### type? + +> `optional` **type?**: `"char_location"` \| `null` + +This field can be elided, and will marshal its zero value as "char_location". diff --git a/docs/api/managed/interfaces/CitationContentBlockLocationParam.md b/docs/api/managed/interfaces/CitationContentBlockLocationParam.md new file mode 100644 index 0000000..926d707 --- /dev/null +++ b/docs/api/managed/interfaces/CitationContentBlockLocationParam.md @@ -0,0 +1,64 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CitationContentBlockLocationParam + +# Interface: CitationContentBlockLocationParam + +The properties CitedText, DocumentIndex, DocumentTitle, EndBlockIndex, +StartBlockIndex, Type are required. + +## Properties + +### cited\_text + +> **cited\_text**: `string` + +The full text of the cited block range, concatenated. + +Always equals the contents of `content`start_block_index:end_block_index`` +joined together. The text block is the minimal citable unit; this field is never +a substring of a single block. Not counted toward output tokens, and not counted +toward input tokens when sent back in subsequent turns. + +*** + +### document\_index + +> **document\_index**: `number` + +*** + +### document\_title + +> **document\_title**: `string` + +*** + +### end\_block\_index + +> **end\_block\_index**: `number` + +Exclusive 0-based end index of the cited block range in the source's `content` +array. + +Always greater than `start_block_index`; a single-block citation has +`end_block_index = start_block_index + 1`. + +*** + +### start\_block\_index + +> **start\_block\_index**: `number` + +0-based index of the first cited block in the source's `content` array. + +*** + +### type? + +> `optional` **type?**: `"content_block_location"` \| `null` + +This field can be elided, and will marshal its zero value as +"content_block_location". diff --git a/docs/api/managed/interfaces/CitationPageLocationParam.md b/docs/api/managed/interfaces/CitationPageLocationParam.md new file mode 100644 index 0000000..3141383 --- /dev/null +++ b/docs/api/managed/interfaces/CitationPageLocationParam.md @@ -0,0 +1,48 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CitationPageLocationParam + +# Interface: CitationPageLocationParam + +The properties CitedText, DocumentIndex, DocumentTitle, EndPageNumber, +StartPageNumber, Type are required. + +## Properties + +### cited\_text + +> **cited\_text**: `string` + +*** + +### document\_index + +> **document\_index**: `number` + +*** + +### document\_title + +> **document\_title**: `string` + +*** + +### end\_page\_number + +> **end\_page\_number**: `number` + +*** + +### start\_page\_number + +> **start\_page\_number**: `number` + +*** + +### type? + +> `optional` **type?**: `"page_location"` \| `null` + +This field can be elided, and will marshal its zero value as "page_location". diff --git a/docs/api/managed/interfaces/CitationSearchResultLocationParam.md b/docs/api/managed/interfaces/CitationSearchResultLocationParam.md new file mode 100644 index 0000000..0f8adb2 --- /dev/null +++ b/docs/api/managed/interfaces/CitationSearchResultLocationParam.md @@ -0,0 +1,77 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CitationSearchResultLocationParam + +# Interface: CitationSearchResultLocationParam + +The properties CitedText, EndBlockIndex, SearchResultIndex, Source, +StartBlockIndex, Title, Type are required. + +## Properties + +### cited\_text + +> **cited\_text**: `string` + +The full text of the cited block range, concatenated. + +Always equals the contents of `content`start_block_index:end_block_index`` +joined together. The text block is the minimal citable unit; this field is never +a substring of a single block. Not counted toward output tokens, and not counted +toward input tokens when sent back in subsequent turns. + +*** + +### end\_block\_index + +> **end\_block\_index**: `number` + +Exclusive 0-based end index of the cited block range in the source's `content` +array. + +Always greater than `start_block_index`; a single-block citation has +`end_block_index = start_block_index + 1`. + +*** + +### search\_result\_index + +> **search\_result\_index**: `number` + +0-based index of the cited search result among all `search_result` content +blocks in the request, in the order they appear across messages and tool +results. + +Counted separately from `document_index`; server-side web search results are not +included in this count. + +*** + +### source + +> **source**: `string` + +*** + +### start\_block\_index + +> **start\_block\_index**: `number` + +0-based index of the first cited block in the source's `content` array. + +*** + +### title + +> **title**: `string` + +*** + +### type? + +> `optional` **type?**: `"search_result_location"` \| `null` + +This field can be elided, and will marshal its zero value as +"search_result_location". diff --git a/docs/api/managed/interfaces/CitationWebSearchResultLocationParam.md b/docs/api/managed/interfaces/CitationWebSearchResultLocationParam.md new file mode 100644 index 0000000..39c73c7 --- /dev/null +++ b/docs/api/managed/interfaces/CitationWebSearchResultLocationParam.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CitationWebSearchResultLocationParam + +# Interface: CitationWebSearchResultLocationParam + +The properties CitedText, EncryptedIndex, Title, Type, URL are required. + +## Properties + +### cited\_text + +> **cited\_text**: `string` + +*** + +### encrypted\_index + +> **encrypted\_index**: `string` + +*** + +### title + +> **title**: `string` + +*** + +### type? + +> `optional` **type?**: `"web_search_result_location"` \| `null` + +This field can be elided, and will marshal its zero value as +"web_search_result_location". + +*** + +### url + +> **url**: `string` diff --git a/docs/api/managed/interfaces/CitationsConfigParam.md b/docs/api/managed/interfaces/CitationsConfigParam.md new file mode 100644 index 0000000..cda9948 --- /dev/null +++ b/docs/api/managed/interfaces/CitationsConfigParam.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CitationsConfigParam + +# Interface: CitationsConfigParam + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` diff --git a/docs/api/managed/interfaces/CloudConfig.md b/docs/api/managed/interfaces/CloudConfig.md new file mode 100644 index 0000000..be26efe --- /dev/null +++ b/docs/api/managed/interfaces/CloudConfig.md @@ -0,0 +1,39 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CloudConfig + +# Interface: CloudConfig + +`cloud` environment configuration. + +## Properties + +### networking + +> **networking**: [`CloudConfigNetworkingUnion`](../type-aliases/CloudConfigNetworkingUnion.md) + +Network configuration policy. + +*** + +### packages + +> **packages**: [`Packages`](Packages.md) + +Package manager configuration. + +*** + +### setup\_script? + +> `optional` **setup\_script?**: `string` + +*** + +### type? + +> `optional` **type?**: `"cloud"` + +Environment type diff --git a/docs/api/managed/interfaces/CloudConfigParams.md b/docs/api/managed/interfaces/CloudConfigParams.md new file mode 100644 index 0000000..d8047eb --- /dev/null +++ b/docs/api/managed/interfaces/CloudConfigParams.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CloudConfigParams + +# Interface: CloudConfigParams + +Request params for `cloud` environment configuration. + +Fields default to null; on update, omitted fields preserve the existing value. + +## Properties + +### networking? + +> `optional` **networking?**: [`CloudConfigParamsNetworkingUnion`](../type-aliases/CloudConfigParamsNetworkingUnion.md) \| `null` + +Network configuration policy. Omit on update to preserve the existing value. + +*** + +### packages? + +> `optional` **packages?**: [`PackagesParams`](PackagesParams.md) \| `null` + +Specify packages (and optionally their versions) available in this environment. + +When versioning, use the version semantics relevant for the package manager, +e.g. for `pip` use `package==1.0.0`. You are responsible for validating the +package and version exist. Unversioned installs the latest. + +Under `limited` networking, requires `networking.allow_package_managers` to be +`true`. + +*** + +### setup\_script? + +> `optional` **setup\_script?**: `string` \| `null` + +*** + +### type? + +> `optional` **type?**: `"cloud"` \| `null` + +Environment type + +This field can be elided, and will marshal its zero value as "cloud". diff --git a/docs/api/managed/interfaces/CodeExecutionOutputBlockParam.md b/docs/api/managed/interfaces/CodeExecutionOutputBlockParam.md new file mode 100644 index 0000000..e82dc27 --- /dev/null +++ b/docs/api/managed/interfaces/CodeExecutionOutputBlockParam.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CodeExecutionOutputBlockParam + +# Interface: CodeExecutionOutputBlockParam + +The properties FileID, Type are required. + +## Properties + +### file\_id + +> **file\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"code_execution_output"` \| `null` + +This field can be elided, and will marshal its zero value as +"code_execution_output". diff --git a/docs/api/managed/interfaces/CodeExecutionResultBlockParam.md b/docs/api/managed/interfaces/CodeExecutionResultBlockParam.md new file mode 100644 index 0000000..b202f68 --- /dev/null +++ b/docs/api/managed/interfaces/CodeExecutionResultBlockParam.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CodeExecutionResultBlockParam + +# Interface: CodeExecutionResultBlockParam + +The properties Content, ReturnCode, Stderr, Stdout, Type are required. + +## Properties + +### content + +> **content**: [`CodeExecutionOutputBlockParam`](CodeExecutionOutputBlockParam.md)[] + +*** + +### return\_code + +> **return\_code**: `number` + +*** + +### stderr + +> **stderr**: `string` + +*** + +### stdout + +> **stdout**: `string` + +*** + +### type? + +> `optional` **type?**: `"code_execution_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"code_execution_result". diff --git a/docs/api/managed/interfaces/CodeExecutionToolResultBlockParam.md b/docs/api/managed/interfaces/CodeExecutionToolResultBlockParam.md new file mode 100644 index 0000000..7c58d07 --- /dev/null +++ b/docs/api/managed/interfaces/CodeExecutionToolResultBlockParam.md @@ -0,0 +1,40 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CodeExecutionToolResultBlockParam + +# Interface: CodeExecutionToolResultBlockParam + +The properties Content, ToolUseID, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### content + +> **content**: [`CodeExecutionToolResultBlockParamContentUnion`](../type-aliases/CodeExecutionToolResultBlockParamContentUnion.md) + +Code execution result with encrypted stdout for PFC + web_search results. + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"code_execution_tool_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"code_execution_tool_result". diff --git a/docs/api/managed/interfaces/CodeExecutionToolResultErrorParam.md b/docs/api/managed/interfaces/CodeExecutionToolResultErrorParam.md new file mode 100644 index 0000000..8693755 --- /dev/null +++ b/docs/api/managed/interfaces/CodeExecutionToolResultErrorParam.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CodeExecutionToolResultErrorParam + +# Interface: CodeExecutionToolResultErrorParam + +The properties ErrorCode, Type are required. + +## Properties + +### error\_code + +> **error\_code**: `string` + +Any of "invalid_tool_input", "unavailable", "too_many_requests", +"execution_time_exceeded". + +*** + +### type? + +> `optional` **type?**: `"code_execution_tool_result_error"` \| `null` + +This field can be elided, and will marshal its zero value as +"code_execution_tool_result_error". diff --git a/docs/api/managed/interfaces/CompactionBlockParam.md b/docs/api/managed/interfaces/CompactionBlockParam.md new file mode 100644 index 0000000..3ea822b --- /dev/null +++ b/docs/api/managed/interfaces/CompactionBlockParam.md @@ -0,0 +1,47 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CompactionBlockParam + +# Interface: CompactionBlockParam + +A compaction block containing summary of previous context. + +Users should round-trip these blocks from responses to subsequent requests to +maintain context across compaction boundaries. + +When content is None, the block represents a failed compaction. The server +treats these as no-ops. Empty string content is not allowed. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### content? + +> `optional` **content?**: `string` \| `null` + +Summary of previously compacted content, or null if compaction failed + +*** + +### encrypted\_content? + +> `optional` **encrypted\_content?**: `string` \| `null` + +Opaque metadata from prior compaction, to be round-tripped verbatim + +*** + +### type? + +> `optional` **type?**: `"compaction"` \| `null` + +This field can be elided, and will marshal its zero value as "compaction". diff --git a/docs/api/managed/interfaces/ContainerUploadBlockParam.md b/docs/api/managed/interfaces/ContainerUploadBlockParam.md new file mode 100644 index 0000000..a9f8fac --- /dev/null +++ b/docs/api/managed/interfaces/ContainerUploadBlockParam.md @@ -0,0 +1,32 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ContainerUploadBlockParam + +# Interface: ContainerUploadBlockParam + +A content block that represents a file to be uploaded to the container Files +uploaded via this block will be available in the container's input directory. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### file\_id + +> **file\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"container_upload"` \| `null` + +This field can be elided, and will marshal its zero value as "container_upload". diff --git a/docs/api/managed/interfaces/ContentBlockSourceParam.md b/docs/api/managed/interfaces/ContentBlockSourceParam.md new file mode 100644 index 0000000..e13072f --- /dev/null +++ b/docs/api/managed/interfaces/ContentBlockSourceParam.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ContentBlockSourceParam + +# Interface: ContentBlockSourceParam + +The properties Content, Type are required. + +## Properties + +### content + +> **content**: [`ContentBlockSourceContentUnionParam`](../type-aliases/ContentBlockSourceContentUnionParam.md) + +*** + +### type? + +> `optional` **type?**: `"content"` \| `null` + +This field can be elided, and will marshal its zero value as "content". diff --git a/docs/api/managed/interfaces/ContextManagementCapability.md b/docs/api/managed/interfaces/ContextManagementCapability.md new file mode 100644 index 0000000..6715ff6 --- /dev/null +++ b/docs/api/managed/interfaces/ContextManagementCapability.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ContextManagementCapability + +# Interface: ContextManagementCapability + +Context management capability details. + +## Properties + +### clear\_thinking\_20251015 + +> **clear\_thinking\_20251015**: [`CapabilitySupport`](CapabilitySupport.md) + +Indicates whether a capability is supported. + +*** + +### clear\_tool\_uses\_20250919 + +> **clear\_tool\_uses\_20250919**: [`CapabilitySupport`](CapabilitySupport.md) + +Indicates whether a capability is supported. + +*** + +### compact\_20260112 + +> **compact\_20260112**: [`CapabilitySupport`](CapabilitySupport.md) + +Indicates whether a capability is supported. + +*** + +### supported + +> **supported**: `boolean` + +Whether this capability is supported by the model. diff --git a/docs/api/managed/interfaces/DeletedFile.md b/docs/api/managed/interfaces/DeletedFile.md new file mode 100644 index 0000000..52697d8 --- /dev/null +++ b/docs/api/managed/interfaces/DeletedFile.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeletedFile + +# Interface: DeletedFile + +## Properties + +### id + +> **id**: `string` + +ID of the deleted file. + +*** + +### type? + +> `optional` **type?**: `"file_deleted"` + +Deleted object type. + +For file deletion, this is always `"file_deleted"`. + +Any of "file_deleted". diff --git a/docs/api/managed/interfaces/DeletedSkill.md b/docs/api/managed/interfaces/DeletedSkill.md new file mode 100644 index 0000000..d46d96f --- /dev/null +++ b/docs/api/managed/interfaces/DeletedSkill.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeletedSkill + +# Interface: DeletedSkill + +## Properties + +### id + +> **id**: `string` + +Unique identifier for the skill. + +The format and length of IDs may change over time. + +*** + +### type? + +> `optional` **type?**: `"skill_deleted"` + +Deleted object type. + +For Skills, this is always `"skill_deleted"`. diff --git a/docs/api/managed/interfaces/DeletedSkillVersion.md b/docs/api/managed/interfaces/DeletedSkillVersion.md new file mode 100644 index 0000000..afeea74 --- /dev/null +++ b/docs/api/managed/interfaces/DeletedSkillVersion.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeletedSkillVersion + +# Interface: DeletedSkillVersion + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this Skill Version. The id addresses the version in paths +and pins it in references. + +*** + +### type? + +> `optional` **type?**: `"skill_version_deleted"` + +Deleted object type. + +For Skill Versions, this is always `"skill_version_deleted"`. diff --git a/docs/api/managed/interfaces/DeploymentArchiveParams.md b/docs/api/managed/interfaces/DeploymentArchiveParams.md new file mode 100644 index 0000000..a318c72 --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentArchiveParams + +# Interface: DeploymentArchiveParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DeploymentGetParams.md b/docs/api/managed/interfaces/DeploymentGetParams.md new file mode 100644 index 0000000..c6b1328 --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentGetParams + +# Interface: DeploymentGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DeploymentListParams.md b/docs/api/managed/interfaces/DeploymentListParams.md new file mode 100644 index 0000000..34a3bfd --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentListParams.md @@ -0,0 +1,92 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentListParams + +# Interface: DeploymentListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### agent\_id? + +> `optional` **agent\_id?**: `string` + +Filter by agent ID. + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### created\_at\[gte\]? + +> `optional` **created\_at\[gte\]?**: `string` + +Return deployments created at or after this time (inclusive). + +*** + +### created\_at\[lte\]? + +> `optional` **created\_at\[lte\]?**: `string` + +Return deployments created at or before this time (inclusive). + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` + +When true, includes archived deployments. Default: false (exclude archived). + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum results per page. Default 20, maximum 100. + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination cursor. + +*** + +### status? + +> `optional` **status?**: [`ManagedAgentsDeploymentStatus`](../type-aliases/ManagedAgentsDeploymentStatus.md) + +Filter by status: `active` or `paused`. Omit for both. To include archived +deployments, use `include_archived` instead; the two cannot be combined. + +Any of "active", "paused". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DeploymentNewParams.md b/docs/api/managed/interfaces/DeploymentNewParams.md new file mode 100644 index 0000000..d67eced --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentNewParams.md @@ -0,0 +1,116 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentNewParams + +# Interface: DeploymentNewParams + +## Properties + +### agent + +> **agent**: [`DeploymentNewParamsAgentUnion`](../type-aliases/DeploymentNewParamsAgentUnion.md) + +Agent to deploy. Accepts the `agent` ID string, which pins the latest version, +or an `agent` object with both id and version specified. The agent must exist +and not be archived. + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### budget? + +> `optional` **budget?**: [`ManagedAgentsBudgetLimitParam`](ManagedAgentsBudgetLimitParam.md) \| `null` + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +Description of what the deployment does. + +*** + +### environment\_id + +> **environment\_id**: `string` + +ID of the `environment` defining the container configuration for sessions +created from this deployment. + +*** + +### environment\_variables? + +> `optional` **environment\_variables?**: `string` \| `null` + +*** + +### initial\_events + +> **initial\_events**: [`ManagedAgentsDeploymentInitialEventParamsUnion`](../type-aliases/ManagedAgentsDeploymentInitialEventParamsUnion.md)[] + +Events to send to each session immediately after creation. At least 1, +maximum 50. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up +to 512 chars. + +*** + +### name + +> **name**: `string` + +Human-readable name for the deployment. + +*** + +### resources? + +> `optional` **resources?**: [`DeploymentNewParamsResourceUnion`](../type-aliases/DeploymentNewParamsResourceUnion.md)[] \| `null` + +Resources (e.g. repositories, files) to mount into each session's container. +Maximum 500. + +*** + +### schedule? + +> `optional` **schedule?**: [`ManagedAgentsScheduleParams`](ManagedAgentsScheduleParams.md) \| `null` + +5-field POSIX cron schedule. Literal wall-clock matching in the configured +timezone. + +*** + +### vault\_ids? + +> `optional` **vault\_ids?**: `string`[] \| `null` + +Vault IDs for stored credentials the agent can use during sessions created from +this deployment. Maximum 50. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DeploymentPauseParams.md b/docs/api/managed/interfaces/DeploymentPauseParams.md new file mode 100644 index 0000000..dbdabfd --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentPauseParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentPauseParams + +# Interface: DeploymentPauseParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DeploymentRunGetParams.md b/docs/api/managed/interfaces/DeploymentRunGetParams.md new file mode 100644 index 0000000..d907fd5 --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentRunGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentRunGetParams + +# Interface: DeploymentRunGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DeploymentRunListParams.md b/docs/api/managed/interfaces/DeploymentRunListParams.md new file mode 100644 index 0000000..b0376c1 --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentRunListParams.md @@ -0,0 +1,111 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentRunListParams + +# Interface: DeploymentRunListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### created\_at\[gt\]? + +> `optional` **created\_at\[gt\]?**: `string` + +Return runs created strictly after this time (exclusive). + +*** + +### created\_at\[gte\]? + +> `optional` **created\_at\[gte\]?**: `string` + +Return runs created at or after this time (inclusive). + +*** + +### created\_at\[lt\]? + +> `optional` **created\_at\[lt\]?**: `string` + +Return runs created strictly before this time (exclusive). + +*** + +### created\_at\[lte\]? + +> `optional` **created\_at\[lte\]?**: `string` + +Return runs created at or before this time (inclusive). + +*** + +### deployment\_id? + +> `optional` **deployment\_id?**: `string` + +Filter to a specific deployment. Omit to list across all deployments in the +workspace. Filtering by a non-existent `deployment_id` returns 200 with empty +data. + +*** + +### has\_error? + +> `optional` **has\_error?**: `boolean` + +Filter: true for runs with non-null `error`, false for runs with non-null +`session_id`. Omit for all. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum results per page. Default 20, maximum 1000. + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination cursor. Pass `next_page` from the previous response. Invalid +or expired cursors return 400. + +*** + +### trigger\_type? + +> `optional` **trigger\_type?**: [`ManagedAgentsTriggerType`](../type-aliases/ManagedAgentsTriggerType.md) + +Filter runs by what triggered them. Omit to return all runs. + +Any of "schedule", "manual". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DeploymentRunParams.md b/docs/api/managed/interfaces/DeploymentRunParams.md new file mode 100644 index 0000000..8fffd61 --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentRunParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentRunParams + +# Interface: DeploymentRunParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DeploymentUnpauseParams.md b/docs/api/managed/interfaces/DeploymentUnpauseParams.md new file mode 100644 index 0000000..231d17f --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentUnpauseParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentUnpauseParams + +# Interface: DeploymentUnpauseParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DeploymentUpdateParams.md b/docs/api/managed/interfaces/DeploymentUpdateParams.md new file mode 100644 index 0000000..0c0e0c2 --- /dev/null +++ b/docs/api/managed/interfaces/DeploymentUpdateParams.md @@ -0,0 +1,116 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentUpdateParams + +# Interface: DeploymentUpdateParams + +## Properties + +### agent? + +> `optional` **agent?**: [`DeploymentUpdateParamsAgentUnion`](../type-aliases/DeploymentUpdateParamsAgentUnion.md) + +Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest +version, or an `agent` object with both id and version specified. Omit to +preserve. Cannot be cleared. + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### budget? + +> `optional` **budget?**: [`ManagedAgentsBudgetLimitParam`](ManagedAgentsBudgetLimitParam.md) \| `null` + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +Description. Omit to preserve; send empty string or null to clear. + +*** + +### environment\_id? + +> `optional` **environment\_id?**: `string` + +ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared. + +*** + +### environment\_variables? + +> `optional` **environment\_variables?**: `string` \| `null` + +*** + +### initial\_events? + +> `optional` **initial\_events?**: [`ManagedAgentsDeploymentInitialEventParamsUnion`](../type-aliases/ManagedAgentsDeploymentInitialEventParamsUnion.md)[] + +Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least +1, maximum 50. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +Metadata patch. Set a key to a string to upsert it, or to null to delete it. +Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars +each) with values up to 512 chars. + +*** + +### name? + +> `optional` **name?**: `string` + +Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared. + +*** + +### resources? + +> `optional` **resources?**: [`DeploymentUpdateParamsResourceUnion`](../type-aliases/DeploymentUpdateParamsResourceUnion.md)[] \| `null` + +Session resources. Full replacement. Omit to preserve; send empty array or null +to clear. Maximum 500. + +*** + +### schedule? + +> `optional` **schedule?**: [`ManagedAgentsScheduleParams`](ManagedAgentsScheduleParams.md) \| `null` + +5-field POSIX cron schedule. Literal wall-clock matching in the configured +timezone. + +*** + +### vault\_ids? + +> `optional` **vault\_ids?**: `string`[] \| `null` + +Vault IDs. Full replacement. Omit to preserve; send empty array or null to +clear. Maximum 50. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DirectCallerParam.md b/docs/api/managed/interfaces/DirectCallerParam.md new file mode 100644 index 0000000..b568306 --- /dev/null +++ b/docs/api/managed/interfaces/DirectCallerParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DirectCallerParam + +# Interface: DirectCallerParam + +Tool invocation directly from the model. + +This struct has a constant value, construct it with `NewDirectCallerParam`. + +## Properties + +### type? + +> `optional` **type?**: `"direct"` \| `null` diff --git a/docs/api/managed/interfaces/Dream.md b/docs/api/managed/interfaces/Dream.md new file mode 100644 index 0000000..e55d09f --- /dev/null +++ b/docs/api/managed/interfaces/Dream.md @@ -0,0 +1,121 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Dream + +# Interface: Dream + +An asynchronous memory-consolidation job that reads a memory store plus a set of +session transcripts and writes consolidated memories into an output memory store +— a new store by default, or an existing store chosen via output_behavior. The +Dreams API is in research preview: the request and response shapes are volatile +and may change without the deprecation period that applies to +generally-available endpoints. + +## Properties + +### archived\_at + +> **archived\_at**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### ended\_at + +> **ended\_at**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### error + +> **error**: [`DreamError`](DreamError.md) \| `null` + +Failure detail for a Dream whose `status` is `failed`. + +*** + +### id + +> **id**: `string` + +*** + +### inputs + +> **inputs**: [`DreamInputUnion`](../type-aliases/DreamInputUnion.md)[] + +*** + +### instructions + +> **instructions**: `string` + +*** + +### model + +> **model**: [`DreamModelConfig`](DreamModelConfig.md) + +Model identifier and configuration applied to every pipeline stage. Same wire +shape as the Agents API ModelConfig. + +*** + +### output\_behavior + +> **output\_behavior**: [`OutputBehaviorUnion`](../type-aliases/OutputBehaviorUnion.md) + +The default destination: the job creates a new output memory store as a clone of +the memory_store input and writes the consolidated memories into it. The input +store is never mutated. + +*** + +### outputs + +> **outputs**: [`DreamOutput`](DreamOutput.md)[] + +*** + +### session\_id + +> **session\_id**: `string` \| `null` + +*** + +### status + +> **status**: [`DreamStatus`](../type-aliases/DreamStatus.md) + +Lifecycle status of a Dream. + +Any of "pending", "running", "completed", "failed", "canceled". + +*** + +### type + +> **type**: `"dream"` + +Any of "dream". + +*** + +### usage + +> **usage**: [`DreamUsage`](DreamUsage.md) + +Cumulative token usage for the dream across every pipeline stage. diff --git a/docs/api/managed/interfaces/DreamArchiveParams.md b/docs/api/managed/interfaces/DreamArchiveParams.md new file mode 100644 index 0000000..d9c69d0 --- /dev/null +++ b/docs/api/managed/interfaces/DreamArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamArchiveParams + +# Interface: DreamArchiveParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DreamCancelParams.md b/docs/api/managed/interfaces/DreamCancelParams.md new file mode 100644 index 0000000..5cfe3a8 --- /dev/null +++ b/docs/api/managed/interfaces/DreamCancelParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamCancelParams + +# Interface: DreamCancelParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DreamError.md b/docs/api/managed/interfaces/DreamError.md new file mode 100644 index 0000000..3d8ce89 --- /dev/null +++ b/docs/api/managed/interfaces/DreamError.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamError + +# Interface: DreamError + +Failure detail for a Dream whose `status` is `failed`. + +## Properties + +### message + +> **message**: `string` + +*** + +### type + +> **type**: `string` diff --git a/docs/api/managed/interfaces/DreamGetParams.md b/docs/api/managed/interfaces/DreamGetParams.md new file mode 100644 index 0000000..dd664bc --- /dev/null +++ b/docs/api/managed/interfaces/DreamGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamGetParams + +# Interface: DreamGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DreamListParams.md b/docs/api/managed/interfaces/DreamListParams.md new file mode 100644 index 0000000..7a5bac5 --- /dev/null +++ b/docs/api/managed/interfaces/DreamListParams.md @@ -0,0 +1,72 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamListParams + +# Interface: DreamListParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### created\_at\[gt\]? + +> `optional` **created\_at\[gt\]?**: `string` + +Return dreams with `created_at` strictly after this timestamp (exclusive lower +bound, RFC 3339). Unset applies no lower bound. + +*** + +### created\_at\[lt\]? + +> `optional` **created\_at\[lt\]?**: `string` + +Return dreams with `created_at` strictly before this timestamp (exclusive upper +bound, RFC 3339). Unset applies no upper bound. + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` + +Query parameter for include_archived + +*** + +### limit? + +> `optional` **limit?**: `number` + +Query parameter for limit + +*** + +### page? + +> `optional` **page?**: `string` + +Query parameter for page + +*** + +### statuses? + +> `optional` **statuses?**: [`DreamStatus`](../type-aliases/DreamStatus.md)[] + +Filter by lifecycle status. Repeat the parameter to match any of multiple +statuses. Empty applies no status filter. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DreamMemoryStoreInput.md b/docs/api/managed/interfaces/DreamMemoryStoreInput.md new file mode 100644 index 0000000..76d65e6 --- /dev/null +++ b/docs/api/managed/interfaces/DreamMemoryStoreInput.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamMemoryStoreInput + +# Interface: DreamMemoryStoreInput + +An input memory store the dream reads from. The dream never mutates this store +unless it is also the destination: with output_behavior {type: +"update_existing"} the job consolidates this store in place. + +## Properties + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### type + +> **type**: `"memory_store"` + +Any of "memory_store". diff --git a/docs/api/managed/interfaces/DreamMemoryStoreInputParam.md b/docs/api/managed/interfaces/DreamMemoryStoreInputParam.md new file mode 100644 index 0000000..e8761e0 --- /dev/null +++ b/docs/api/managed/interfaces/DreamMemoryStoreInputParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamMemoryStoreInputParam + +# Interface: DreamMemoryStoreInputParam + +An input memory store the dream reads from. The dream never mutates this store +unless it is also the destination: with output_behavior {type: +"update_existing"} the job consolidates this store in place. + +## Properties + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### type + +> **type**: `"memory_store"` + +Any of "memory_store". diff --git a/docs/api/managed/interfaces/DreamModelConfig.md b/docs/api/managed/interfaces/DreamModelConfig.md new file mode 100644 index 0000000..1bf35bd --- /dev/null +++ b/docs/api/managed/interfaces/DreamModelConfig.md @@ -0,0 +1,30 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamModelConfig + +# Interface: DreamModelConfig + +Model identifier and configuration applied to every pipeline stage. Same wire +shape as the Agents API ModelConfig. + +## Properties + +### id + +> **id**: `string` + +Model identifier, e.g. "claude-opus-5". 1-256 characters. + +*** + +### speed? + +> `optional` **speed?**: [`DreamModelConfigSpeed`](../type-aliases/DreamModelConfigSpeed.md) + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. + +Any of "standard", "fast". diff --git a/docs/api/managed/interfaces/DreamModelConfigParam.md b/docs/api/managed/interfaces/DreamModelConfigParam.md new file mode 100644 index 0000000..8e644c4 --- /dev/null +++ b/docs/api/managed/interfaces/DreamModelConfigParam.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamModelConfigParam + +# Interface: DreamModelConfigParam + +Model identifier and configuration applied to every pipeline stage. + +## Properties + +### id + +> **id**: `string` + +Model identifier, e.g. "claude-opus-5". 1-256 characters. + +*** + +### speed? + +> `optional` **speed?**: [`DreamModelConfigParamSpeed`](../type-aliases/DreamModelConfigParamSpeed.md) \| `null` + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. + +Any of "standard", "fast". diff --git a/docs/api/managed/interfaces/DreamNewParams.md b/docs/api/managed/interfaces/DreamNewParams.md new file mode 100644 index 0000000..d05f2ea --- /dev/null +++ b/docs/api/managed/interfaces/DreamNewParams.md @@ -0,0 +1,51 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamNewParams + +# Interface: DreamNewParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### inputs + +> **inputs**: [`DreamInputUnionParam`](../type-aliases/DreamInputUnionParam.md)[] + +*** + +### instructions? + +> `optional` **instructions?**: `string` \| `null` + +*** + +### model + +> **model**: [`DreamNewParamsModelUnion`](../type-aliases/DreamNewParamsModelUnion.md) + +Model identifier and configuration applied to every pipeline stage. + +*** + +### output\_behavior? + +> `optional` **output\_behavior?**: [`OutputBehaviorUnionParam`](../type-aliases/OutputBehaviorUnionParam.md) \| `null` + +The default destination: the job creates a new output memory store as a clone of +the memory_store input and writes the consolidated memories into it. The input +store is never mutated. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/DreamOutput.md b/docs/api/managed/interfaces/DreamOutput.md new file mode 100644 index 0000000..fc103b4 --- /dev/null +++ b/docs/api/managed/interfaces/DreamOutput.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamOutput + +# Interface: DreamOutput + +An output memory store the dream writes consolidated memories into. + +## Properties + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### type + +> **type**: `"memory_store"` + +Any of "memory_store". diff --git a/docs/api/managed/interfaces/DreamSessionsInput.md b/docs/api/managed/interfaces/DreamSessionsInput.md new file mode 100644 index 0000000..d5be13f --- /dev/null +++ b/docs/api/managed/interfaces/DreamSessionsInput.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamSessionsInput + +# Interface: DreamSessionsInput + +Input session transcripts the dream reads. + +## Properties + +### session\_ids + +> **session\_ids**: `string`[] + +*** + +### type + +> **type**: `"sessions"` + +Any of "sessions". diff --git a/docs/api/managed/interfaces/DreamSessionsInputParam.md b/docs/api/managed/interfaces/DreamSessionsInputParam.md new file mode 100644 index 0000000..6f33697 --- /dev/null +++ b/docs/api/managed/interfaces/DreamSessionsInputParam.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamSessionsInputParam + +# Interface: DreamSessionsInputParam + +Input session transcripts the dream reads. + +## Properties + +### session\_ids + +> **session\_ids**: `string`[] + +*** + +### type + +> **type**: `"sessions"` + +Any of "sessions". diff --git a/docs/api/managed/interfaces/DreamUsage.md b/docs/api/managed/interfaces/DreamUsage.md new file mode 100644 index 0000000..eb0ea25 --- /dev/null +++ b/docs/api/managed/interfaces/DreamUsage.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamUsage + +# Interface: DreamUsage + +Cumulative token usage for the dream across every pipeline stage. + +## Properties + +### cache\_creation\_input\_tokens + +> **cache\_creation\_input\_tokens**: `number` + +Total tokens used to create prompt-cache entries (sum of all TTL tiers). + +*** + +### cache\_read\_input\_tokens + +> **cache\_read\_input\_tokens**: `number` + +Total tokens read from prompt cache. + +*** + +### input\_tokens + +> **input\_tokens**: `number` + +Total uncached input tokens consumed across every pipeline stage. + +*** + +### output\_tokens + +> **output\_tokens**: `number` + +Total output tokens generated across every pipeline stage. diff --git a/docs/api/managed/interfaces/EffortCapability.md b/docs/api/managed/interfaces/EffortCapability.md new file mode 100644 index 0000000..7f3452c --- /dev/null +++ b/docs/api/managed/interfaces/EffortCapability.md @@ -0,0 +1,57 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EffortCapability + +# Interface: EffortCapability + +Effort (reasoning_effort) capability details. + +## Properties + +### high + +> **high**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports high effort level. + +*** + +### low + +> **low**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports low effort level. + +*** + +### max + +> **max**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports max effort level. + +*** + +### medium + +> **medium**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports medium effort level. + +*** + +### supported + +> **supported**: `boolean` + +Whether this capability is supported by the model. + +*** + +### xhigh + +> **xhigh**: [`CapabilitySupport`](CapabilitySupport.md) + +Indicates whether a capability is supported. diff --git a/docs/api/managed/interfaces/EncryptedCodeExecutionResultBlockParam.md b/docs/api/managed/interfaces/EncryptedCodeExecutionResultBlockParam.md new file mode 100644 index 0000000..99c2152 --- /dev/null +++ b/docs/api/managed/interfaces/EncryptedCodeExecutionResultBlockParam.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EncryptedCodeExecutionResultBlockParam + +# Interface: EncryptedCodeExecutionResultBlockParam + +Code execution result with encrypted stdout for PFC + web_search results. + +## Properties + +### content + +> **content**: [`CodeExecutionOutputBlockParam`](CodeExecutionOutputBlockParam.md)[] + +*** + +### encrypted\_stdout + +> **encrypted\_stdout**: `string` + +*** + +### return\_code + +> **return\_code**: `number` + +*** + +### stderr + +> **stderr**: `string` + +*** + +### type? + +> `optional` **type?**: `"encrypted_code_execution_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"encrypted_code_execution_result". diff --git a/docs/api/managed/interfaces/Environment.md b/docs/api/managed/interfaces/Environment.md new file mode 100644 index 0000000..05da139 --- /dev/null +++ b/docs/api/managed/interfaces/Environment.md @@ -0,0 +1,90 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Environment + +# Interface: Environment + +Unified Environment resource for both cloud and self-hosted environments. + +## Properties + +### archived\_at + +> **archived\_at**: `string` \| `null` + +RFC 3339 timestamp when environment was archived, or null if not archived + +*** + +### config + +> **config**: [`EnvironmentConfigUnion`](../type-aliases/EnvironmentConfigUnion.md) + +Environment configuration (either Qoder Cloud or self-hosted) + +*** + +### created\_at + +> **created\_at**: `string` + +RFC 3339 timestamp when environment was created + +*** + +### description + +> **description**: `string` + +User-provided description for the environment; null when unset + +*** + +### id + +> **id**: `string` + +Environment identifier (e.g., 'env\_...') + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `string`\> + +User-provided metadata key-value pairs + +*** + +### name + +> **name**: `string` + +Human-readable name for the environment + +*** + +### scope? + +> `optional` **scope?**: [`EnvironmentScope`](../type-aliases/EnvironmentScope.md) + +The visibility scope for this environment. 'organization' means visible to all +accounts. 'account' means visible only to the owning account. + +Any of "organization", "account". + +*** + +### type? + +> `optional` **type?**: `"environment"` + +The type of object (always 'environment') + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentArchiveParams.md b/docs/api/managed/interfaces/EnvironmentArchiveParams.md new file mode 100644 index 0000000..db00459 --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentArchiveParams + +# Interface: EnvironmentArchiveParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentDeleteParams.md b/docs/api/managed/interfaces/EnvironmentDeleteParams.md new file mode 100644 index 0000000..3c34c8a --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentDeleteParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentDeleteParams + +# Interface: EnvironmentDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentDeleteResponse.md b/docs/api/managed/interfaces/EnvironmentDeleteResponse.md new file mode 100644 index 0000000..725a67c --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentDeleteResponse.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentDeleteResponse + +# Interface: EnvironmentDeleteResponse + +Response after deleting an environment. + +## Properties + +### id + +> **id**: `string` + +Environment identifier + +*** + +### type + +> **type**: `"environment_deleted"` + +The type of response + +Any of "environment_deleted". diff --git a/docs/api/managed/interfaces/EnvironmentGetParams.md b/docs/api/managed/interfaces/EnvironmentGetParams.md new file mode 100644 index 0000000..4f35151 --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentGetParams + +# Interface: EnvironmentGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentListParams.md b/docs/api/managed/interfaces/EnvironmentListParams.md new file mode 100644 index 0000000..84376fa --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentListParams.md @@ -0,0 +1,58 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentListParams + +# Interface: EnvironmentListParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### created\_at\[gte\]? + +> `optional` **created\_at\[gte\]?**: `string` + +*** + +### created\_at\[lte\]? + +> `optional` **created\_at\[lte\]?**: `string` + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` + +Include archived environments in the response + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum number of environments to return + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque cursor from previous response for pagination. Pass the `next_page` value +from the previous response. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentNewParams.md b/docs/api/managed/interfaces/EnvironmentNewParams.md new file mode 100644 index 0000000..a06ec6d --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentNewParams.md @@ -0,0 +1,66 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentNewParams + +# Interface: EnvironmentNewParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### config? + +> `optional` **config?**: [`EnvironmentNewParamsConfigUnion`](../type-aliases/EnvironmentNewParamsConfigUnion.md) \| `null` + +Environment configuration + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +Optional description of the environment + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +User-provided metadata key-value pairs + +*** + +### name + +> **name**: `string` + +Human-readable name for the environment + +*** + +### scope? + +> `optional` **scope?**: [`EnvironmentNewParamsScope`](../type-aliases/EnvironmentNewParamsScope.md) \| `null` + +The visibility scope for this environment. 'organization' makes the environment +visible to all accounts. 'account' restricts visibility to the owning account +only. Only applicable for self-hosted environments. If not specified, defaults +based on organization type. + +Any of "organization", "account". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentUpdateParams.md b/docs/api/managed/interfaces/EnvironmentUpdateParams.md new file mode 100644 index 0000000..1f9f50e --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentUpdateParams.md @@ -0,0 +1,67 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentUpdateParams + +# Interface: EnvironmentUpdateParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### config? + +> `optional` **config?**: [`EnvironmentUpdateParamsConfigUnion`](../type-aliases/EnvironmentUpdateParamsConfigUnion.md) \| `null` + +Updated environment configuration + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +Updated description of the environment. Omit to preserve; null clears to null; +an empty string is stored as an empty string. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +User-provided metadata key-value pairs. Set a value to null or empty string to +delete the key. + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +Updated name for the environment + +*** + +### scope? + +> `optional` **scope?**: [`EnvironmentUpdateParamsScope`](../type-aliases/EnvironmentUpdateParamsScope.md) \| `null` + +The visibility scope for this environment. 'organization' makes the environment +visible to all accounts. 'account' restricts visibility to the owning account +only. + +Any of "organization", "account". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentWorkAckParams.md b/docs/api/managed/interfaces/EnvironmentWorkAckParams.md new file mode 100644 index 0000000..344c3fd --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentWorkAckParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentWorkAckParams + +# Interface: EnvironmentWorkAckParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### environment\_id + +> **environment\_id**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentWorkGetParams.md b/docs/api/managed/interfaces/EnvironmentWorkGetParams.md new file mode 100644 index 0000000..291e095 --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentWorkGetParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentWorkGetParams + +# Interface: EnvironmentWorkGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### environment\_id + +> **environment\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentWorkHeartbeatParams.md b/docs/api/managed/interfaces/EnvironmentWorkHeartbeatParams.md new file mode 100644 index 0000000..b23e37d --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentWorkHeartbeatParams.md @@ -0,0 +1,40 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentWorkHeartbeatParams + +# Interface: EnvironmentWorkHeartbeatParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### desired\_ttl\_seconds? + +> `optional` **desired\_ttl\_seconds?**: `number` + +Desired TTL in seconds + +*** + +### environment\_id + +> **environment\_id**: `string` + +*** + +### expected\_last\_heartbeat? + +> `optional` **expected\_last\_heartbeat?**: `string` + +Expected last_heartbeat for conditional update (optimistic concurrency). Use +literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For +subsequent heartbeats, echo the server's previous last_heartbeat value exactly. +Returns 412 Precondition Failed if the actual value doesn't match. diff --git a/docs/api/managed/interfaces/EnvironmentWorkListParams.md b/docs/api/managed/interfaces/EnvironmentWorkListParams.md new file mode 100644 index 0000000..8eac332 --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentWorkListParams.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentWorkListParams + +# Interface: EnvironmentWorkListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum number of work items to return + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque cursor from previous response for pagination diff --git a/docs/api/managed/interfaces/EnvironmentWorkPollParams.md b/docs/api/managed/interfaces/EnvironmentWorkPollParams.md new file mode 100644 index 0000000..67dddd1 --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentWorkPollParams.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentWorkPollParams + +# Interface: EnvironmentWorkPollParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### block\_ms? + +> `optional` **block\_ms?**: `number` + +How long to wait for work to arrive before returning. Must be 1-999 in +milliseconds. Defaults to non-blocking (returns immediately if no work is +available). + +*** + +### qoder\_worker\_id? + +> `optional` **qoder\_worker\_id?**: `string` + +Unique identifier for the specific worker polling, used to track aggregated +environment-level work metrics in Console + +*** + +### reclaim\_older\_than\_ms? + +> `optional` **reclaim\_older\_than\_ms?**: `number` + +Reclaim unacknowledged work items older than this many milliseconds. If omitted, +uses the default (5000ms). diff --git a/docs/api/managed/interfaces/EnvironmentWorkStatsParams.md b/docs/api/managed/interfaces/EnvironmentWorkStatsParams.md new file mode 100644 index 0000000..84bbd20 --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentWorkStatsParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentWorkStatsParams + +# Interface: EnvironmentWorkStatsParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentWorkStopParams.md b/docs/api/managed/interfaces/EnvironmentWorkStopParams.md new file mode 100644 index 0000000..9f1c324 --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentWorkStopParams.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentWorkStopParams + +# Interface: EnvironmentWorkStopParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### environment\_id + +> **environment\_id**: `string` + +*** + +### force? + +> `optional` **force?**: `boolean` \| `null` + +If true, immediately stop work without graceful shutdown + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/EnvironmentWorkUpdateParams.md b/docs/api/managed/interfaces/EnvironmentWorkUpdateParams.md new file mode 100644 index 0000000..d966e15 --- /dev/null +++ b/docs/api/managed/interfaces/EnvironmentWorkUpdateParams.md @@ -0,0 +1,36 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentWorkUpdateParams + +# Interface: EnvironmentWorkUpdateParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### environment\_id + +> **environment\_id**: `string` + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +Metadata patch. Set a key to a string to upsert it, or to null to delete it. +Omit the field to preserve existing metadata. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/FallbackBlockParam.md b/docs/api/managed/interfaces/FallbackBlockParam.md new file mode 100644 index 0000000..b13d639 --- /dev/null +++ b/docs/api/managed/interfaces/FallbackBlockParam.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FallbackBlockParam + +# Interface: FallbackBlockParam + +A `fallback` block echoed back from a prior response. + +Accepted in `messages[].content` and not rendered into the prompt; not validated +against the request's `fallbacks` chain or top-level `model`. + +Echo the assistant turn back verbatim, including this block in its original +position. The block marks the boundary between content produced before and after +a fallback hop, and the server relies on that boundary to validate the turn: +when thinking runs flank the boundary, omitting the block merges them into one +span the server cannot validate (the request is rejected), and moving it into +the middle of a single run is likewise rejected; between non-thinking blocks the +block's placement has no validation effect. + +## Properties + +### from + +> **from**: [`FallbackInfoParam`](FallbackInfoParam.md) + +Identifies one hop of a fallback transition. + +*** + +### to + +> **to**: [`FallbackInfoParam`](FallbackInfoParam.md) + +Identifies one hop of a fallback transition. + +*** + +### trigger? + +> `optional` **trigger?**: `unknown` + +The response block's `trigger`, echoed verbatim. Accepted and ignored by the +server; any object or `null` is allowed. + +*** + +### type? + +> `optional` **type?**: `"fallback"` \| `null` + +This field can be elided, and will marshal its zero value as "fallback". diff --git a/docs/api/managed/interfaces/FallbackInfoParam.md b/docs/api/managed/interfaces/FallbackInfoParam.md new file mode 100644 index 0000000..19ba824 --- /dev/null +++ b/docs/api/managed/interfaces/FallbackInfoParam.md @@ -0,0 +1,20 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FallbackInfoParam + +# Interface: FallbackInfoParam + +Identifies one hop of a fallback transition. + +## Properties + +### model + +> **model**: `string` + +The model that will complete your prompt. + +See [models](https://docs.qoder.com/cloud-agents/api/models/list) for additional +details and options. diff --git a/docs/api/managed/interfaces/FileDeleteParams.md b/docs/api/managed/interfaces/FileDeleteParams.md new file mode 100644 index 0000000..e4a05c2 --- /dev/null +++ b/docs/api/managed/interfaces/FileDeleteParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FileDeleteParams + +# Interface: FileDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/FileDocumentSourceParam.md b/docs/api/managed/interfaces/FileDocumentSourceParam.md new file mode 100644 index 0000000..c01d0a4 --- /dev/null +++ b/docs/api/managed/interfaces/FileDocumentSourceParam.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FileDocumentSourceParam + +# Interface: FileDocumentSourceParam + +The properties FileID, Type are required. + +## Properties + +### file\_id + +> **file\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"file"` \| `null` + +This field can be elided, and will marshal its zero value as "file". diff --git a/docs/api/managed/interfaces/FileDownloadParams.md b/docs/api/managed/interfaces/FileDownloadParams.md new file mode 100644 index 0000000..d393c59 --- /dev/null +++ b/docs/api/managed/interfaces/FileDownloadParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FileDownloadParams + +# Interface: FileDownloadParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/FileGetMetadataParams.md b/docs/api/managed/interfaces/FileGetMetadataParams.md new file mode 100644 index 0000000..608eda1 --- /dev/null +++ b/docs/api/managed/interfaces/FileGetMetadataParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FileGetMetadataParams + +# Interface: FileGetMetadataParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/FileImageSourceParam.md b/docs/api/managed/interfaces/FileImageSourceParam.md new file mode 100644 index 0000000..8eb5300 --- /dev/null +++ b/docs/api/managed/interfaces/FileImageSourceParam.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FileImageSourceParam + +# Interface: FileImageSourceParam + +The properties FileID, Type are required. + +## Properties + +### file\_id + +> **file\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"file"` \| `null` + +This field can be elided, and will marshal its zero value as "file". diff --git a/docs/api/managed/interfaces/FileListParams.md b/docs/api/managed/interfaces/FileListParams.md new file mode 100644 index 0000000..06bed34 --- /dev/null +++ b/docs/api/managed/interfaces/FileListParams.md @@ -0,0 +1,79 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FileListParams + +# Interface: FileListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### ids? + +> `optional` **ids?**: `string`[] + +Restrict the result set to Files whose `id` is in this list. At most 100 entries +(after de-duplication). Mutually exclusive with `page` and `limit`. When +supplied, the response is always a single page (`next_page` is null). IDs that +do not resolve to a visible File — including deleted Files — are silently +omitted. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Number of items to return per page. + +Defaults to `20`. Ranges from `1` to `1000`. + +*** + +### name? + +> `optional` **name?**: `string` + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque page cursor returned in a prior list response's `next_page`. Prefixed +`page_`. + +*** + +### scope\_id? + +> `optional` **scope\_id?**: `string` + +Filter by scope ID. Only returns files associated with the specified scope +(e.g., a session ID). + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/FileMetadata.md b/docs/api/managed/interfaces/FileMetadata.md new file mode 100644 index 0000000..edabca3 --- /dev/null +++ b/docs/api/managed/interfaces/FileMetadata.md @@ -0,0 +1,98 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FileMetadata + +# Interface: FileMetadata + +## Properties + +### created\_at + +> **created\_at**: `string` + +RFC 3339 datetime string representing when the file was created. + +*** + +### downloadable? + +> `optional` **downloadable?**: `boolean` + +Whether the file can be downloaded. + +*** + +### expires\_at? + +> `optional` **expires\_at?**: `string` \| `null` + +RFC 3339 datetime string representing when the file will expire and become +unavailable for download. Null if the file does not expire. For files uploaded +with `expires_in_seconds`, this is the upload time plus that value. + +*** + +### filename + +> **filename**: `string` + +Original filename of the uploaded file. + +*** + +### id + +> **id**: `string` + +Unique object identifier. + +The format and length of IDs may change over time. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> + +*** + +### mime\_type + +> **mime\_type**: `string` + +MIME type of the file. + +*** + +### scope? + +> `optional` **scope?**: [`FileScope`](FileScope.md) \| `null` + +The scope of this file, indicating the context in which it was created (e.g., a +session). + +*** + +### size\_bytes + +> **size\_bytes**: `number` + +Size of the file in bytes. + +*** + +### status? + +> `optional` **status?**: `string` + +*** + +### type? + +> `optional` **type?**: `"file"` + +Object type. + +For files, this is always `"file"`. diff --git a/docs/api/managed/interfaces/FileScope.md b/docs/api/managed/interfaces/FileScope.md new file mode 100644 index 0000000..62ccf5e --- /dev/null +++ b/docs/api/managed/interfaces/FileScope.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FileScope + +# Interface: FileScope + +## Properties + +### id + +> **id**: `string` + +The ID of the scoping resource (e.g., the session ID). + +*** + +### type? + +> `optional` **type?**: `"session"` + +The type of scope (e.g., `"session"`). diff --git a/docs/api/managed/interfaces/FileUploadParams.md b/docs/api/managed/interfaces/FileUploadParams.md new file mode 100644 index 0000000..0d0848e --- /dev/null +++ b/docs/api/managed/interfaces/FileUploadParams.md @@ -0,0 +1,52 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / FileUploadParams + +# Interface: FileUploadParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### expires\_in\_seconds? + +> `optional` **expires\_in\_seconds?**: `number` \| `null` + +Seconds from upload until the file expires and its bytes become permanently +unavailable. Must be between 3600 (one hour) and 7776000 (ninety days). + +*** + +### file + +> **file**: [`Uploadable`](../../index/type-aliases/Uploadable.md) + +The file to upload. Only the final path component of the part's `filename` is +kept; an absent or empty `filename` is replaced with `unnamed` plus the +extension for the file's stored `mime_type`, when known. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/HealthCheckWorkData.md b/docs/api/managed/interfaces/HealthCheckWorkData.md new file mode 100644 index 0000000..3b72798 --- /dev/null +++ b/docs/api/managed/interfaces/HealthCheckWorkData.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / HealthCheckWorkData + +# Interface: HealthCheckWorkData + +Work data for environment health checks. + +This resource type is used for assessing the health of containers where work +occurs. The data is opaque to users; the runner handles the health check by +probing connectivity to required services. + +## Properties + +### id + +> **id**: `string` + +Health check identifier + +*** + +### type? + +> `optional` **type?**: `"healthcheck"` + +Type of work data + +Any of "healthcheck". diff --git a/docs/api/managed/interfaces/ImageBlockParam.md b/docs/api/managed/interfaces/ImageBlockParam.md new file mode 100644 index 0000000..cba3ce8 --- /dev/null +++ b/docs/api/managed/interfaces/ImageBlockParam.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ImageBlockParam + +# Interface: ImageBlockParam + +The properties Source, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### source + +> **source**: [`ImageBlockParamSourceUnion`](../type-aliases/ImageBlockParamSourceUnion.md) + +*** + +### transformations? + +> `optional` **transformations?**: [`ImageTransformationsParam`](ImageTransformationsParam.md) \| `null` + +Configures the transformations the server applies to this image before the model +observes it. Each key names a condition the server transforms images for; its +value selects the transformation applied. Omitted keys keep their default +behavior, and an empty object is equivalent to omitting the field. + +*** + +### type? + +> `optional` **type?**: `"image"` \| `null` + +This field can be elided, and will marshal its zero value as "image". diff --git a/docs/api/managed/interfaces/ImageTransformationsParam.md b/docs/api/managed/interfaces/ImageTransformationsParam.md new file mode 100644 index 0000000..541e19c --- /dev/null +++ b/docs/api/managed/interfaces/ImageTransformationsParam.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ImageTransformationsParam + +# Interface: ImageTransformationsParam + +Configures the transformations the server applies to this image before the model +observes it. Each key names a condition the server transforms images for; its +value selects the transformation applied. Omitted keys keep their default +behavior, and an empty object is equivalent to omitting the field. + +## Properties + +### oversized\_image? + +> `optional` **oversized\_image?**: `string` \| `null` + +What the server does when this image exceeds the model's maximum image size. +`"downsize"` (the default) scales the image down to fit, which changes the +dimensions the model observes without telling you. `"error"` instead rejects the +request with a 400 error naming the image's dimensions and the largest +dimensions that fit, so you can scale the image deliberately — your image is +never silently scaled down. + +Any of "downsize", "error". diff --git a/docs/api/managed/interfaces/LimitedNetwork.md b/docs/api/managed/interfaces/LimitedNetwork.md new file mode 100644 index 0000000..a127d58 --- /dev/null +++ b/docs/api/managed/interfaces/LimitedNetwork.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / LimitedNetwork + +# Interface: LimitedNetwork + +Limited network access. + +## Properties + +### allow\_mcp\_servers + +> **allow\_mcp\_servers**: `boolean` + +Permits outbound access to MCP server endpoints configured on the agent, beyond +those listed in the `allowed_hosts` array. + +*** + +### allow\_package\_managers + +> **allow\_package\_managers**: `boolean` + +Permits outbound access to public package registries (PyPI, npm, etc.) beyond +those listed in the `allowed_hosts` array. + +*** + +### allowed\_hosts + +> **allowed\_hosts**: `string`[] + +Specifies domains the container can reach. + +*** + +### type? + +> `optional` **type?**: `"limited"` + +Network policy type diff --git a/docs/api/managed/interfaces/LimitedNetworkParams.md b/docs/api/managed/interfaces/LimitedNetworkParams.md new file mode 100644 index 0000000..43d4f6f --- /dev/null +++ b/docs/api/managed/interfaces/LimitedNetworkParams.md @@ -0,0 +1,48 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / LimitedNetworkParams + +# Interface: LimitedNetworkParams + +Limited network request params. + +Fields default to null; on update, omitted fields preserve the existing value. + +## Properties + +### allow\_mcp\_servers? + +> `optional` **allow\_mcp\_servers?**: `boolean` \| `null` + +Permits outbound access to MCP server endpoints configured on the agent, beyond +those listed in the `allowed_hosts` array. Defaults to `false`. + +*** + +### allow\_package\_managers? + +> `optional` **allow\_package\_managers?**: `boolean` \| `null` + +Permits outbound access to public package registries (PyPI, npm, etc.) beyond +those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must +be `true` when `packages` are specified. + +*** + +### allowed\_hosts? + +> `optional` **allowed\_hosts?**: `string`[] \| `null` + +Specifies domains the container can reach. + +*** + +### type? + +> `optional` **type?**: `"limited"` \| `null` + +Network policy type + +This field can be elided, and will marshal its zero value as "limited". diff --git a/docs/api/managed/interfaces/MCPToolUseBlockParam.md b/docs/api/managed/interfaces/MCPToolUseBlockParam.md new file mode 100644 index 0000000..c9eca71 --- /dev/null +++ b/docs/api/managed/interfaces/MCPToolUseBlockParam.md @@ -0,0 +1,51 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MCPToolUseBlockParam + +# Interface: MCPToolUseBlockParam + +The properties ID, Input, Name, ServerName, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### id + +> **id**: `string` + +*** + +### input + +> **input**: `unknown` + +*** + +### name + +> **name**: `string` + +*** + +### server\_name + +> **server\_name**: `string` + +The name of the MCP server + +*** + +### type? + +> `optional` **type?**: `"mcp_tool_use"` \| `null` + +This field can be elided, and will marshal its zero value as "mcp_tool_use". diff --git a/docs/api/managed/interfaces/ManagedAgentsAPIActor.md b/docs/api/managed/interfaces/ManagedAgentsAPIActor.md new file mode 100644 index 0000000..1c7598f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAPIActor.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAPIActor + +# Interface: ManagedAgentsAPIActor + +Attribution for a write made directly via the public API (outside of any +session). + +## Properties + +### api\_key\_id + +> **api\_key\_id**: `string` + +ID of the API key that performed the write. This identifies the key, not the +secret. + +*** + +### type + +> **type**: `"api_actor"` + +Any of "api_actor". diff --git a/docs/api/managed/interfaces/ManagedAgentsAdvisor.md b/docs/api/managed/interfaces/ManagedAgentsAdvisor.md new file mode 100644 index 0000000..60d20e0 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAdvisor.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAdvisor + +# Interface: ManagedAgentsAdvisor + +Platform advisor roster entry: a model the session's primary thread may consult +mid-turn. + +## Properties + +### model + +> **model**: `string` + +The advisor model id. + +*** + +### type + +> **type**: `"advisor"` + +Any of "advisor". diff --git a/docs/api/managed/interfaces/ManagedAgentsAdvisorParams.md b/docs/api/managed/interfaces/ManagedAgentsAdvisorParams.md new file mode 100644 index 0000000..4042341 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAdvisorParams.md @@ -0,0 +1,28 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAdvisorParams + +# Interface: ManagedAgentsAdvisorParams + +Platform advisor roster entry: a model the session's primary thread may consult +mid-turn. At most one per roster; the entry occupies the roster name +`qoder.advisor`. + +## Properties + +### model + +> **model**: `string` + +A Claude model id. The model must be permitted as an advisor for this agent's +model — see the sessions/threads/advisor spec. + +*** + +### type + +> **type**: `"advisor"` + +Any of "advisor". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgent.md b/docs/api/managed/interfaces/ManagedAgentsAgent.md new file mode 100644 index 0000000..a379a39 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgent.md @@ -0,0 +1,114 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgent + +# Interface: ManagedAgentsAgent + +A Managed Agents `agent`. + +## Properties + +### archived\_at + +> **archived\_at**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### description + +> **description**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### mcp\_servers + +> **mcp\_servers**: [`ManagedAgentsMCPServerURLDefinition`](ManagedAgentsMCPServerURLDefinition.md)[] + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `string`\> + +*** + +### model + +> **model**: [`ManagedAgentsModelConfig`](../type-aliases/ManagedAgentsModelConfig.md) + +Model identifier and configuration. + +*** + +### multiagent + +> **multiagent**: [`ManagedAgentsMultiagent`](ManagedAgentsMultiagent.md) \| `null` + +Resolved coordinator topology with a concrete agent roster. + +*** + +### name + +> **name**: `string` + +*** + +### skills + +> **skills**: [`ManagedAgentsAgentSkillUnion`](../type-aliases/ManagedAgentsAgentSkillUnion.md)[] + +*** + +### system + +> **system**: `string` + +*** + +### tools + +> **tools**: [`ManagedAgentsAgentToolUnion`](../type-aliases/ManagedAgentsAgentToolUnion.md)[] + +*** + +### type + +> **type**: `"agent"` + +Any of "agent". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### version + +> **version**: `number` + +The agent's current version. Starts at 1 and increments when the agent is +modified. diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentArchivedDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsAgentArchivedDeploymentPausedReasonError.md new file mode 100644 index 0000000..0f98ba5 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentArchivedDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentArchivedDeploymentPausedReasonError + +# Interface: ManagedAgentsAgentArchivedDeploymentPausedReasonError + +The deployment's agent was archived. + +## Properties + +### type + +> **type**: `"agent_archived_error"` + +Any of "agent_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentArchivedRunError.md b/docs/api/managed/interfaces/ManagedAgentsAgentArchivedRunError.md new file mode 100644 index 0000000..2b65e90 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentArchivedRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentArchivedRunError + +# Interface: ManagedAgentsAgentArchivedRunError + +The deployment's agent was archived. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"agent_archived_error"` + +Any of "agent_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentCustomToolUseEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentCustomToolUseEvent.md new file mode 100644 index 0000000..a1c2596 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentCustomToolUseEvent.md @@ -0,0 +1,60 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentCustomToolUseEvent + +# Interface: ManagedAgentsAgentCustomToolUseEvent + +Event emitted when the agent calls a custom tool. The session goes idle until +the client sends a `user.custom_tool_result` event with the result. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### input + +> **input**: `Record`\<`string`, `unknown`\> + +Input parameters for the tool call. + +*** + +### name + +> **name**: `string` + +Name of the custom tool being called. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id? + +> `optional` **session\_thread\_id?**: `string` \| `null` + +When set, this event was cross-posted from a subagent's thread to surface its +custom tool use on the primary thread's stream. Empty on the thread's own +events. Echo this on a `user.custom_tool_result` event to route the result back. + +*** + +### type + +> **type**: `"agent.custom_tool_use"` + +Any of "agent.custom_tool_use". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentMCPToolResultEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentMCPToolResultEvent.md new file mode 100644 index 0000000..307b9ac --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentMCPToolResultEvent.md @@ -0,0 +1,57 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMCPToolResultEvent + +# Interface: ManagedAgentsAgentMCPToolResultEvent + +Event representing the result of an MCP tool execution. + +## Properties + +### content? + +> `optional` **content?**: [`ManagedAgentsAgentMCPToolResultEventContentUnion`](../type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnion.md)[] + +The result content returned by the tool. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### is\_error? + +> `optional` **is\_error?**: `boolean` \| `null` + +Whether the tool execution resulted in an error. + +*** + +### mcp\_tool\_use\_id + +> **mcp\_tool\_use\_id**: `string` + +The id of the `agent.mcp_tool_use` event this result corresponds to. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"agent.mcp_tool_result"` + +Any of "agent.mcp_tool_result". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentMCPToolUseEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentMCPToolUseEvent.md new file mode 100644 index 0000000..5d6ead0 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentMCPToolUseEvent.md @@ -0,0 +1,78 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMCPToolUseEvent + +# Interface: ManagedAgentsAgentMCPToolUseEvent + +Event emitted when the agent invokes a tool provided by an MCP server. + +## Properties + +### evaluated\_permission? + +> `optional` **evaluated\_permission?**: [`ManagedAgentsAgentMCPToolUseEventEvaluatedPermission`](../type-aliases/ManagedAgentsAgentMCPToolUseEventEvaluatedPermission.md) + +AgentEvaluatedPermission enum + +Any of "allow", "ask", "deny". + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### input + +> **input**: `Record`\<`string`, `unknown`\> + +Input parameters for the tool call. + +*** + +### mcp\_server\_name + +> **mcp\_server\_name**: `string` + +Name of the MCP server providing the tool. + +*** + +### name + +> **name**: `string` + +Name of the MCP tool being used. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id? + +> `optional` **session\_thread\_id?**: `string` \| `null` + +When set, this event was cross-posted from a subagent's thread to surface its +permission request on the primary thread's stream. Empty on the thread's own +events. Echo this on a `user.tool_confirmation` event to route the approval +back. + +*** + +### type + +> **type**: `"agent.mcp_tool_use"` + +Any of "agent.mcp_tool_use". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentMessageEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentMessageEvent.md new file mode 100644 index 0000000..9cd1122 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentMessageEvent.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMessageEvent + +# Interface: ManagedAgentsAgentMessageEvent + +An agent response event in the session conversation. + +## Properties + +### content + +> **content**: [`ManagedAgentsAgentMessageEventContentUnion`](../type-aliases/ManagedAgentsAgentMessageEventContentUnion.md)[] + +Array of text blocks comprising the agent response. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"agent.message"` + +Any of "agent.message". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentMessagePreview.md b/docs/api/managed/interfaces/ManagedAgentsAgentMessagePreview.md new file mode 100644 index 0000000..382a23d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentMessagePreview.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMessagePreview + +# Interface: ManagedAgentsAgentMessagePreview + +## Properties + +### id + +> **id**: `string` + +The id the buffered agent.message will carry if it is emitted. Matches the +event_id on this preview's event_delta events. + +*** + +### type + +> **type**: `"agent.message"` + +Any of "agent.message". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentParams.md b/docs/api/managed/interfaces/ManagedAgentsAgentParams.md new file mode 100644 index 0000000..ac63bbd --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentParams.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentParams + +# Interface: ManagedAgentsAgentParams + +Specification for an Agent. Provide a specific `version` or use the short-form +`agent="agent_id"` for the most recent version + +## Properties + +### id + +> **id**: `string` + +The `agent` ID. + +*** + +### type + +> **type**: `"agent"` + +Any of "agent". + +*** + +### version? + +> `optional` **version?**: `number` \| `null` + +The specific `agent` version to use. Omit to use the latest version. Must be at +least 1 if specified. diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentReference.md b/docs/api/managed/interfaces/ManagedAgentsAgentReference.md new file mode 100644 index 0000000..1056690 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentReference.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentReference + +# Interface: ManagedAgentsAgentReference + +A resolved agent reference with a concrete version. + +## Properties + +### id + +> **id**: `string` + +*** + +### type + +> **type**: `"agent"` + +Any of "agent". + +*** + +### version + +> **version**: `number` diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentThinkingEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentThinkingEvent.md new file mode 100644 index 0000000..1e347fb --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentThinkingEvent.md @@ -0,0 +1,34 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThinkingEvent + +# Interface: ManagedAgentsAgentThinkingEvent + +Indicates the agent is making forward progress via extended thinking. A progress +signal, not a content carrier. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"agent.thinking"` + +Any of "agent.thinking". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentThinkingPreview.md b/docs/api/managed/interfaces/ManagedAgentsAgentThinkingPreview.md new file mode 100644 index 0000000..c556656 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentThinkingPreview.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThinkingPreview + +# Interface: ManagedAgentsAgentThinkingPreview + +## Properties + +### id + +> **id**: `string` + +The id the buffered agent.thinking will carry if it is emitted. Start-only — no +event_delta events follow. + +*** + +### type + +> **type**: `"agent.thinking"` + +Any of "agent.thinking". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentThreadContextCompactedEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentThreadContextCompactedEvent.md new file mode 100644 index 0000000..0792eed --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentThreadContextCompactedEvent.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadContextCompactedEvent + +# Interface: ManagedAgentsAgentThreadContextCompactedEvent + +Indicates that context compaction (summarization) occurred during the session. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"agent.thread_context_compacted"` + +Any of "agent.thread_context_compacted". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageReceivedEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageReceivedEvent.md new file mode 100644 index 0000000..0468da9 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageReceivedEvent.md @@ -0,0 +1,59 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadMessageReceivedEvent + +# Interface: ManagedAgentsAgentThreadMessageReceivedEvent + +Delivery event written to the target thread's input stream when an +agent-to-agent message arrives. + +## Properties + +### content + +> **content**: [`ManagedAgentsAgentThreadMessageReceivedEventContentUnion`](../type-aliases/ManagedAgentsAgentThreadMessageReceivedEventContentUnion.md)[] + +Message content blocks. + +*** + +### from\_agent\_name? + +> `optional` **from\_agent\_name?**: `string` \| `null` + +Name of the callable agent this message came from. Absent when received from the +primary agent. + +*** + +### from\_session\_thread\_id + +> **from\_session\_thread\_id**: `string` + +Public `sthr_` ID of the thread that sent the message. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"agent.thread_message_received"` + +Any of "agent.thread_message_received". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageReceivedEventContentUnionSource.md b/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageReceivedEventContentUnionSource.md new file mode 100644 index 0000000..122dac9 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageReceivedEventContentUnionSource.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadMessageReceivedEventContentUnionSource + +# Interface: ManagedAgentsAgentThreadMessageReceivedEventContentUnionSource + +## Properties + +### data? + +> `optional` **data?**: `string` + +*** + +### file\_id? + +> `optional` **file\_id?**: `string` + +*** + +### media\_type? + +> `optional` **media\_type?**: `string` + +*** + +### type? + +> `optional` **type?**: `string` + +*** + +### url? + +> `optional` **url?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageSentEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageSentEvent.md new file mode 100644 index 0000000..dd03cd5 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageSentEvent.md @@ -0,0 +1,59 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadMessageSentEvent + +# Interface: ManagedAgentsAgentThreadMessageSentEvent + +Observability event emitted to the sender's output stream when an agent-to-agent +message is sent. + +## Properties + +### content + +> **content**: [`ManagedAgentsAgentThreadMessageSentEventContentUnion`](../type-aliases/ManagedAgentsAgentThreadMessageSentEventContentUnion.md)[] + +Message content blocks. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### to\_agent\_name? + +> `optional` **to\_agent\_name?**: `string` \| `null` + +Name of the callable agent this message was sent to. Absent when sent to the +primary agent. + +*** + +### to\_session\_thread\_id + +> **to\_session\_thread\_id**: `string` + +Public `sthr_` ID of the thread the message was sent to. + +*** + +### type + +> **type**: `"agent.thread_message_sent"` + +Any of "agent.thread_message_sent". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageSentEventContentUnionSource.md b/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageSentEventContentUnionSource.md new file mode 100644 index 0000000..c57a462 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentThreadMessageSentEventContentUnionSource.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadMessageSentEventContentUnionSource + +# Interface: ManagedAgentsAgentThreadMessageSentEventContentUnionSource + +ManagedAgentsAgentThreadMessageSentEventContentUnionSource is an implicit +subunion of `ManagedAgentsAgentThreadMessageSentEventContentUnion`. +ManagedAgentsAgentThreadMessageSentEventContentUnionSource provides +convenient access to the sub-properties of the union. + +## Properties + +### data? + +> `optional` **data?**: `string` + +*** + +### file\_id? + +> `optional` **file\_id?**: `string` + +*** + +### media\_type? + +> `optional` **media\_type?**: `string` + +*** + +### type? + +> `optional` **type?**: `string` + +*** + +### url? + +> `optional` **url?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolConfigUnionPermissionPolicy.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolConfigUnionPermissionPolicy.md new file mode 100644 index 0000000..3c54e70 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolConfigUnionPermissionPolicy.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolConfigUnionPermissionPolicy + +# Interface: ManagedAgentsAgentToolConfigUnionPermissionPolicy + +## Properties + +### type? + +> `optional` **type?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolResultEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolResultEvent.md new file mode 100644 index 0000000..cdfafd5 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolResultEvent.md @@ -0,0 +1,57 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolResultEvent + +# Interface: ManagedAgentsAgentToolResultEvent + +Event representing the result of an agent tool execution. + +## Properties + +### content? + +> `optional` **content?**: [`ManagedAgentsAgentToolResultEventContentUnion`](../type-aliases/ManagedAgentsAgentToolResultEventContentUnion.md)[] + +The result content returned by the tool. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### is\_error? + +> `optional` **is\_error?**: `boolean` \| `null` + +Whether the tool execution resulted in an error. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +The id of the `agent.tool_use` event this result corresponds to. + +*** + +### type + +> **type**: `"agent.tool_result"` + +Any of "agent.tool_result". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolUnionDefaultConfig.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolUnionDefaultConfig.md new file mode 100644 index 0000000..4f38f24 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolUnionDefaultConfig.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolUnionDefaultConfig + +# Interface: ManagedAgentsAgentToolUnionDefaultConfig + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy`](ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy.md) + +This field is a union of +`ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion`, +`ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy.md new file mode 100644 index 0000000..7b25b26 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy + +# Interface: ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy + +ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy is an implicit +subunion of `ManagedAgentsAgentToolUnion`. +ManagedAgentsAgentToolUnionDefaultConfigPermissionPolicy provides convenient +access to the sub-properties of the union. + +## Properties + +### type? + +> `optional` **type?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolUseEvent.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolUseEvent.md new file mode 100644 index 0000000..8893bda --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolUseEvent.md @@ -0,0 +1,70 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolUseEvent + +# Interface: ManagedAgentsAgentToolUseEvent + +Event emitted when the agent invokes a built-in agent tool. + +## Properties + +### evaluated\_permission? + +> `optional` **evaluated\_permission?**: [`ManagedAgentsAgentToolUseEventEvaluatedPermission`](../type-aliases/ManagedAgentsAgentToolUseEventEvaluatedPermission.md) + +AgentEvaluatedPermission enum + +Any of "allow", "ask", "deny". + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### input + +> **input**: `Record`\<`string`, `unknown`\> + +Input parameters for the tool call. + +*** + +### name + +> **name**: `string` + +Name of the agent tool being used. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id? + +> `optional` **session\_thread\_id?**: `string` \| `null` + +When set, this event was cross-posted from a subagent's thread to surface its +permission request on the primary thread's stream. Empty on the thread's own +events. Echo this on a `user.tool_confirmation` event to route the approval +back. + +*** + +### type + +> **type**: `"agent.tool_use"` + +Any of "agent.tool_use". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401.md new file mode 100644 index 0000000..cb1b43c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401 + +# Interface: ManagedAgentsAgentToolset20260401 + +## Properties + +### configs + +> **configs**: [`ManagedAgentsAgentToolConfigUnion`](../type-aliases/ManagedAgentsAgentToolConfigUnion.md)[] + +*** + +### default\_config + +> **default\_config**: [`ManagedAgentsAgentToolsetDefaultConfig`](ManagedAgentsAgentToolsetDefaultConfig.md) + +Resolved default configuration for agent tools. + +*** + +### disallowed\_tools? + +> `optional` **disallowed\_tools?**: `string`[] + +*** + +### enabled\_tools? + +> `optional` **enabled\_tools?**: `string`[] + +*** + +### type + +> **type**: `"agent_toolset_20260401"` + +Any of "agent_toolset_20260401". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401BashInput.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401BashInput.md new file mode 100644 index 0000000..6486858 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401BashInput.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401BashInput + +# Interface: ManagedAgentsAgentToolset20260401BashInput + +Input payload for the `bash` tool of the `agent_toolset_20260401` toolset. All +fields are optional; a normal invocation supplies `command`, while +`restart=true` (with no `command`) reboots the runner-side bash session. + +## Properties + +### command? + +> `optional` **command?**: `string` + +Shell command to execute. Omit only when `restart` is true. + +*** + +### restart? + +> `optional` **restart?**: `boolean` + +When true, restart the persistent bash session instead of running a command. +Subsequent calls without `restart` will run against the fresh session. + +*** + +### timeout\_ms? + +> `optional` **timeout\_ms?**: `number` + +Per-call timeout in milliseconds. Defaults to the runner-wide tool timeout when +omitted or zero. diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401EditInput.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401EditInput.md new file mode 100644 index 0000000..b9cfc43 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401EditInput.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401EditInput + +# Interface: ManagedAgentsAgentToolset20260401EditInput + +Input payload for the `edit` tool. Performs a string replacement in the named +file; by default `old_string` must occur exactly once. + +## Properties + +### file\_path + +> **file\_path**: `string` + +Path of the file to edit. + +*** + +### new\_string + +> **new\_string**: `string` + +Replacement text. + +*** + +### old\_string + +> **old\_string**: `string` + +Substring to find and replace. + +*** + +### replace\_all? + +> `optional` **replace\_all?**: `boolean` + +When true, replace every occurrence of `old_string` instead of requiring a +unique match. diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401GlobInput.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401GlobInput.md new file mode 100644 index 0000000..cd1c6a8 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401GlobInput.md @@ -0,0 +1,28 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401GlobInput + +# Interface: ManagedAgentsAgentToolset20260401GlobInput + +Input payload for the `glob` tool. Returns paths matching a doublestar glob +pattern, newest first. + +## Properties + +### path? + +> `optional` **path?**: `string` + +Optional directory root to search under. Defaults to the runner's working +directory. + +*** + +### pattern + +> **pattern**: `string` + +Doublestar glob pattern (e.g. `** /*.go`). Absolute patterns are only permitted +when the runner is configured to allow them. diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401GrepInput.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401GrepInput.md new file mode 100644 index 0000000..3304011 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401GrepInput.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401GrepInput + +# Interface: ManagedAgentsAgentToolset20260401GrepInput + +Input payload for the `grep` tool. Searches file contents for a regular +expression, returning matching lines. + +## Properties + +### path? + +> `optional` **path?**: `string` + +Optional directory root to search under. Defaults to the runner's working +directory. + +*** + +### pattern + +> **pattern**: `string` + +Regular expression to search for. diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401Params.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401Params.md new file mode 100644 index 0000000..c64e8ec --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401Params.md @@ -0,0 +1,46 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401Params + +# Interface: ManagedAgentsAgentToolset20260401Params + +Configuration for built-in agent tools. Use this to enable or disable groups of +tools available to the agent. + +## Properties + +### configs? + +> `optional` **configs?**: [`ManagedAgentsAgentToolConfigParamsUnion`](../type-aliases/ManagedAgentsAgentToolConfigParamsUnion.md)[] \| `null` + +Per-tool configuration overrides. + +*** + +### default\_config? + +> `optional` **default\_config?**: [`ManagedAgentsAgentToolsetDefaultConfigParams`](ManagedAgentsAgentToolsetDefaultConfigParams.md) \| `null` + +Default configuration for all tools in a toolset. + +*** + +### disallowed\_tools? + +> `optional` **disallowed\_tools?**: `string`[] \| `null` + +*** + +### enabled\_tools? + +> `optional` **enabled\_tools?**: `string`[] \| `null` + +*** + +### type + +> **type**: `"agent_toolset_20260401"` + +Any of "agent_toolset_20260401". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401ReadInput.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401ReadInput.md new file mode 100644 index 0000000..6fa498f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401ReadInput.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401ReadInput + +# Interface: ManagedAgentsAgentToolset20260401ReadInput + +Input payload for the `read` tool. Reads file contents relative to the runner's +working directory (or absolute when the runner permits). + +## Properties + +### file\_path + +> **file\_path**: `string` + +Path of the file to read. + +*** + +### view\_range? + +> `optional` **view\_range?**: `number`[] + +Optional ``start_line, end_line`` 1-indexed inclusive range. When omitted the +entire file is returned. `end_line` of 0 or negative means "to end of file". diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401WriteInput.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401WriteInput.md new file mode 100644 index 0000000..f3eb218 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolset20260401WriteInput.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401WriteInput + +# Interface: ManagedAgentsAgentToolset20260401WriteInput + +Input payload for the `write` tool. Writes (overwriting) the entire file +contents. + +## Properties + +### content + +> **content**: `string` + +Full file contents to write. + +*** + +### file\_path + +> **file\_path**: `string` + +Path of the file to write. diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolsetDefaultConfig.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolsetDefaultConfig.md new file mode 100644 index 0000000..0128405 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolsetDefaultConfig.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolsetDefaultConfig + +# Interface: ManagedAgentsAgentToolsetDefaultConfig + +Resolved default configuration for agent tools. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentToolsetDefaultConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsAgentToolsetDefaultConfigParams.md new file mode 100644 index 0000000..44fbab2 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentToolsetDefaultConfigParams.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolsetDefaultConfigParams + +# Interface: ManagedAgentsAgentToolsetDefaultConfigParams + +Default configuration for all tools in a toolset. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether tools are enabled and available to Claude by default. Defaults to true +if not specified. + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. diff --git a/docs/api/managed/interfaces/ManagedAgentsAgentWithOverridesParams.md b/docs/api/managed/interfaces/ManagedAgentsAgentWithOverridesParams.md new file mode 100644 index 0000000..1fd64f0 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAgentWithOverridesParams.md @@ -0,0 +1,80 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentWithOverridesParams + +# Interface: ManagedAgentsAgentWithOverridesParams + +Reference to an `agent` plus optional configuration overrides. Each provided +field replaces the agent's value for the caller's use; the agent resource is +unchanged. + +## Properties + +### id + +> **id**: `string` + +The `agent` ID. + +*** + +### mcp\_servers? + +> `optional` **mcp\_servers?**: [`ManagedAgentsURLMCPServerParams`](ManagedAgentsURLMCPServerParams.md)[] \| `null` + +Replacement MCP server list. Full replacement: the provided array becomes the +MCP servers. Send an empty array to clear; omit to preserve the agent's servers. + +*** + +### model? + +> `optional` **model?**: [`ManagedAgentsModelConfigParams`](../type-aliases/ManagedAgentsModelConfigParams.md) \| `null` + +Replacement model. Accepts the model string, e.g. `claude-opus-5`, or a +`model_config` object. Omit to use the agent's model. + +*** + +### skills? + +> `optional` **skills?**: [`ManagedAgentsSkillParamsUnion`](../type-aliases/ManagedAgentsSkillParamsUnion.md)[] \| `null` + +Replacement skill list. Full replacement: the provided array becomes the skills. +Send an empty array to clear; omit to preserve the agent's skills. + +*** + +### system? + +> `optional` **system?**: `string` \| `null` + +Replacement system prompt. Up to 100,000 characters. Set to null to clear the +agent's system prompt; omit to preserve it. + +*** + +### tools? + +> `optional` **tools?**: [`ManagedAgentsAgentWithOverridesParamsToolUnion`](../type-aliases/ManagedAgentsAgentWithOverridesParamsToolUnion.md)[] \| `null` + +Replacement tool list. Full replacement: the provided array becomes the tool +configuration. Send an empty array to clear; omit to preserve the agent's tools. + +*** + +### type + +> **type**: `"agent_with_overrides"` + +Any of "agent_with_overrides". + +*** + +### version? + +> `optional` **version?**: `number` \| `null` + +The specific `agent` version to use. Omit to use the latest version. diff --git a/docs/api/managed/interfaces/ManagedAgentsAlwaysAllowPolicy.md b/docs/api/managed/interfaces/ManagedAgentsAlwaysAllowPolicy.md new file mode 100644 index 0000000..420320d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAlwaysAllowPolicy.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAlwaysAllowPolicy + +# Interface: ManagedAgentsAlwaysAllowPolicy + +Tool calls are automatically approved without user confirmation. + +## Properties + +### type + +> **type**: `"always_allow"` + +Any of "always_allow". diff --git a/docs/api/managed/interfaces/ManagedAgentsAlwaysAllowPolicyParam.md b/docs/api/managed/interfaces/ManagedAgentsAlwaysAllowPolicyParam.md new file mode 100644 index 0000000..95cdbfd --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAlwaysAllowPolicyParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAlwaysAllowPolicyParam + +# Interface: ManagedAgentsAlwaysAllowPolicyParam + +Tool calls are automatically approved without user confirmation. + +## Properties + +### type + +> **type**: `"always_allow"` + +Any of "always_allow". diff --git a/docs/api/managed/interfaces/ManagedAgentsAlwaysAskPolicy.md b/docs/api/managed/interfaces/ManagedAgentsAlwaysAskPolicy.md new file mode 100644 index 0000000..145e397 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAlwaysAskPolicy.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAlwaysAskPolicy + +# Interface: ManagedAgentsAlwaysAskPolicy + +Tool calls require user confirmation before execution. + +## Properties + +### type + +> **type**: `"always_ask"` + +Any of "always_ask". diff --git a/docs/api/managed/interfaces/ManagedAgentsAlwaysAskPolicyParam.md b/docs/api/managed/interfaces/ManagedAgentsAlwaysAskPolicyParam.md new file mode 100644 index 0000000..05b162e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsAlwaysAskPolicyParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAlwaysAskPolicyParam + +# Interface: ManagedAgentsAlwaysAskPolicyParam + +Tool calls require user confirmation before execution. + +## Properties + +### type + +> **type**: `"always_ask"` + +Any of "always_ask". diff --git a/docs/api/managed/interfaces/ManagedAgentsBase64DocumentSource.md b/docs/api/managed/interfaces/ManagedAgentsBase64DocumentSource.md new file mode 100644 index 0000000..1045d68 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBase64DocumentSource.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBase64DocumentSource + +# Interface: ManagedAgentsBase64DocumentSource + +Base64-encoded document data. + +## Properties + +### data + +> **data**: `string` + +Base64-encoded document data. + +*** + +### media\_type + +> **media\_type**: `string` + +MIME type of the document (e.g., "application/pdf"). + +*** + +### type + +> **type**: `"base64"` + +Any of "base64". diff --git a/docs/api/managed/interfaces/ManagedAgentsBase64DocumentSourceParam.md b/docs/api/managed/interfaces/ManagedAgentsBase64DocumentSourceParam.md new file mode 100644 index 0000000..c1e5a9b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBase64DocumentSourceParam.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBase64DocumentSourceParam + +# Interface: ManagedAgentsBase64DocumentSourceParam + +Base64-encoded document data. + +## Properties + +### data + +> **data**: `string` + +Base64-encoded document data. + +*** + +### media\_type + +> **media\_type**: `string` + +MIME type of the document (e.g., "application/pdf"). + +*** + +### type + +> **type**: `"base64"` + +Any of "base64". diff --git a/docs/api/managed/interfaces/ManagedAgentsBase64ImageSource.md b/docs/api/managed/interfaces/ManagedAgentsBase64ImageSource.md new file mode 100644 index 0000000..64016ca --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBase64ImageSource.md @@ -0,0 +1,34 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBase64ImageSource + +# Interface: ManagedAgentsBase64ImageSource + +Base64-encoded image data. + +## Properties + +### data + +> **data**: `string` + +Base64-encoded image data. + +*** + +### media\_type + +> **media\_type**: `string` + +MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", +"image/webp"). + +*** + +### type + +> **type**: `"base64"` + +Any of "base64". diff --git a/docs/api/managed/interfaces/ManagedAgentsBase64ImageSourceParam.md b/docs/api/managed/interfaces/ManagedAgentsBase64ImageSourceParam.md new file mode 100644 index 0000000..41f6056 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBase64ImageSourceParam.md @@ -0,0 +1,34 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBase64ImageSourceParam + +# Interface: ManagedAgentsBase64ImageSourceParam + +Base64-encoded image data. + +## Properties + +### data + +> **data**: `string` + +Base64-encoded image data. + +*** + +### media\_type + +> **media\_type**: `string` + +MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", +"image/webp"). + +*** + +### type + +> **type**: `"base64"` + +Any of "base64". diff --git a/docs/api/managed/interfaces/ManagedAgentsBashToolConfig.md b/docs/api/managed/interfaces/ManagedAgentsBashToolConfig.md new file mode 100644 index 0000000..ca261cd --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBashToolConfig.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBashToolConfig + +# Interface: ManagedAgentsBashToolConfig + +Configuration for the bash tool. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### name? + +> `optional` **name?**: `"bash"` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsBashToolConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsBashToolConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"bash"` diff --git a/docs/api/managed/interfaces/ManagedAgentsBashToolConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsBashToolConfigParams.md new file mode 100644 index 0000000..904361c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBashToolConfigParams.md @@ -0,0 +1,44 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBashToolConfigParams + +# Interface: ManagedAgentsBashToolConfigParams + +Configuration override for the bash tool. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether this tool is enabled and available to Claude. Overrides the +default_config setting. + +*** + +### name? + +> `optional` **name?**: `"bash"` \| `null` + +Must be "bash". + +This field can be elided, and will marshal its zero value as "bash". + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsBashToolConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsBashToolConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"bash"` \| `null` + +Any of "bash". diff --git a/docs/api/managed/interfaces/ManagedAgentsBillingError.md b/docs/api/managed/interfaces/ManagedAgentsBillingError.md new file mode 100644 index 0000000..9301b02 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBillingError.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBillingError + +# Interface: ManagedAgentsBillingError + +The caller's organization or workspace cannot make model requests — out of +credits or spend limit reached. Retrying with the same credentials will not +succeed; the caller must resolve the billing state. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### retry\_status + +> **retry\_status**: [`ManagedAgentsBillingErrorRetryStatusUnion`](../type-aliases/ManagedAgentsBillingErrorRetryStatusUnion.md) + +What the client should do next in response to this error. + +*** + +### type + +> **type**: `"billing_error"` + +Any of "billing_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsBranchCheckout.md b/docs/api/managed/interfaces/ManagedAgentsBranchCheckout.md new file mode 100644 index 0000000..ab169c8 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBranchCheckout.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBranchCheckout + +# Interface: ManagedAgentsBranchCheckout + +## Properties + +### name + +> **name**: `string` + +Branch name to check out. + +*** + +### type + +> **type**: `"branch"` + +Any of "branch". diff --git a/docs/api/managed/interfaces/ManagedAgentsBranchCheckoutParam.md b/docs/api/managed/interfaces/ManagedAgentsBranchCheckoutParam.md new file mode 100644 index 0000000..797c683 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBranchCheckoutParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBranchCheckoutParam + +# Interface: ManagedAgentsBranchCheckoutParam + +The properties Name, Type are required. + +## Properties + +### name + +> **name**: `string` + +Branch name to check out. + +*** + +### type + +> **type**: `"branch"` + +Any of "branch". diff --git a/docs/api/managed/interfaces/ManagedAgentsBudgetLimit.md b/docs/api/managed/interfaces/ManagedAgentsBudgetLimit.md new file mode 100644 index 0000000..5f29093 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBudgetLimit.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBudgetLimit + +# Interface: ManagedAgentsBudgetLimit + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +## Properties + +### max\_list\_cost + +> **max\_list\_cost**: [`MonetaryAmount`](MonetaryAmount.md) + +A monetary amount in a specific currency. + +*** + +### type + +> **type**: `"limit"` + +Any of "limit". diff --git a/docs/api/managed/interfaces/ManagedAgentsBudgetLimitParam.md b/docs/api/managed/interfaces/ManagedAgentsBudgetLimitParam.md new file mode 100644 index 0000000..d553b6e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsBudgetLimitParam.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBudgetLimitParam + +# Interface: ManagedAgentsBudgetLimitParam + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +## Properties + +### max\_list\_cost + +> **max\_list\_cost**: [`MonetaryAmountParam`](MonetaryAmountParam.md) + +A monetary amount in a specific currency. + +*** + +### type + +> **type**: `"limit"` + +Any of "limit". diff --git a/docs/api/managed/interfaces/ManagedAgentsCacheCreationUsage.md b/docs/api/managed/interfaces/ManagedAgentsCacheCreationUsage.md new file mode 100644 index 0000000..5955b50 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCacheCreationUsage.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCacheCreationUsage + +# Interface: ManagedAgentsCacheCreationUsage + +Prompt-cache creation token usage broken down by cache lifetime. + +## Properties + +### ephemeral\_1h\_input\_tokens? + +> `optional` **ephemeral\_1h\_input\_tokens?**: `number` + +Tokens used to create 1-hour ephemeral cache entries. + +*** + +### ephemeral\_5m\_input\_tokens? + +> `optional` **ephemeral\_5m\_input\_tokens?**: `number` + +Tokens used to create 5-minute ephemeral cache entries. diff --git a/docs/api/managed/interfaces/ManagedAgentsCommitCheckout.md b/docs/api/managed/interfaces/ManagedAgentsCommitCheckout.md new file mode 100644 index 0000000..fc385b3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCommitCheckout.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCommitCheckout + +# Interface: ManagedAgentsCommitCheckout + +## Properties + +### sha + +> **sha**: `string` + +Full commit SHA to check out. + +*** + +### type + +> **type**: `"commit"` + +Any of "commit". diff --git a/docs/api/managed/interfaces/ManagedAgentsCommitCheckoutParam.md b/docs/api/managed/interfaces/ManagedAgentsCommitCheckoutParam.md new file mode 100644 index 0000000..605499e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCommitCheckoutParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCommitCheckoutParam + +# Interface: ManagedAgentsCommitCheckoutParam + +The properties Sha, Type are required. + +## Properties + +### sha + +> **sha**: `string` + +Full commit SHA to check out. + +*** + +### type + +> **type**: `"commit"` + +Any of "commit". diff --git a/docs/api/managed/interfaces/ManagedAgentsCredential.md b/docs/api/managed/interfaces/ManagedAgentsCredential.md new file mode 100644 index 0000000..2a42774 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCredential.md @@ -0,0 +1,82 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredential + +# Interface: ManagedAgentsCredential + +A credential stored in a vault. Sensitive fields are never returned in +responses. + +## Properties + +### archived\_at + +> **archived\_at**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### auth + +> **auth**: [`ManagedAgentsCredentialAuthUnion`](../type-aliases/ManagedAgentsCredentialAuthUnion.md) + +Authentication details for a credential. + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### display\_name? + +> `optional` **display\_name?**: `string` \| `null` + +Human-readable name for the credential. + +*** + +### id + +> **id**: `string` + +Unique identifier for the credential. + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `string`\> + +Arbitrary key-value metadata attached to the credential. + +*** + +### type + +> **type**: `"vault_credential"` + +Any of "vault_credential". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### vault\_id + +> **vault\_id**: `string` + +Identifier of the vault this credential belongs to. diff --git a/docs/api/managed/interfaces/ManagedAgentsCredentialHostUnreachableError.md b/docs/api/managed/interfaces/ManagedAgentsCredentialHostUnreachableError.md new file mode 100644 index 0000000..b7e9f6e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCredentialHostUnreachableError.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredentialHostUnreachableError + +# Interface: ManagedAgentsCredentialHostUnreachableError + +An `environment_variable` credential's `auth.networking.allowed_hosts` includes +a host the environment's network policy does not permit. + +## Properties + +### credential\_id + +> **credential\_id**: `string` + +ID of the affected credential. + +*** + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### retry\_status + +> **retry\_status**: [`ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion`](../type-aliases/ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion.md) + +What the client should do next in response to this error. + +*** + +### type + +> **type**: `"credential_host_unreachable_error"` + +Any of "credential_host_unreachable_error". + +*** + +### vault\_id + +> **vault\_id**: `string` + +ID of the vault containing the affected credential. diff --git a/docs/api/managed/interfaces/ManagedAgentsCredentialValidation.md b/docs/api/managed/interfaces/ManagedAgentsCredentialValidation.md new file mode 100644 index 0000000..44a3444 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCredentialValidation.md @@ -0,0 +1,75 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredentialValidation + +# Interface: ManagedAgentsCredentialValidation + +Result of live-probing a credential against its configured MCP server. + +## Properties + +### credential\_id + +> **credential\_id**: `string` + +Unique identifier of the credential that was validated. + +*** + +### has\_refresh\_token + +> **has\_refresh\_token**: `boolean` + +Whether the credential has a refresh token configured. + +*** + +### mcp\_probe + +> **mcp\_probe**: [`ManagedAgentsMCPProbe`](ManagedAgentsMCPProbe.md) + +The failing step of an MCP validation probe. + +*** + +### refresh + +> **refresh**: [`ManagedAgentsRefreshObject`](ManagedAgentsRefreshObject.md) + +Outcome of a refresh-token exchange attempted during credential validation. + +*** + +### status + +> **status**: [`ManagedAgentsCredentialValidationStatus`](../type-aliases/ManagedAgentsCredentialValidationStatus.md) + +Overall verdict of a credential validation probe. + +Any of "valid", "invalid", "unknown". + +*** + +### type + +> **type**: `"vault_credential_validation"` + +Any of "vault_credential_validation". + +*** + +### validated\_at + +> **validated\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### vault\_id + +> **vault\_id**: `string` + +Identifier of the vault containing the credential. diff --git a/docs/api/managed/interfaces/ManagedAgentsCustomSkill.md b/docs/api/managed/interfaces/ManagedAgentsCustomSkill.md new file mode 100644 index 0000000..5a741b2 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCustomSkill.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomSkill + +# Interface: ManagedAgentsCustomSkill + +A resolved user-created custom skill. + +## Properties + +### skill\_id + +> **skill\_id**: `string` + +*** + +### type + +> **type**: `"custom"` + +Any of "custom". + +*** + +### version + +> **version**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsCustomSkillParams.md b/docs/api/managed/interfaces/ManagedAgentsCustomSkillParams.md new file mode 100644 index 0000000..57cdbf5 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCustomSkillParams.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomSkillParams + +# Interface: ManagedAgentsCustomSkillParams + +A user-created custom skill. + +## Properties + +### skill\_id + +> **skill\_id**: `string` + +Tagged ID of the custom skill (e.g., "skill_01XJ5..."). + +*** + +### type + +> **type**: `"custom"` + +Any of "custom". + +*** + +### version? + +> `optional` **version?**: `string` \| `null` + +Version to pin. Defaults to latest if omitted. diff --git a/docs/api/managed/interfaces/ManagedAgentsCustomTool.md b/docs/api/managed/interfaces/ManagedAgentsCustomTool.md new file mode 100644 index 0000000..24404e7 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCustomTool.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomTool + +# Interface: ManagedAgentsCustomTool + +A custom tool as returned in API responses. + +## Properties + +### description + +> **description**: `string` + +*** + +### input\_schema + +> **input\_schema**: [`ManagedAgentsCustomToolInputSchema`](ManagedAgentsCustomToolInputSchema.md) + +JSON Schema for custom tool input parameters. + +*** + +### name + +> **name**: `string` + +*** + +### type + +> **type**: `"custom"` + +Any of "custom". diff --git a/docs/api/managed/interfaces/ManagedAgentsCustomToolInputSchema.md b/docs/api/managed/interfaces/ManagedAgentsCustomToolInputSchema.md new file mode 100644 index 0000000..2165ccd --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCustomToolInputSchema.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomToolInputSchema + +# Interface: ManagedAgentsCustomToolInputSchema + +JSON Schema for custom tool input parameters. + +## Properties + +### extra\_fields? + +> `optional` **extra\_fields?**: `Record`\<`string`, `unknown`\> + +*** + +### properties? + +> `optional` **properties?**: `Record`\<`string`, `unknown`\> \| `null` + +*** + +### required? + +> `optional` **required?**: `string`[] \| `null` + +*** + +### type? + +> `optional` **type?**: `"object"` diff --git a/docs/api/managed/interfaces/ManagedAgentsCustomToolInputSchemaParam.md b/docs/api/managed/interfaces/ManagedAgentsCustomToolInputSchemaParam.md new file mode 100644 index 0000000..3dd3bed --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCustomToolInputSchemaParam.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomToolInputSchemaParam + +# Interface: ManagedAgentsCustomToolInputSchemaParam + +JSON Schema for custom tool input parameters. + +## Indexable + +> \[`key`: `string`\]: `unknown` + +Additional JSON Schema keywords are sent at the schema root. + +## Properties + +### properties? + +> `optional` **properties?**: `Record`\<`string`, `unknown`\> \| `null` + +*** + +### required? + +> `optional` **required?**: `string`[] \| `null` + +*** + +### type? + +> `optional` **type?**: `"object"` \| `null` + +This field can be elided, and will marshal its zero value as "object". diff --git a/docs/api/managed/interfaces/ManagedAgentsCustomToolParams.md b/docs/api/managed/interfaces/ManagedAgentsCustomToolParams.md new file mode 100644 index 0000000..d9117af --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsCustomToolParams.md @@ -0,0 +1,46 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomToolParams + +# Interface: ManagedAgentsCustomToolParams + +A custom tool that is executed by the API client rather than the agent. When the +agent calls this tool, an `agent.custom_tool_use` event is emitted and the +session goes idle, waiting for the client to provide the result via a +`user.custom_tool_result` event. + +## Properties + +### description + +> **description**: `string` + +Description of what the tool does, shown to the agent to help it decide when to +use the tool. + +*** + +### input\_schema + +> **input\_schema**: [`ManagedAgentsCustomToolInputSchemaParam`](ManagedAgentsCustomToolInputSchemaParam.md) + +JSON Schema for custom tool input parameters. + +*** + +### name + +> **name**: `string` + +Unique name for the tool. 1-128 characters; letters, digits, underscores, and +hyphens. + +*** + +### type + +> **type**: `"custom"` + +Any of "custom". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeleteSessionResource.md b/docs/api/managed/interfaces/ManagedAgentsDeleteSessionResource.md new file mode 100644 index 0000000..77c3431 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeleteSessionResource.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeleteSessionResource + +# Interface: ManagedAgentsDeleteSessionResource + +Confirmation of resource deletion. + +## Properties + +### id + +> **id**: `string` + +*** + +### type + +> **type**: `"session_resource_deleted"` + +Any of "session_resource_deleted". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeletedCredential.md b/docs/api/managed/interfaces/ManagedAgentsDeletedCredential.md new file mode 100644 index 0000000..b22b573 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeletedCredential.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedCredential + +# Interface: ManagedAgentsDeletedCredential + +Confirmation of a deleted credential. + +## Properties + +### id + +> **id**: `string` + +Unique identifier of the deleted credential. + +*** + +### type + +> **type**: `"vault_credential_deleted"` + +Any of "vault_credential_deleted". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeletedMemory.md b/docs/api/managed/interfaces/ManagedAgentsDeletedMemory.md new file mode 100644 index 0000000..5db83cd --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeletedMemory.md @@ -0,0 +1,30 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedMemory + +# Interface: ManagedAgentsDeletedMemory + +Tombstone returned by +[Delete a memory](/en/api/beta/memory_stores/memories/delete). Deleting a memory +does not erase its version history: its versions remain listable via +[List memory versions](/en/api/beta/memory_stores/memory_versions/list) while +they are retained (each version is kept for at least the version retention +period after it was written, unless the store itself is deleted). + +## Properties + +### id + +> **id**: `string` + +ID of the deleted memory (a `mem_...` value). + +*** + +### type + +> **type**: `"memory_deleted"` + +Any of "memory_deleted". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeletedMemoryStore.md b/docs/api/managed/interfaces/ManagedAgentsDeletedMemoryStore.md new file mode 100644 index 0000000..f876090 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeletedMemoryStore.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedMemoryStore + +# Interface: ManagedAgentsDeletedMemoryStore + +Confirmation that a `memory_store` was deleted. + +## Properties + +### id + +> **id**: `string` + +ID of the deleted memory store (a `memstore_...` identifier). The store and all +its memories and versions are no longer retrievable. + +*** + +### type + +> **type**: `"memory_store_deleted"` + +Any of "memory_store_deleted". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeletedSession.md b/docs/api/managed/interfaces/ManagedAgentsDeletedSession.md new file mode 100644 index 0000000..9a5278f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeletedSession.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedSession + +# Interface: ManagedAgentsDeletedSession + +Confirmation that a `session` has been permanently deleted. + +## Properties + +### id + +> **id**: `string` + +*** + +### type + +> **type**: `"session_deleted"` + +Any of "session_deleted". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeletedVault.md b/docs/api/managed/interfaces/ManagedAgentsDeletedVault.md new file mode 100644 index 0000000..2410668 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeletedVault.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedVault + +# Interface: ManagedAgentsDeletedVault + +Confirmation of a deleted vault. + +## Properties + +### id + +> **id**: `string` + +Unique identifier of the deleted vault. + +*** + +### type + +> **type**: `"vault_deleted"` + +Any of "vault_deleted". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeltaContent.md b/docs/api/managed/interfaces/ManagedAgentsDeltaContent.md new file mode 100644 index 0000000..afef6c7 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeltaContent.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeltaContent + +# Interface: ManagedAgentsDeltaContent + +## Properties + +### content + +> **content**: [`ManagedAgentsTextBlock`](ManagedAgentsTextBlock.md) + +Regular text content. + +*** + +### index? + +> `optional` **index?**: `number` + +Which entry in the previewed event's content array this fragment lands in. +Insert content as that entry when the index is new; append to the existing entry +otherwise. + +*** + +### type + +> **type**: `"content_delta"` + +Any of "content_delta". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeltaEvent.md b/docs/api/managed/interfaces/ManagedAgentsDeltaEvent.md new file mode 100644 index 0000000..e39003e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeltaEvent.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeltaEvent + +# Interface: ManagedAgentsDeltaEvent + +An incremental update to an event that is still being streamed. Deltas are +best-effort and may stop early; when the buffered event with id == event_id is +produced it carries the complete content. A model request that ends early (an +error or interrupt) produces no buffered event — its terminal +span.model_request_end closes the preview. Only sent on stream connections that +opt in via event_deltas; never appears in event history. + +## Properties + +### delta + +> **delta**: [`ManagedAgentsDeltaContent`](ManagedAgentsDeltaContent.md) + +One fragment of the previewed event. The delta type is named for the previewed +event's field it streams into: agent.message events stream content_delta +fragments, each a partial element of the content array. + +*** + +### event\_id + +> **event\_id**: `string` + +The id of the event being previewed. Matches event.id on the corresponding +event_start and the buffered event that reconciles the preview. + +*** + +### type + +> **type**: `"event_delta"` + +Any of "event_delta". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeployment.md b/docs/api/managed/interfaces/ManagedAgentsDeployment.md new file mode 100644 index 0000000..7696519 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeployment.md @@ -0,0 +1,158 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeployment + +# Interface: ManagedAgentsDeployment + +A deployment is a configured instance of an agent — it binds the agent to +everything needed to run it autonomously: an environment, credentials, initial +events, and an optional schedule. + +## Properties + +### agent + +> **agent**: [`ManagedAgentsAgentReference`](ManagedAgentsAgentReference.md) + +A resolved agent reference with a concrete version. + +*** + +### archived\_at + +> **archived\_at**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### budget? + +> `optional` **budget?**: [`ManagedAgentsBudgetLimit`](ManagedAgentsBudgetLimit.md) \| `null` + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### description + +> **description**: `string` + +Description of what the deployment does. + +*** + +### environment\_id + +> **environment\_id**: `string` + +ID of the `environment` where sessions run. + +*** + +### environment\_variables? + +> `optional` **environment\_variables?**: `string` + +*** + +### id + +> **id**: `string` + +Unique identifier for this deployment. + +*** + +### initial\_events + +> **initial\_events**: [`ManagedAgentsDeploymentInitialEventUnion`](../type-aliases/ManagedAgentsDeploymentInitialEventUnion.md)[] + +Events sent to each session immediately after creation. + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `string`\> + +Arbitrary key-value metadata. Maximum 16 pairs. + +*** + +### name + +> **name**: `string` + +Human-readable name. + +*** + +### paused\_reason + +> **paused\_reason**: [`ManagedAgentsDeploymentPausedReasonUnion`](../type-aliases/ManagedAgentsDeploymentPausedReasonUnion.md) \| `null` + +Why a deployment is paused. Non-null exactly when `status` is `paused`. + +*** + +### resources + +> **resources**: [`ManagedAgentsSessionResourceConfigUnion`](../type-aliases/ManagedAgentsSessionResourceConfigUnion.md)[] + +Resources attached to sessions created from this deployment. Echoes the input +minus write-only credentials. + +*** + +### schedule + +> **schedule**: [`ManagedAgentsSchedule`](ManagedAgentsSchedule.md) + +5-field POSIX cron schedule with computed runtime timestamps. + +*** + +### status + +> **status**: [`ManagedAgentsDeploymentStatus`](../type-aliases/ManagedAgentsDeploymentStatus.md) + +Lifecycle status of a deployment. + +Any of "active", "paused". + +*** + +### type + +> **type**: `"deployment"` + +Any of "deployment". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### vault\_ids + +> **vault\_ids**: `string`[] + +Vault IDs supplying stored credentials for sessions created from this +deployment. diff --git a/docs/api/managed/interfaces/ManagedAgentsDeploymentRun.md b/docs/api/managed/interfaces/ManagedAgentsDeploymentRun.md new file mode 100644 index 0000000..e09c486 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeploymentRun.md @@ -0,0 +1,76 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentRun + +# Interface: ManagedAgentsDeploymentRun + +A persistent, append-only record of a single deployment execution. Records +session creation success or failure — no session lifecycle tracking. + +## Properties + +### agent + +> **agent**: [`ManagedAgentsAgentReference`](ManagedAgentsAgentReference.md) + +A resolved agent reference with a concrete version. + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### deployment\_id + +> **deployment\_id**: `string` + +ID of the deployment that produced this run. + +*** + +### error + +> **error**: [`ManagedAgentsDeploymentRunErrorUnion`](../type-aliases/ManagedAgentsDeploymentRunErrorUnion.md) \| `null` + +Why the run failed to create a session. The type identifies the failure; message +is human-readable detail. + +*** + +### id + +> **id**: `string` + +Unique identifier for this run (`drun_...`). + +*** + +### session\_id + +> **session\_id**: `string` + +Populated on success. Null on creation failure. Exactly one of `session_id` or +`error` is non-null. + +*** + +### trigger\_context + +> **trigger\_context**: [`ManagedAgentsTriggerContextUnion`](../type-aliases/ManagedAgentsTriggerContextUnion.md) + +Describes what triggered a deployment run, with trigger-specific metadata. + +*** + +### type + +> **type**: `"deployment_run"` + +Any of "deployment_run". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeploymentSystemMessageEvent.md b/docs/api/managed/interfaces/ManagedAgentsDeploymentSystemMessageEvent.md new file mode 100644 index 0000000..0de5a3b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeploymentSystemMessageEvent.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentSystemMessageEvent + +# Interface: ManagedAgentsDeploymentSystemMessageEvent + +Privileged context for the accompanying turn and all subsequent turns, appended +to the session's system context as a `role: "system"` turn rather than replacing +the top-level system prompt. + +## Properties + +### content + +> **content**: [`ManagedAgentsSystemContentBlock`](ManagedAgentsSystemContentBlock.md)[] + +System content blocks to append. Text-only. + +*** + +### type + +> **type**: `"system.message"` + +Any of "system.message". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeploymentUserDefineOutcomeEvent.md b/docs/api/managed/interfaces/ManagedAgentsDeploymentUserDefineOutcomeEvent.md new file mode 100644 index 0000000..965fe37 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeploymentUserDefineOutcomeEvent.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentUserDefineOutcomeEvent + +# Interface: ManagedAgentsDeploymentUserDefineOutcomeEvent + +An outcome the agent should work toward. The agent begins work on receipt. + +## Properties + +### description + +> **description**: `string` + +What the agent should produce. This is the task specification. + +*** + +### max\_iterations? + +> `optional` **max\_iterations?**: `number` \| `null` + +Eval→revision cycles before giving up. Default 3, max 20. + +*** + +### rubric + +> **rubric**: [`ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion`](../type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion.md) + +Rubric for grading the quality of an outcome. + +*** + +### type + +> **type**: `"user.define_outcome"` + +Any of "user.define_outcome". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeploymentUserMessageEvent.md b/docs/api/managed/interfaces/ManagedAgentsDeploymentUserMessageEvent.md new file mode 100644 index 0000000..fc05963 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeploymentUserMessageEvent.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentUserMessageEvent + +# Interface: ManagedAgentsDeploymentUserMessageEvent + +A user message sent to the session. + +## Properties + +### content + +> **content**: [`ManagedAgentsDeploymentUserMessageEventContentUnion`](../type-aliases/ManagedAgentsDeploymentUserMessageEventContentUnion.md)[] + +Array of content blocks for the user message. + +*** + +### type + +> **type**: `"user.message"` + +Any of "user.message". diff --git a/docs/api/managed/interfaces/ManagedAgentsDeploymentUserMessageEventContentUnionSource.md b/docs/api/managed/interfaces/ManagedAgentsDeploymentUserMessageEventContentUnionSource.md new file mode 100644 index 0000000..95e5a82 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDeploymentUserMessageEventContentUnionSource.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentUserMessageEventContentUnionSource + +# Interface: ManagedAgentsDeploymentUserMessageEventContentUnionSource + +ManagedAgentsDeploymentUserMessageEventContentUnionSource is an implicit +subunion of `ManagedAgentsDeploymentUserMessageEventContentUnion`. +ManagedAgentsDeploymentUserMessageEventContentUnionSource provides +convenient access to the sub-properties of the union. + +## Properties + +### data? + +> `optional` **data?**: `string` + +*** + +### file\_id? + +> `optional` **file\_id?**: `string` + +*** + +### media\_type? + +> `optional` **media\_type?**: `string` + +*** + +### type? + +> `optional` **type?**: `string` + +*** + +### url? + +> `optional` **url?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsDocumentBlock.md b/docs/api/managed/interfaces/ManagedAgentsDocumentBlock.md new file mode 100644 index 0000000..7f11fca --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDocumentBlock.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDocumentBlock + +# Interface: ManagedAgentsDocumentBlock + +Document content, either specified directly as base64 data, as text, or as a +reference via a URL. + +## Properties + +### context? + +> `optional` **context?**: `string` \| `null` + +Additional context about the document for the model. + +*** + +### source + +> **source**: [`ManagedAgentsDocumentBlockSourceUnion`](../type-aliases/ManagedAgentsDocumentBlockSourceUnion.md) + +Union type for document source variants. + +*** + +### title? + +> `optional` **title?**: `string` \| `null` + +The title of the document. + +*** + +### type + +> **type**: `"document"` + +Any of "document". diff --git a/docs/api/managed/interfaces/ManagedAgentsDocumentBlockParam.md b/docs/api/managed/interfaces/ManagedAgentsDocumentBlockParam.md new file mode 100644 index 0000000..0baafad --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsDocumentBlockParam.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDocumentBlockParam + +# Interface: ManagedAgentsDocumentBlockParam + +Document content, either specified directly as base64 data, as text, or as a +reference via a URL. + +## Properties + +### context? + +> `optional` **context?**: `string` \| `null` + +Additional context about the document for the model. + +*** + +### source + +> **source**: [`ManagedAgentsDocumentBlockSourceUnionParam`](../type-aliases/ManagedAgentsDocumentBlockSourceUnionParam.md) + +Union type for document source variants. + +*** + +### title? + +> `optional` **title?**: `string` \| `null` + +The title of the document. + +*** + +### type + +> **type**: `"document"` + +Any of "document". diff --git a/docs/api/managed/interfaces/ManagedAgentsEditToolConfig.md b/docs/api/managed/interfaces/ManagedAgentsEditToolConfig.md new file mode 100644 index 0000000..321b4fd --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEditToolConfig.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEditToolConfig + +# Interface: ManagedAgentsEditToolConfig + +Configuration for the edit tool. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### name? + +> `optional` **name?**: `"edit"` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsEditToolConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsEditToolConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"edit"` diff --git a/docs/api/managed/interfaces/ManagedAgentsEditToolConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsEditToolConfigParams.md new file mode 100644 index 0000000..48da801 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEditToolConfigParams.md @@ -0,0 +1,44 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEditToolConfigParams + +# Interface: ManagedAgentsEditToolConfigParams + +Configuration override for the edit tool. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether this tool is enabled and available to Claude. Overrides the +default_config setting. + +*** + +### name? + +> `optional` **name?**: `"edit"` \| `null` + +Must be "edit". + +This field can be elided, and will marshal its zero value as "edit". + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsEditToolConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsEditToolConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"edit"` \| `null` + +Any of "edit". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortHigh.md b/docs/api/managed/interfaces/ManagedAgentsEffortHigh.md new file mode 100644 index 0000000..95fa580 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortHigh.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortHigh + +# Interface: ManagedAgentsEffortHigh + +High effort. Favors reasoning depth. + +## Properties + +### type + +> **type**: `"high"` + +Any of "high". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortHighParam.md b/docs/api/managed/interfaces/ManagedAgentsEffortHighParam.md new file mode 100644 index 0000000..90a9c08 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortHighParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortHighParam + +# Interface: ManagedAgentsEffortHighParam + +High effort. Favors reasoning depth. + +## Properties + +### type + +> **type**: `"high"` + +Any of "high". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortLow.md b/docs/api/managed/interfaces/ManagedAgentsEffortLow.md new file mode 100644 index 0000000..94a2b02 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortLow.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortLow + +# Interface: ManagedAgentsEffortLow + +Low effort. Favors latency over reasoning depth. + +## Properties + +### type + +> **type**: `"low"` + +Any of "low". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortLowParam.md b/docs/api/managed/interfaces/ManagedAgentsEffortLowParam.md new file mode 100644 index 0000000..ec53c77 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortLowParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortLowParam + +# Interface: ManagedAgentsEffortLowParam + +Low effort. Favors latency over reasoning depth. + +## Properties + +### type + +> **type**: `"low"` + +Any of "low". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortMax.md b/docs/api/managed/interfaces/ManagedAgentsEffortMax.md new file mode 100644 index 0000000..5213693 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortMax.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortMax + +# Interface: ManagedAgentsEffortMax + +Maximum effort. Favors reasoning depth over latency. + +## Properties + +### type + +> **type**: `"max"` + +Any of "max". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortMaxParam.md b/docs/api/managed/interfaces/ManagedAgentsEffortMaxParam.md new file mode 100644 index 0000000..9abc766 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortMaxParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortMaxParam + +# Interface: ManagedAgentsEffortMaxParam + +Maximum effort. Favors reasoning depth over latency. + +## Properties + +### type + +> **type**: `"max"` + +Any of "max". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortMedium.md b/docs/api/managed/interfaces/ManagedAgentsEffortMedium.md new file mode 100644 index 0000000..e93a27a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortMedium.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortMedium + +# Interface: ManagedAgentsEffortMedium + +Medium effort. Balances latency and reasoning depth. + +## Properties + +### type + +> **type**: `"medium"` + +Any of "medium". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortMediumParam.md b/docs/api/managed/interfaces/ManagedAgentsEffortMediumParam.md new file mode 100644 index 0000000..8b3b46f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortMediumParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortMediumParam + +# Interface: ManagedAgentsEffortMediumParam + +Medium effort. Balances latency and reasoning depth. + +## Properties + +### type + +> **type**: `"medium"` + +Any of "medium". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortXhigh.md b/docs/api/managed/interfaces/ManagedAgentsEffortXhigh.md new file mode 100644 index 0000000..323d847 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortXhigh.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortXhigh + +# Interface: ManagedAgentsEffortXhigh + +Extra-high effort. Not all models accept this level. + +## Properties + +### type + +> **type**: `"xhigh"` + +Any of "xhigh". diff --git a/docs/api/managed/interfaces/ManagedAgentsEffortXhighParam.md b/docs/api/managed/interfaces/ManagedAgentsEffortXhighParam.md new file mode 100644 index 0000000..0bbd1da --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEffortXhighParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortXhighParam + +# Interface: ManagedAgentsEffortXhighParam + +Extra-high effort. Not all models accept this level. + +## Properties + +### type + +> **type**: `"xhigh"` + +Any of "xhigh". diff --git a/docs/api/managed/interfaces/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError.md new file mode 100644 index 0000000..92bfa6f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError + +# Interface: ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError + +The deployment's environment was archived. + +## Properties + +### type + +> **type**: `"environment_archived_error"` + +Any of "environment_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsEnvironmentArchivedRunError.md b/docs/api/managed/interfaces/ManagedAgentsEnvironmentArchivedRunError.md new file mode 100644 index 0000000..eb7a8a9 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEnvironmentArchivedRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentArchivedRunError + +# Interface: ManagedAgentsEnvironmentArchivedRunError + +The deployment's environment was archived. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"environment_archived_error"` + +Any of "environment_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError.md new file mode 100644 index 0000000..f7fc2fe --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError + +# Interface: ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError + +The deployment's environment no longer exists. + +## Properties + +### type + +> **type**: `"environment_not_found_error"` + +Any of "environment_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsEnvironmentNotFoundRunError.md b/docs/api/managed/interfaces/ManagedAgentsEnvironmentNotFoundRunError.md new file mode 100644 index 0000000..683922c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEnvironmentNotFoundRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentNotFoundRunError + +# Interface: ManagedAgentsEnvironmentNotFoundRunError + +The deployment's environment no longer exists. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"environment_not_found_error"` + +Any of "environment_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableAuthResponse.md b/docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableAuthResponse.md new file mode 100644 index 0000000..1b5dd78 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableAuthResponse.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentVariableAuthResponse + +# Interface: ManagedAgentsEnvironmentVariableAuthResponse + +Environment variable credential details. The secret value is never returned. + +## Properties + +### injection\_location + +> **injection\_location**: [`ManagedAgentsInjectionLocationResponse`](ManagedAgentsInjectionLocationResponse.md) + +Where in the outbound request the secret value is substituted. + +*** + +### networking + +> **networking**: [`ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion`](../type-aliases/ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion.md) + +Outbound hosts the secret value is substituted on. + +*** + +### secret\_name + +> **secret\_name**: `string` + +Name of the environment variable. + +*** + +### type + +> **type**: `"environment_variable"` + +Any of "environment_variable". diff --git a/docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableCreateParams.md b/docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableCreateParams.md new file mode 100644 index 0000000..a3f7b03 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableCreateParams.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentVariableCreateParams + +# Interface: ManagedAgentsEnvironmentVariableCreateParams + +Parameters for creating an environment variable credential. + +## Properties + +### injection\_location? + +> `optional` **injection\_location?**: [`ManagedAgentsInjectionLocationParams`](ManagedAgentsInjectionLocationParams.md) \| `null` + +Where in the outbound request the secret value may be substituted. + +*** + +### networking + +> **networking**: [`ManagedAgentsCredentialNetworkingParamsUnion`](../type-aliases/ManagedAgentsCredentialNetworkingParamsUnion.md) + +Outbound hosts the secret value is substituted on. + +*** + +### secret\_name + +> **secret\_name**: `string` + +Name of the environment variable. Immutable after create. + +*** + +### secret\_value + +> **secret\_value**: `string` + +Secret value. Write-only; never returned in responses. + +*** + +### type + +> **type**: `"environment_variable"` + +Any of "environment_variable". diff --git a/docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableUpdateParams.md b/docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableUpdateParams.md new file mode 100644 index 0000000..419e03b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsEnvironmentVariableUpdateParams.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentVariableUpdateParams + +# Interface: ManagedAgentsEnvironmentVariableUpdateParams + +Parameters for updating an environment variable credential. `secret_name` is +immutable. + +## Properties + +### injection\_location? + +> `optional` **injection\_location?**: [`ManagedAgentsInjectionLocationUpdateParams`](ManagedAgentsInjectionLocationUpdateParams.md) \| `null` + +Updated injection location. + +*** + +### networking? + +> `optional` **networking?**: [`ManagedAgentsCredentialNetworkingParamsUnion`](../type-aliases/ManagedAgentsCredentialNetworkingParamsUnion.md) \| `null` + +Updated networking scope. Full replacement. + +*** + +### secret\_value? + +> `optional` **secret\_value?**: `string` \| `null` + +Updated secret value. + +*** + +### type + +> **type**: `"environment_variable"` + +Any of "environment_variable". diff --git a/docs/api/managed/interfaces/ManagedAgentsErrorDeploymentPausedReason.md b/docs/api/managed/interfaces/ManagedAgentsErrorDeploymentPausedReason.md new file mode 100644 index 0000000..3284890 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsErrorDeploymentPausedReason.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsErrorDeploymentPausedReason + +# Interface: ManagedAgentsErrorDeploymentPausedReason + +A scheduled fire recorded a failed run whose error auto-pauses the deployment. + +## Properties + +### error + +> **error**: [`ManagedAgentsDeploymentPausedReasonErrorUnion`](../type-aliases/ManagedAgentsDeploymentPausedReasonErrorUnion.md) + +The error that triggered an auto-pause. Matches the failed run's `error.type`. + +*** + +### type + +> **type**: `"error"` + +Any of "error". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileDocumentSource.md b/docs/api/managed/interfaces/ManagedAgentsFileDocumentSource.md new file mode 100644 index 0000000..54c1464 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileDocumentSource.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileDocumentSource + +# Interface: ManagedAgentsFileDocumentSource + +Document referenced by file ID. + +## Properties + +### file\_id + +> **file\_id**: `string` + +ID of a previously uploaded file. + +*** + +### type + +> **type**: `"file"` + +Any of "file". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileDocumentSourceParam.md b/docs/api/managed/interfaces/ManagedAgentsFileDocumentSourceParam.md new file mode 100644 index 0000000..3769730 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileDocumentSourceParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileDocumentSourceParam + +# Interface: ManagedAgentsFileDocumentSourceParam + +Document referenced by file ID. + +## Properties + +### file\_id + +> **file\_id**: `string` + +ID of a previously uploaded file. + +*** + +### type + +> **type**: `"file"` + +Any of "file". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileImageSource.md b/docs/api/managed/interfaces/ManagedAgentsFileImageSource.md new file mode 100644 index 0000000..59f0cf6 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileImageSource.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileImageSource + +# Interface: ManagedAgentsFileImageSource + +Image referenced by file ID. + +## Properties + +### file\_id + +> **file\_id**: `string` + +ID of a previously uploaded file. + +*** + +### type + +> **type**: `"file"` + +Any of "file". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileImageSourceParam.md b/docs/api/managed/interfaces/ManagedAgentsFileImageSourceParam.md new file mode 100644 index 0000000..51bcce2 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileImageSourceParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileImageSourceParam + +# Interface: ManagedAgentsFileImageSourceParam + +Image referenced by file ID. + +## Properties + +### file\_id + +> **file\_id**: `string` + +ID of a previously uploaded file. + +*** + +### type + +> **type**: `"file"` + +Any of "file". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileNotFoundDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsFileNotFoundDeploymentPausedReasonError.md new file mode 100644 index 0000000..45e4844 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileNotFoundDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileNotFoundDeploymentPausedReasonError + +# Interface: ManagedAgentsFileNotFoundDeploymentPausedReasonError + +A file resource referenced by the deployment no longer exists. + +## Properties + +### type + +> **type**: `"file_not_found_error"` + +Any of "file_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileNotFoundRunError.md b/docs/api/managed/interfaces/ManagedAgentsFileNotFoundRunError.md new file mode 100644 index 0000000..53f5e19 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileNotFoundRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileNotFoundRunError + +# Interface: ManagedAgentsFileNotFoundRunError + +A file resource referenced by the deployment no longer exists. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"file_not_found_error"` + +Any of "file_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileResource.md b/docs/api/managed/interfaces/ManagedAgentsFileResource.md new file mode 100644 index 0000000..941a719 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileResource.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileResource + +# Interface: ManagedAgentsFileResource + +## Properties + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### file\_id + +> **file\_id**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### mount\_path + +> **mount\_path**: `string` + +*** + +### type + +> **type**: `"file"` + +Any of "file". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format diff --git a/docs/api/managed/interfaces/ManagedAgentsFileResourceConfig.md b/docs/api/managed/interfaces/ManagedAgentsFileResourceConfig.md new file mode 100644 index 0000000..d4951d9 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileResourceConfig.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileResourceConfig + +# Interface: ManagedAgentsFileResourceConfig + +A file mounted into each session's container. + +## Properties + +### file\_id + +> **file\_id**: `string` + +ID of a previously uploaded file. + +*** + +### mount\_path? + +> `optional` **mount\_path?**: `string` \| `null` + +Mount path in the container. Defaults to `/mnt/session/uploads/`. + +*** + +### type + +> **type**: `"file"` + +Any of "file". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileResourceParams.md b/docs/api/managed/interfaces/ManagedAgentsFileResourceParams.md new file mode 100644 index 0000000..66a7be3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileResourceParams.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileResourceParams + +# Interface: ManagedAgentsFileResourceParams + +Mount a file uploaded via the Files API into the session. + +## Properties + +### file\_id + +> **file\_id**: `string` + +ID of a previously uploaded file. + +*** + +### mount\_path? + +> `optional` **mount\_path?**: `string` \| `null` + +Mount path in the container. Defaults to `/mnt/session/uploads/`. + +*** + +### type + +> **type**: `"file"` + +Any of "file". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileRubric.md b/docs/api/managed/interfaces/ManagedAgentsFileRubric.md new file mode 100644 index 0000000..0264def --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileRubric.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileRubric + +# Interface: ManagedAgentsFileRubric + +Rubric referenced by a file uploaded via the Files API. + +## Properties + +### file\_id + +> **file\_id**: `string` + +ID of the rubric file. + +*** + +### type + +> **type**: `"file"` + +Any of "file". diff --git a/docs/api/managed/interfaces/ManagedAgentsFileRubricParams.md b/docs/api/managed/interfaces/ManagedAgentsFileRubricParams.md new file mode 100644 index 0000000..a116b64 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsFileRubricParams.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileRubricParams + +# Interface: ManagedAgentsFileRubricParams + +Rubric referenced by a file uploaded via the Files API. + +## Properties + +### file\_id + +> **file\_id**: `string` + +ID of the rubric file. + +*** + +### type + +> **type**: `"file"` + +Any of "file". diff --git a/docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResource.md b/docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResource.md new file mode 100644 index 0000000..e88de4b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResource.md @@ -0,0 +1,55 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGitHubRepositoryResource + +# Interface: ManagedAgentsGitHubRepositoryResource + +## Properties + +### checkout? + +> `optional` **checkout?**: [`ManagedAgentsGitHubRepositoryResourceCheckoutUnion`](../type-aliases/ManagedAgentsGitHubRepositoryResourceCheckoutUnion.md) \| `null` + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### id + +> **id**: `string` + +*** + +### mount\_path + +> **mount\_path**: `string` + +*** + +### type + +> **type**: `"github_repository"` + +Any of "github_repository". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### url + +> **url**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResourceConfig.md b/docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResourceConfig.md new file mode 100644 index 0000000..fc685f0 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResourceConfig.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGitHubRepositoryResourceConfig + +# Interface: ManagedAgentsGitHubRepositoryResourceConfig + +A GitHub repository mounted into each session's container. The authorization +token is write-only and never returned. + +## Properties + +### checkout? + +> `optional` **checkout?**: [`ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion`](../type-aliases/ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion.md) \| `null` + +Branch or commit to check out. Defaults to the repository's default branch. + +*** + +### mount\_path? + +> `optional` **mount\_path?**: `string` \| `null` + +Mount path in the container. Defaults to `/workspace/`. + +*** + +### type + +> **type**: `"github_repository"` + +Any of "github_repository". + +*** + +### url + +> **url**: `string` + +Github URL of the repository diff --git a/docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResourceParams.md b/docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResourceParams.md new file mode 100644 index 0000000..7b49ddc --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsGitHubRepositoryResourceParams.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGitHubRepositoryResourceParams + +# Interface: ManagedAgentsGitHubRepositoryResourceParams + +Mount a GitHub repository into the session's container. + +## Properties + +### authorization\_token + +> **authorization\_token**: `string` + +GitHub authorization token used to clone the repository. + +*** + +### checkout? + +> `optional` **checkout?**: [`ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion`](../type-aliases/ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion.md) \| `null` + +Branch or commit to check out. Defaults to the repository's default branch. + +*** + +### mount\_path? + +> `optional` **mount\_path?**: `string` \| `null` + +Mount path in the container. Defaults to `/workspace/`. + +*** + +### type + +> **type**: `"github_repository"` + +Any of "github_repository". + +*** + +### url + +> **url**: `string` + +Github URL of the repository diff --git a/docs/api/managed/interfaces/ManagedAgentsGlobToolConfig.md b/docs/api/managed/interfaces/ManagedAgentsGlobToolConfig.md new file mode 100644 index 0000000..7ef2109 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsGlobToolConfig.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGlobToolConfig + +# Interface: ManagedAgentsGlobToolConfig + +Configuration for the glob tool. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### name? + +> `optional` **name?**: `"glob"` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsGlobToolConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsGlobToolConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"glob"` diff --git a/docs/api/managed/interfaces/ManagedAgentsGlobToolConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsGlobToolConfigParams.md new file mode 100644 index 0000000..1e677f8 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsGlobToolConfigParams.md @@ -0,0 +1,44 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGlobToolConfigParams + +# Interface: ManagedAgentsGlobToolConfigParams + +Configuration override for the glob tool. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether this tool is enabled and available to Claude. Overrides the +default_config setting. + +*** + +### name? + +> `optional` **name?**: `"glob"` \| `null` + +Must be "glob". + +This field can be elided, and will marshal its zero value as "glob". + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"glob"` \| `null` + +Any of "glob". diff --git a/docs/api/managed/interfaces/ManagedAgentsGrepToolConfig.md b/docs/api/managed/interfaces/ManagedAgentsGrepToolConfig.md new file mode 100644 index 0000000..88ec34c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsGrepToolConfig.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGrepToolConfig + +# Interface: ManagedAgentsGrepToolConfig + +Configuration for the grep tool. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### name? + +> `optional` **name?**: `"grep"` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsGrepToolConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsGrepToolConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"grep"` diff --git a/docs/api/managed/interfaces/ManagedAgentsGrepToolConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsGrepToolConfigParams.md new file mode 100644 index 0000000..70aad72 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsGrepToolConfigParams.md @@ -0,0 +1,44 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGrepToolConfigParams + +# Interface: ManagedAgentsGrepToolConfigParams + +Configuration override for the grep tool. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether this tool is enabled and available to Claude. Overrides the +default_config setting. + +*** + +### name? + +> `optional` **name?**: `"grep"` \| `null` + +Must be "grep". + +This field can be elided, and will marshal its zero value as "grep". + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"grep"` \| `null` + +Any of "grep". diff --git a/docs/api/managed/interfaces/ManagedAgentsImageBlock.md b/docs/api/managed/interfaces/ManagedAgentsImageBlock.md new file mode 100644 index 0000000..48ab6da --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsImageBlock.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsImageBlock + +# Interface: ManagedAgentsImageBlock + +Image content specified directly as base64 data or as a reference via a URL. + +## Properties + +### source + +> **source**: [`ManagedAgentsImageBlockSourceUnion`](../type-aliases/ManagedAgentsImageBlockSourceUnion.md) + +Union type for image source variants. + +*** + +### type + +> **type**: `"image"` + +Any of "image". diff --git a/docs/api/managed/interfaces/ManagedAgentsImageBlockParam.md b/docs/api/managed/interfaces/ManagedAgentsImageBlockParam.md new file mode 100644 index 0000000..d50acc3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsImageBlockParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsImageBlockParam + +# Interface: ManagedAgentsImageBlockParam + +Image content specified directly as base64 data or as a reference via a URL. + +## Properties + +### source + +> **source**: [`ManagedAgentsImageBlockSourceUnionParam`](../type-aliases/ManagedAgentsImageBlockSourceUnionParam.md) + +Union type for image source variants. + +*** + +### type + +> **type**: `"image"` + +Any of "image". diff --git a/docs/api/managed/interfaces/ManagedAgentsInjectionLocationParams.md b/docs/api/managed/interfaces/ManagedAgentsInjectionLocationParams.md new file mode 100644 index 0000000..37f45e6 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsInjectionLocationParams.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsInjectionLocationParams + +# Interface: ManagedAgentsInjectionLocationParams + +Where in the outbound request the secret value may be substituted. + +## Properties + +### body? + +> `optional` **body?**: `boolean` \| `null` + +Substitute when the placeholder appears in the request body. + +*** + +### header? + +> `optional` **header?**: `boolean` \| `null` + +Substitute when the placeholder appears in a request header value. diff --git a/docs/api/managed/interfaces/ManagedAgentsInjectionLocationResponse.md b/docs/api/managed/interfaces/ManagedAgentsInjectionLocationResponse.md new file mode 100644 index 0000000..ee3a751 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsInjectionLocationResponse.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsInjectionLocationResponse + +# Interface: ManagedAgentsInjectionLocationResponse + +Where in the outbound request the secret value is substituted. + +## Properties + +### body + +> **body**: `boolean` + +Whether the placeholder is substituted in the request body. + +*** + +### header + +> **header**: `boolean` + +Whether the placeholder is substituted in request header values. diff --git a/docs/api/managed/interfaces/ManagedAgentsInjectionLocationUpdateParams.md b/docs/api/managed/interfaces/ManagedAgentsInjectionLocationUpdateParams.md new file mode 100644 index 0000000..bd27940 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsInjectionLocationUpdateParams.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsInjectionLocationUpdateParams + +# Interface: ManagedAgentsInjectionLocationUpdateParams + +Updated injection location. + +## Properties + +### body? + +> `optional` **body?**: `boolean` \| `null` + +Substitute when the placeholder appears in the request body. + +*** + +### header? + +> `optional` **header?**: `boolean` \| `null` + +Substitute when the placeholder appears in a request header value. diff --git a/docs/api/managed/interfaces/ManagedAgentsLimitedCredentialNetworkingParams.md b/docs/api/managed/interfaces/ManagedAgentsLimitedCredentialNetworkingParams.md new file mode 100644 index 0000000..6aafc70 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsLimitedCredentialNetworkingParams.md @@ -0,0 +1,28 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsLimitedCredentialNetworkingParams + +# Interface: ManagedAgentsLimitedCredentialNetworkingParams + +Substitute the secret only on requests to the listed hosts. + +## Properties + +### allowed\_hosts + +> **allowed\_hosts**: `string`[] + +Hostnames on which the secret will be substituted. Each entry is a bare hostname +(`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard +(`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At +most 16 entries. + +*** + +### type + +> **type**: `"limited"` + +Any of "limited". diff --git a/docs/api/managed/interfaces/ManagedAgentsLimitedCredentialNetworkingResponse.md b/docs/api/managed/interfaces/ManagedAgentsLimitedCredentialNetworkingResponse.md new file mode 100644 index 0000000..50f2e08 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsLimitedCredentialNetworkingResponse.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsLimitedCredentialNetworkingResponse + +# Interface: ManagedAgentsLimitedCredentialNetworkingResponse + +The secret is substituted only on requests to the listed hosts. + +## Properties + +### allowed\_hosts + +> **allowed\_hosts**: `string`[] + +Hostnames on which the secret will be substituted. An entry matches the request +host exactly; a `*.`-prefixed entry matches any subdomain of the named domain +but not the domain itself. + +*** + +### type + +> **type**: `"limited"` + +Any of "limited". diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPAuthenticationFailedError.md b/docs/api/managed/interfaces/ManagedAgentsMCPAuthenticationFailedError.md new file mode 100644 index 0000000..8dae40d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPAuthenticationFailedError.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPAuthenticationFailedError + +# Interface: ManagedAgentsMCPAuthenticationFailedError + +Authentication to an MCP server failed. + +## Properties + +### mcp\_server\_name + +> **mcp\_server\_name**: `string` + +Name of the MCP server that failed authentication. + +*** + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### retry\_status + +> **retry\_status**: [`ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion`](../type-aliases/ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion.md) + +What the client should do next in response to this error. + +*** + +### type + +> **type**: `"mcp_authentication_failed_error"` + +Any of "mcp_authentication_failed_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPConnectionFailedError.md b/docs/api/managed/interfaces/ManagedAgentsMCPConnectionFailedError.md new file mode 100644 index 0000000..470e168 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPConnectionFailedError.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPConnectionFailedError + +# Interface: ManagedAgentsMCPConnectionFailedError + +Failed to connect to an MCP server. + +## Properties + +### mcp\_server\_name + +> **mcp\_server\_name**: `string` + +Name of the MCP server that failed to connect. + +*** + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### retry\_status + +> **retry\_status**: [`ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion`](../type-aliases/ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion.md) + +What the client should do next in response to this error. + +*** + +### type + +> **type**: `"mcp_connection_failed_error"` + +Any of "mcp_connection_failed_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError.md new file mode 100644 index 0000000..cb6e1dd --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError + +# Interface: ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError + +An MCP server host used by the deployment's agent is blocked by the +environment's network policy. + +## Properties + +### type + +> **type**: `"mcp_egress_blocked_error"` + +Any of "mcp_egress_blocked_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPEgressBlockedRunError.md b/docs/api/managed/interfaces/ManagedAgentsMCPEgressBlockedRunError.md new file mode 100644 index 0000000..b90a6a4 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPEgressBlockedRunError.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPEgressBlockedRunError + +# Interface: ManagedAgentsMCPEgressBlockedRunError + +An MCP server host used by the deployment's agent is blocked by the +environment's network policy. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"mcp_egress_blocked_error"` + +Any of "mcp_egress_blocked_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPOAuthAuthResponse.md b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthAuthResponse.md new file mode 100644 index 0000000..b444b21 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthAuthResponse.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthAuthResponse + +# Interface: ManagedAgentsMCPOAuthAuthResponse + +OAuth credential details for an MCP server. + +## Properties + +### expires\_at? + +> `optional` **expires\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### mcp\_server\_url + +> **mcp\_server\_url**: `string` + +URL of the MCP server this credential authenticates against. + +*** + +### refresh? + +> `optional` **refresh?**: [`ManagedAgentsMCPOAuthRefreshResponse`](ManagedAgentsMCPOAuthRefreshResponse.md) \| `null` + +OAuth refresh token configuration returned in credential responses. + +*** + +### type + +> **type**: `"mcp_oauth"` + +Any of "mcp_oauth". diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPOAuthCreateParams.md b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthCreateParams.md new file mode 100644 index 0000000..9e6f5b8 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthCreateParams.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthCreateParams + +# Interface: ManagedAgentsMCPOAuthCreateParams + +Parameters for creating an MCP OAuth credential. + +## Properties + +### access\_token + +> **access\_token**: `string` + +OAuth access token. + +*** + +### expires\_at? + +> `optional` **expires\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### mcp\_server\_url + +> **mcp\_server\_url**: `string` + +URL of the MCP server this credential authenticates against. + +*** + +### refresh? + +> `optional` **refresh?**: [`ManagedAgentsMCPOAuthRefreshParams`](ManagedAgentsMCPOAuthRefreshParams.md) \| `null` + +OAuth refresh token parameters for creating a credential with refresh support. + +*** + +### type + +> **type**: `"mcp_oauth"` + +Any of "mcp_oauth". diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshParams.md b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshParams.md new file mode 100644 index 0000000..39fbd13 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshParams.md @@ -0,0 +1,57 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthRefreshParams + +# Interface: ManagedAgentsMCPOAuthRefreshParams + +OAuth refresh token parameters for creating a credential with refresh support. + +## Properties + +### client\_id + +> **client\_id**: `string` + +OAuth client ID. + +*** + +### refresh\_token + +> **refresh\_token**: `string` + +OAuth refresh token. + +*** + +### resource? + +> `optional` **resource?**: `string` \| `null` + +OAuth resource indicator. + +*** + +### scope? + +> `optional` **scope?**: `string` \| `null` + +OAuth scope for the refresh request. + +*** + +### token\_endpoint + +> **token\_endpoint**: `string` + +Token endpoint URL used to refresh the access token. + +*** + +### token\_endpoint\_auth + +> **token\_endpoint\_auth**: [`ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion`](../type-aliases/ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion.md) + +Token endpoint requires no client authentication. diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshResponse.md b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshResponse.md new file mode 100644 index 0000000..f5308b3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshResponse.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthRefreshResponse + +# Interface: ManagedAgentsMCPOAuthRefreshResponse + +OAuth refresh token configuration returned in credential responses. + +## Properties + +### client\_id + +> **client\_id**: `string` + +OAuth client ID. + +*** + +### resource? + +> `optional` **resource?**: `string` \| `null` + +OAuth resource indicator. + +*** + +### scope? + +> `optional` **scope?**: `string` \| `null` + +OAuth scope for the refresh request. + +*** + +### token\_endpoint + +> **token\_endpoint**: `string` + +Token endpoint URL used to refresh the access token. + +*** + +### token\_endpoint\_auth + +> **token\_endpoint\_auth**: [`ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion`](../type-aliases/ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion.md) + +Token endpoint requires no client authentication. diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshUpdateParams.md b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshUpdateParams.md new file mode 100644 index 0000000..6cc3e2e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthRefreshUpdateParams.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthRefreshUpdateParams + +# Interface: ManagedAgentsMCPOAuthRefreshUpdateParams + +Parameters for updating OAuth refresh token configuration. + +## Properties + +### refresh\_token? + +> `optional` **refresh\_token?**: `string` \| `null` + +Updated OAuth refresh token. + +*** + +### scope? + +> `optional` **scope?**: `string` \| `null` + +Updated OAuth scope for the refresh request. + +*** + +### token\_endpoint\_auth? + +> `optional` **token\_endpoint\_auth?**: [`ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion`](../type-aliases/ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion.md) \| `null` + +Updated HTTP Basic authentication parameters for the token endpoint. diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPOAuthUpdateParams.md b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthUpdateParams.md new file mode 100644 index 0000000..5772430 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPOAuthUpdateParams.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthUpdateParams + +# Interface: ManagedAgentsMCPOAuthUpdateParams + +Parameters for updating an MCP OAuth credential. The `mcp_server_url` is +immutable. + +## Properties + +### access\_token? + +> `optional` **access\_token?**: `string` \| `null` + +Updated OAuth access token. + +*** + +### expires\_at? + +> `optional` **expires\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### refresh? + +> `optional` **refresh?**: [`ManagedAgentsMCPOAuthRefreshUpdateParams`](ManagedAgentsMCPOAuthRefreshUpdateParams.md) \| `null` + +Parameters for updating OAuth refresh token configuration. + +*** + +### type + +> **type**: `"mcp_oauth"` + +Any of "mcp_oauth". diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPProbe.md b/docs/api/managed/interfaces/ManagedAgentsMCPProbe.md new file mode 100644 index 0000000..dac2736 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPProbe.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPProbe + +# Interface: ManagedAgentsMCPProbe + +The failing step of an MCP validation probe. + +## Properties + +### http\_response + +> **http\_response**: [`ManagedAgentsRefreshHTTPResponse`](ManagedAgentsRefreshHTTPResponse.md) + +An HTTP response captured during a credential validation probe. + +*** + +### method + +> **method**: `string` + +The MCP method that failed (for example `initialize` or `tools/list`). diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPServerURLDefinition.md b/docs/api/managed/interfaces/ManagedAgentsMCPServerURLDefinition.md new file mode 100644 index 0000000..332d3b9 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPServerURLDefinition.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPServerURLDefinition + +# Interface: ManagedAgentsMCPServerURLDefinition + +URL-based MCP server connection as returned in API responses. + +## Properties + +### name + +> **name**: `string` + +*** + +### type + +> **type**: `"url"` + +Any of "url". + +*** + +### url + +> **url**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPToolConfig.md b/docs/api/managed/interfaces/ManagedAgentsMCPToolConfig.md new file mode 100644 index 0000000..ade7e7a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPToolConfig.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolConfig + +# Interface: ManagedAgentsMCPToolConfig + +Resolved configuration for a specific MCP tool. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### name + +> **name**: `string` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsMCPToolConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsMCPToolConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPToolConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsMCPToolConfigParams.md new file mode 100644 index 0000000..5b1cbe3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPToolConfigParams.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolConfigParams + +# Interface: ManagedAgentsMCPToolConfigParams + +Configuration override for a specific MCP tool. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether this tool is enabled. Overrides the `default_config` setting. + +*** + +### name + +> **name**: `string` + +Name of the MCP tool to configure. 1-128 characters. + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPToolset.md b/docs/api/managed/interfaces/ManagedAgentsMCPToolset.md new file mode 100644 index 0000000..18cdfeb --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPToolset.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolset + +# Interface: ManagedAgentsMCPToolset + +## Properties + +### configs + +> **configs**: [`ManagedAgentsMCPToolConfig`](ManagedAgentsMCPToolConfig.md)[] + +*** + +### default\_config + +> **default\_config**: [`ManagedAgentsMCPToolsetDefaultConfig`](ManagedAgentsMCPToolsetDefaultConfig.md) + +Resolved default configuration for all tools from an MCP server. + +*** + +### mcp\_server\_name + +> **mcp\_server\_name**: `string` + +*** + +### type + +> **type**: `"mcp_toolset"` + +Any of "mcp_toolset". diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPToolsetDefaultConfig.md b/docs/api/managed/interfaces/ManagedAgentsMCPToolsetDefaultConfig.md new file mode 100644 index 0000000..48b294f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPToolsetDefaultConfig.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolsetDefaultConfig + +# Interface: ManagedAgentsMCPToolsetDefaultConfig + +Resolved default configuration for all tools from an MCP server. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPToolsetDefaultConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsMCPToolsetDefaultConfigParams.md new file mode 100644 index 0000000..166194a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPToolsetDefaultConfigParams.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolsetDefaultConfigParams + +# Interface: ManagedAgentsMCPToolsetDefaultConfigParams + +Default configuration for all tools from an MCP server. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether tools are enabled by default. Defaults to true if not specified. + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. diff --git a/docs/api/managed/interfaces/ManagedAgentsMCPToolsetParams.md b/docs/api/managed/interfaces/ManagedAgentsMCPToolsetParams.md new file mode 100644 index 0000000..a919de4 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMCPToolsetParams.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolsetParams + +# Interface: ManagedAgentsMCPToolsetParams + +Configuration for tools from an MCP server defined in `mcp_servers`. + +## Properties + +### configs? + +> `optional` **configs?**: [`ManagedAgentsMCPToolConfigParams`](ManagedAgentsMCPToolConfigParams.md)[] \| `null` + +Per-tool configuration overrides. + +*** + +### default\_config? + +> `optional` **default\_config?**: [`ManagedAgentsMCPToolsetDefaultConfigParams`](ManagedAgentsMCPToolsetDefaultConfigParams.md) \| `null` + +Default configuration for all tools from an MCP server. + +*** + +### mcp\_server\_name + +> **mcp\_server\_name**: `string` + +Name of the MCP server. Must match a server name from the mcp_servers array. +1-255 characters. + +*** + +### type + +> **type**: `"mcp_toolset"` + +Any of "mcp_toolset". diff --git a/docs/api/managed/interfaces/ManagedAgentsManualDeploymentPausedReason.md b/docs/api/managed/interfaces/ManagedAgentsManualDeploymentPausedReason.md new file mode 100644 index 0000000..82de264 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsManualDeploymentPausedReason.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsManualDeploymentPausedReason + +# Interface: ManagedAgentsManualDeploymentPausedReason + +The caller invoked the pause endpoint on the deployment. + +## Properties + +### type + +> **type**: `"manual"` + +Any of "manual". diff --git a/docs/api/managed/interfaces/ManagedAgentsManualTriggerContext.md b/docs/api/managed/interfaces/ManagedAgentsManualTriggerContext.md new file mode 100644 index 0000000..8c4a6b8 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsManualTriggerContext.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsManualTriggerContext + +# Interface: ManagedAgentsManualTriggerContext + +The run was started manually by creating a session directly against the +deployment. + +## Properties + +### type + +> **type**: `"manual"` + +Any of "manual". diff --git a/docs/api/managed/interfaces/ManagedAgentsMemory.md b/docs/api/managed/interfaces/ManagedAgentsMemory.md new file mode 100644 index 0000000..9ea71d4 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMemory.md @@ -0,0 +1,112 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemory + +# Interface: ManagedAgentsMemory + +A `memory` object: a single text document at a hierarchical path inside a memory +store. The `content` field is populated when `view=full` and `null` when +`view=basic`; the `content_size_bytes` and `content_sha256` fields are always +populated so sync clients can diff without fetching content. Memories are +addressed by their `mem_...` ID; the path is the create key and can be changed +via update. + +## Properties + +### content? + +> `optional` **content?**: `string` \| `null` + +The memory's UTF-8 text content. Populated when `view=full`; `null` when +`view=basic`. Maximum 100 kB (102,400 bytes). + +*** + +### content\_sha256 + +> **content\_sha256**: `string` + +Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The +server applies no normalization, so clients can compute the same hash locally +for staleness checks and as the value for a `content_sha256` precondition on +update. Always populated, regardless of `view`. + +*** + +### content\_size\_bytes + +> **content\_size\_bytes**: `number` + +Size of `content` in bytes (the UTF-8 plaintext length). Always populated, +regardless of `view`. + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### id + +> **id**: `string` + +Unique identifier for this memory (a `mem_...` value). Stable across renames; +use this ID, not the path, to read, update, or delete the memory. + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +ID of the memory store this memory belongs to (a `memstore_...` value). + +*** + +### memory\_version\_id + +> **memory\_version\_id**: `string` + +ID of the `memory_version` representing this memory's current content (a +`memver_...` value). This is the authoritative head pointer; `memory_version` +objects do not carry an `is_latest` flag, so compare against this field instead. +Enumerate the history via +[List memory versions](/en/api/beta/memory_stores/memory_versions/list). + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> + +*** + +### path + +> **path**: `string` + +Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. +Always starts with `/`. Paths are case-sensitive and unique within a store. +Maximum 1,024 bytes. + +*** + +### type + +> **type**: `"memory"` + +Any of "memory". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format diff --git a/docs/api/managed/interfaces/ManagedAgentsMemoryPrefix.md b/docs/api/managed/interfaces/ManagedAgentsMemoryPrefix.md new file mode 100644 index 0000000..74f018f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMemoryPrefix.md @@ -0,0 +1,32 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryPrefix + +# Interface: ManagedAgentsMemoryPrefix + +A rolled-up directory marker returned by +[List memories](/en/api/beta/memory_stores/memories/list) when `depth` is set. +Indicates that one or more memories exist deeper than the requested depth under +this prefix. This is a list-time rollup, not a stored resource; it has no ID and +no lifecycle. Each prefix counts toward the page `limit` and interleaves with +`memory` items in path order. + +## Properties + +### path + +> **path**: `string` + +The rolled-up path prefix, including a trailing `/` (e.g. `/projects/foo/`). +Pass this value as `path_prefix` on a subsequent list call to drill into the +directory. + +*** + +### type + +> **type**: `"memory_prefix"` + +Any of "memory_prefix". diff --git a/docs/api/managed/interfaces/ManagedAgentsMemoryStore.md b/docs/api/managed/interfaces/ManagedAgentsMemoryStore.md new file mode 100644 index 0000000..246de10 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMemoryStore.md @@ -0,0 +1,82 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStore + +# Interface: ManagedAgentsMemoryStore + +A `memory_store`: a named container for agent memories, scoped to a workspace. +Attach a store to a session via `resources[]` to mount it as a directory the +agent can read and write. + +## Properties + +### archived\_at? + +> `optional` **archived\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### description? + +> `optional` **description?**: `string` + +Free-text description of what the store contains, up to 1024 characters. +Included in the agent's system prompt when the store is attached, so word it to +be useful to the agent. Empty string when unset. + +*** + +### id + +> **id**: `string` + +Unique identifier for the memory store (a `memstore_...` tagged ID). Use this +when attaching the store to a session, or in the `{memory_store_id}` path +parameter of subsequent calls. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> + +Arbitrary key-value tags for your own bookkeeping (such as the end user a store +belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. +Returned on retrieve/list but not filterable. + +*** + +### name + +> **name**: `string` + +Human-readable name for the store. 1–255 characters. The store's mount-path slug +under `/mnt/memory/` is derived from this name. + +*** + +### type + +> **type**: `"memory_store"` + +Any of "memory_store". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format diff --git a/docs/api/managed/interfaces/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError.md new file mode 100644 index 0000000..e818bdc --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError + +# Interface: ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError + +A memory store referenced by the deployment is archived. + +## Properties + +### type + +> **type**: `"memory_store_archived_error"` + +Any of "memory_store_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsMemoryStoreArchivedRunError.md b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreArchivedRunError.md new file mode 100644 index 0000000..babd4b2 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreArchivedRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreArchivedRunError + +# Interface: ManagedAgentsMemoryStoreArchivedRunError + +A memory store referenced by the deployment is archived. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"memory_store_archived_error"` + +Any of "memory_store_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsMemoryStoreResource.md b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreResource.md new file mode 100644 index 0000000..eabdf2d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreResource.md @@ -0,0 +1,72 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreResource + +# Interface: ManagedAgentsMemoryStoreResource + +A memory store attached to an agent session. + +## Properties + +### access? + +> `optional` **access?**: [`ManagedAgentsMemoryStoreResourceAccess`](../type-aliases/ManagedAgentsMemoryStoreResourceAccess.md) \| `null` + +Access mode for an attached memory store. + +Any of "read_write", "read_only". + +*** + +### description? + +> `optional` **description?**: `string` + +Description of the memory store, snapshotted at attach time. Rendered into the +agent's system prompt. Empty string when the store has no description. + +*** + +### instructions? + +> `optional` **instructions?**: `string` \| `null` + +Per-attachment guidance for the agent on how to use this store. Rendered into +the memory section of the system prompt. Max 4096 chars. + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +The memory store ID (memstore\_...). Must belong to the caller's organization +and workspace. + +*** + +### mount\_path? + +> `optional` **mount\_path?**: `string` \| `null` + +Filesystem path where the store is mounted in the session container, e.g. +/mnt/memory/user-preferences. Derived from the store's name. Output-only. + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +Display name of the memory store, snapshotted at attach time. Later edits to the +store's name do not propagate to this resource. + +*** + +### type + +> **type**: `"memory_store"` + +Any of "memory_store". diff --git a/docs/api/managed/interfaces/ManagedAgentsMemoryStoreResourceConfig.md b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreResourceConfig.md new file mode 100644 index 0000000..650483e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreResourceConfig.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreResourceConfig + +# Interface: ManagedAgentsMemoryStoreResourceConfig + +A memory store attached to each session created from this deployment. + +## Properties + +### access? + +> `optional` **access?**: [`ManagedAgentsMemoryStoreResourceConfigAccess`](../type-aliases/ManagedAgentsMemoryStoreResourceConfigAccess.md) \| `null` + +Access mode for an attached memory store. + +Any of "read_write", "read_only". + +*** + +### instructions? + +> `optional` **instructions?**: `string` \| `null` + +Per-attachment guidance for the agent on how to use this store. Rendered into +the memory section of the system prompt. Max 4096 chars. + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +The memory store ID (memstore\_...). Must belong to the caller's organization +and workspace. + +*** + +### type + +> **type**: `"memory_store"` + +Any of "memory_store". diff --git a/docs/api/managed/interfaces/ManagedAgentsMemoryStoreResourceParam.md b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreResourceParam.md new file mode 100644 index 0000000..e600612 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMemoryStoreResourceParam.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreResourceParam + +# Interface: ManagedAgentsMemoryStoreResourceParam + +Parameters for attaching a memory store to an agent session. + +## Properties + +### access? + +> `optional` **access?**: [`ManagedAgentsMemoryStoreResourceParamAccess`](../type-aliases/ManagedAgentsMemoryStoreResourceParamAccess.md) \| `null` + +Access mode for an attached memory store. + +Any of "read_write", "read_only". + +*** + +### instructions? + +> `optional` **instructions?**: `string` \| `null` + +Per-attachment guidance for the agent on how to use this store. Rendered into +the memory section of the system prompt. Max 4096 chars. + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +The memory store ID (memstore\_...). Must belong to the caller's organization +and workspace. + +*** + +### type + +> **type**: `"memory_store"` + +Any of "memory_store". diff --git a/docs/api/managed/interfaces/ManagedAgentsMemoryVersion.md b/docs/api/managed/interfaces/ManagedAgentsMemoryVersion.md new file mode 100644 index 0000000..8c2bbf4 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMemoryVersion.md @@ -0,0 +1,140 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryVersion + +# Interface: ManagedAgentsMemoryVersion + +A `memory_version` object: one immutable, attributed row in a memory's +append-only history. Every non-no-op mutation to a memory produces a new +version. Versions belong to the store (not the individual memory) and are not +deleted with the memory; each version is retained for at least the version +retention period after it was written, unless the store itself is deleted. +Retrieving a redacted version returns 200 with `content`, `path`, +`content_size_bytes`, and `content_sha256` set to `null`; branch on +`redacted_at`, not HTTP status. + +## Properties + +### content? + +> `optional` **content?**: `string` \| `null` + +The memory's UTF-8 text content as of this version. `null` when `view=basic`, +when `operation` is `deleted`, or when `redacted_at` is set. + +*** + +### content\_sha256? + +> `optional` **content\_sha256?**: `string` \| `null` + +Lowercase hex SHA-256 digest of `content` as of this version (64 characters). +`null` when `redacted_at` is set or `operation` is `deleted`. Populated +regardless of `view` otherwise. + +*** + +### content\_size\_bytes? + +> `optional` **content\_size\_bytes?**: `number` \| `null` + +Size of `content` in bytes as of this version. `null` when `redacted_at` is set +or `operation` is `deleted`. Populated regardless of `view` otherwise. + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### created\_by? + +> `optional` **created\_by?**: [`ManagedAgentsActorUnion`](../type-aliases/ManagedAgentsActorUnion.md) + +Identifies who performed a write or redact operation. Captured at write time on +the `memory_version` row. The API key that created a session is not recorded on +agent writes; attribution answers who made the write, not who is ultimately +responsible. Look up session provenance separately via the +[Sessions API](/en/api/beta/sessions/retrieve). + +*** + +### id + +> **id**: `string` + +Unique identifier for this version (a `memver_...` value). + +*** + +### memory\_id + +> **memory\_id**: `string` + +ID of the memory this version snapshots (a `mem_...` value). Remains valid after +the memory is deleted; pass it as `memory_id` to +[List memory versions](/en/api/beta/memory_stores/memory_versions/list) to +retrieve the memory's retained versions, including the `deleted` row while the +lineage is retained. + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +ID of the memory store this version belongs to (a `memstore_...` value). + +*** + +### operation + +> **operation**: [`ManagedAgentsMemoryVersionOperation`](../type-aliases/ManagedAgentsMemoryVersionOperation.md) + +The kind of mutation a `memory_version` records. Every non-no-op mutation to a +memory appends exactly one version row with one of these values. + +Any of "created", "modified", "deleted". + +*** + +### path? + +> `optional` **path?**: `string` \| `null` + +The memory's path at the time of this write. `null` if and only if `redacted_at` +is set. + +*** + +### redacted\_at? + +> `optional` **redacted\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### redacted\_by? + +> `optional` **redacted\_by?**: [`ManagedAgentsActorUnion`](../type-aliases/ManagedAgentsActorUnion.md) + +Identifies who performed a write or redact operation. Captured at write time on +the `memory_version` row. The API key that created a session is not recorded on +agent writes; attribution answers who made the write, not who is ultimately +responsible. Look up session provenance separately via the +[Sessions API](/en/api/beta/sessions/retrieve). + +*** + +### type + +> **type**: `"memory_version"` + +Any of "memory_version". diff --git a/docs/api/managed/interfaces/ManagedAgentsModelOverloadedError.md b/docs/api/managed/interfaces/ManagedAgentsModelOverloadedError.md new file mode 100644 index 0000000..6763418 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsModelOverloadedError.md @@ -0,0 +1,34 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelOverloadedError + +# Interface: ManagedAgentsModelOverloadedError + +The model is currently overloaded. Emitted after automatic retries are +exhausted. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### retry\_status + +> **retry\_status**: [`ManagedAgentsModelOverloadedErrorRetryStatusUnion`](../type-aliases/ManagedAgentsModelOverloadedErrorRetryStatusUnion.md) + +What the client should do next in response to this error. + +*** + +### type + +> **type**: `"model_overloaded_error"` + +Any of "model_overloaded_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsModelRateLimitedError.md b/docs/api/managed/interfaces/ManagedAgentsModelRateLimitedError.md new file mode 100644 index 0000000..bd42315 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsModelRateLimitedError.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelRateLimitedError + +# Interface: ManagedAgentsModelRateLimitedError + +The model request was rate-limited. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### retry\_status + +> **retry\_status**: [`ManagedAgentsModelRateLimitedErrorRetryStatusUnion`](../type-aliases/ManagedAgentsModelRateLimitedErrorRetryStatusUnion.md) + +What the client should do next in response to this error. + +*** + +### type + +> **type**: `"model_rate_limited_error"` + +Any of "model_rate_limited_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsModelRequestFailedError.md b/docs/api/managed/interfaces/ManagedAgentsModelRequestFailedError.md new file mode 100644 index 0000000..6f7cfd1 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsModelRequestFailedError.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelRequestFailedError + +# Interface: ManagedAgentsModelRequestFailedError + +A model request failed for a reason other than overload or rate-limiting. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### retry\_status + +> **retry\_status**: [`ManagedAgentsModelRequestFailedErrorRetryStatusUnion`](../type-aliases/ManagedAgentsModelRequestFailedErrorRetryStatusUnion.md) + +What the client should do next in response to this error. + +*** + +### type + +> **type**: `"model_request_failed_error"` + +Any of "model_request_failed_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsMultiagent.md b/docs/api/managed/interfaces/ManagedAgentsMultiagent.md new file mode 100644 index 0000000..33de525 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMultiagent.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMultiagent + +# Interface: ManagedAgentsMultiagent + +Resolved coordinator topology with a concrete agent roster. + +## Properties + +### agents + +> **agents**: [`ManagedAgentsMultiagentAgentUnion`](../type-aliases/ManagedAgentsMultiagentAgentUnion.md)[] + +Agents the coordinator may spawn as session threads, each resolved to a specific +version. + +*** + +### type + +> **type**: `"coordinator"` + +Any of "coordinator". diff --git a/docs/api/managed/interfaces/ManagedAgentsMultiagentParams.md b/docs/api/managed/interfaces/ManagedAgentsMultiagentParams.md new file mode 100644 index 0000000..26fb3f2 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMultiagentParams.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMultiagentParams + +# Interface: ManagedAgentsMultiagentParams + +A coordinator topology: the session's primary thread orchestrates work by +spawning session threads, each running an agent drawn from the `agents` roster. + +## Properties + +### agents + +> **agents**: [`ManagedAgentsMultiagentRosterEntryParamsUnion`](../type-aliases/ManagedAgentsMultiagentRosterEntryParamsUnion.md)[] + +Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is +an agent ID string, a versioned `{"type":"agent","id","version"}` reference, or +`{"type":"self"}` to allow recursive self-invocation. Entries must reference +distinct agents (after resolving `self` and string forms); at most one `self`. +Referenced agents must exist, must not be archived, and must not themselves have +`multiagent` set (depth limit 1). + +*** + +### type + +> **type**: `"coordinator"` + +Any of "coordinator". diff --git a/docs/api/managed/interfaces/ManagedAgentsMultiagentSelfParams.md b/docs/api/managed/interfaces/ManagedAgentsMultiagentSelfParams.md new file mode 100644 index 0000000..55deebb --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsMultiagentSelfParams.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMultiagentSelfParams + +# Interface: ManagedAgentsMultiagentSelfParams + +Sentinel roster entry meaning "the agent that owns this configuration". Resolved +server-side to a concrete agent reference. + +## Properties + +### type + +> **type**: `"self"` + +Any of "self". diff --git a/docs/api/managed/interfaces/ManagedAgentsOrganizationDisabledDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsOrganizationDisabledDeploymentPausedReasonError.md new file mode 100644 index 0000000..c121fe8 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsOrganizationDisabledDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsOrganizationDisabledDeploymentPausedReasonError + +# Interface: ManagedAgentsOrganizationDisabledDeploymentPausedReasonError + +The deployment's organization is disabled. + +## Properties + +### type + +> **type**: `"organization_disabled_error"` + +Any of "organization_disabled_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsOrganizationDisabledRunError.md b/docs/api/managed/interfaces/ManagedAgentsOrganizationDisabledRunError.md new file mode 100644 index 0000000..ced167d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsOrganizationDisabledRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsOrganizationDisabledRunError + +# Interface: ManagedAgentsOrganizationDisabledRunError + +The deployment's organization is disabled. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"organization_disabled_error"` + +Any of "organization_disabled_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsOutcomeEvaluationResource.md b/docs/api/managed/interfaces/ManagedAgentsOutcomeEvaluationResource.md new file mode 100644 index 0000000..4ae01ed --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsOutcomeEvaluationResource.md @@ -0,0 +1,69 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsOutcomeEvaluationResource + +# Interface: ManagedAgentsOutcomeEvaluationResource + +Evaluation state for a single outcome defined via a `define_outcome` event. + +## Properties + +### completed\_at + +> **completed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### description + +> **description**: `string` + +What the agent should produce. + +*** + +### explanation + +> **explanation**: `string` + +Grader's verdict text from the most recent evaluation. For `satisfied`, explains +why criteria are met; for `needs_revision` (intermediate), what's missing; for +`failed`, why unrecoverable. + +*** + +### iteration + +> **iteration**: `number` + +0-indexed revision cycle the outcome is currently on. + +*** + +### outcome\_id + +> **outcome\_id**: `string` + +Server-generated outc\_ ID for this outcome. + +*** + +### result + +> **result**: `string` + +Current evaluation state. `pending` before the agent begins work; `running` +while producing or revising; `evaluating` while the grader scores; +`satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal. + +*** + +### type + +> **type**: `"outcome_evaluation"` + +Any of "outcome_evaluation". diff --git a/docs/api/managed/interfaces/ManagedAgentsPlainTextDocumentSource.md b/docs/api/managed/interfaces/ManagedAgentsPlainTextDocumentSource.md new file mode 100644 index 0000000..0127fdf --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsPlainTextDocumentSource.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsPlainTextDocumentSource + +# Interface: ManagedAgentsPlainTextDocumentSource + +Plain text document content. + +## Properties + +### data + +> **data**: `string` + +The plain text content. + +*** + +### media\_type + +> **media\_type**: `"text/plain"` + +MIME type of the text content. Must be "text/plain". + +Any of "text/plain". + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsPlainTextDocumentSourceParam.md b/docs/api/managed/interfaces/ManagedAgentsPlainTextDocumentSourceParam.md new file mode 100644 index 0000000..7a05891 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsPlainTextDocumentSourceParam.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsPlainTextDocumentSourceParam + +# Interface: ManagedAgentsPlainTextDocumentSourceParam + +Plain text document content. + +## Properties + +### data + +> **data**: `string` + +The plain text content. + +*** + +### media\_type + +> **media\_type**: `"text/plain"` + +MIME type of the text content. Must be "text/plain". + +Any of "text/plain". + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsPreconditionParam.md b/docs/api/managed/interfaces/ManagedAgentsPreconditionParam.md new file mode 100644 index 0000000..ba0b250 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsPreconditionParam.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsPreconditionParam + +# Interface: ManagedAgentsPreconditionParam + +Optimistic-concurrency precondition: the update applies only if the memory's +stored `content_sha256` equals the supplied value. On mismatch, the request +returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and +retry against the fresh state. If the precondition fails but the stored state +already exactly matches the requested `content` and `path`, the server returns +200 instead of 409. + +## Properties + +### content\_sha256? + +> `optional` **content\_sha256?**: `string` \| `null` + +Expected `content_sha256` of the stored memory (64 lowercase hexadecimal +characters). Typically the `content_sha256` returned by a prior read or list +call. Because the server applies no content normalization, clients can also +compute this locally as the SHA-256 of the UTF-8 content bytes. + +*** + +### type + +> **type**: `"content_sha256"` + +Any of "content_sha256". diff --git a/docs/api/managed/interfaces/ManagedAgentsQoderSkill.md b/docs/api/managed/interfaces/ManagedAgentsQoderSkill.md new file mode 100644 index 0000000..356f2fc --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsQoderSkill.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsQoderSkill + +# Interface: ManagedAgentsQoderSkill + +A resolved Qoder-managed skill. + +## Properties + +### skill\_id + +> **skill\_id**: `string` + +*** + +### type + +> **type**: `"qoder"` + +Any of "qoder". + +*** + +### version + +> **version**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsQoderSkillParams.md b/docs/api/managed/interfaces/ManagedAgentsQoderSkillParams.md new file mode 100644 index 0000000..06a14ab --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsQoderSkillParams.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsQoderSkillParams + +# Interface: ManagedAgentsQoderSkillParams + +An Qoder-managed skill. + +## Properties + +### skill\_id + +> **skill\_id**: `string` + +Identifier of the Qoder skill (e.g., "xlsx"). + +*** + +### type + +> **type**: `"qoder"` + +Any of "qoder". + +*** + +### version? + +> `optional` **version?**: `string` \| `null` + +Version to pin. Defaults to latest if omitted. diff --git a/docs/api/managed/interfaces/ManagedAgentsReadToolConfig.md b/docs/api/managed/interfaces/ManagedAgentsReadToolConfig.md new file mode 100644 index 0000000..199d535 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsReadToolConfig.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsReadToolConfig + +# Interface: ManagedAgentsReadToolConfig + +Configuration for the read tool. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### name? + +> `optional` **name?**: `"read"` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsReadToolConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsReadToolConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"read"` diff --git a/docs/api/managed/interfaces/ManagedAgentsReadToolConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsReadToolConfigParams.md new file mode 100644 index 0000000..63965f2 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsReadToolConfigParams.md @@ -0,0 +1,44 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsReadToolConfigParams + +# Interface: ManagedAgentsReadToolConfigParams + +Configuration override for the read tool. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether this tool is enabled and available to Claude. Overrides the +default_config setting. + +*** + +### name? + +> `optional` **name?**: `"read"` \| `null` + +Must be "read". + +This field can be elided, and will marshal its zero value as "read". + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsReadToolConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsReadToolConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"read"` \| `null` + +Any of "read". diff --git a/docs/api/managed/interfaces/ManagedAgentsRedactedBlock.md b/docs/api/managed/interfaces/ManagedAgentsRedactedBlock.md new file mode 100644 index 0000000..2d2545b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsRedactedBlock.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRedactedBlock + +# Interface: ManagedAgentsRedactedBlock + +Placeholder for content withheld by Qoder model policy. + +## Properties + +### type + +> **type**: `"redacted"` + +Any of "redacted". diff --git a/docs/api/managed/interfaces/ManagedAgentsRedactedBlockParam.md b/docs/api/managed/interfaces/ManagedAgentsRedactedBlockParam.md new file mode 100644 index 0000000..092af13 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsRedactedBlockParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRedactedBlockParam + +# Interface: ManagedAgentsRedactedBlockParam + +Placeholder for content withheld by Qoder model policy. + +## Properties + +### type + +> **type**: `"redacted"` + +Any of "redacted". diff --git a/docs/api/managed/interfaces/ManagedAgentsRefreshHTTPResponse.md b/docs/api/managed/interfaces/ManagedAgentsRefreshHTTPResponse.md new file mode 100644 index 0000000..4bc3ba9 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsRefreshHTTPResponse.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRefreshHTTPResponse + +# Interface: ManagedAgentsRefreshHTTPResponse + +An HTTP response captured during a credential validation probe. + +## Properties + +### body + +> **body**: `string` + +Response body. May be truncated and has sensitive values scrubbed. + +*** + +### body\_truncated + +> **body\_truncated**: `boolean` + +Whether `body` was truncated. + +*** + +### content\_type + +> **content\_type**: `string` + +Value of the `Content-Type` response header. + +*** + +### status\_code + +> **status\_code**: `number` + +HTTP status code. diff --git a/docs/api/managed/interfaces/ManagedAgentsRefreshObject.md b/docs/api/managed/interfaces/ManagedAgentsRefreshObject.md new file mode 100644 index 0000000..d44560e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsRefreshObject.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRefreshObject + +# Interface: ManagedAgentsRefreshObject + +Outcome of a refresh-token exchange attempted during credential validation. + +## Properties + +### http\_response + +> **http\_response**: [`ManagedAgentsRefreshHTTPResponse`](ManagedAgentsRefreshHTTPResponse.md) \| `null` + +An HTTP response captured during a credential validation probe. + +*** + +### status + +> **status**: [`ManagedAgentsRefreshObjectStatus`](../type-aliases/ManagedAgentsRefreshObjectStatus.md) + +Outcome of a refresh-token exchange attempted during credential validation. + +Any of "succeeded", "failed", "connect_error", "no_refresh_token". diff --git a/docs/api/managed/interfaces/ManagedAgentsRetryStatusExhausted.md b/docs/api/managed/interfaces/ManagedAgentsRetryStatusExhausted.md new file mode 100644 index 0000000..611247e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsRetryStatusExhausted.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRetryStatusExhausted + +# Interface: ManagedAgentsRetryStatusExhausted + +This turn is dead; queued inputs are flushed and the session returns to idle. +Client may send a new prompt. + +## Properties + +### type + +> **type**: `"exhausted"` + +Any of "exhausted". diff --git a/docs/api/managed/interfaces/ManagedAgentsRetryStatusRetrying.md b/docs/api/managed/interfaces/ManagedAgentsRetryStatusRetrying.md new file mode 100644 index 0000000..8304ce2 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsRetryStatusRetrying.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRetryStatusRetrying + +# Interface: ManagedAgentsRetryStatusRetrying + +The server is retrying automatically. Client should wait; the same error type +may fire again as retrying, then once as exhausted when the retry budget runs +out. + +## Properties + +### type + +> **type**: `"retrying"` + +Any of "retrying". diff --git a/docs/api/managed/interfaces/ManagedAgentsRetryStatusTerminal.md b/docs/api/managed/interfaces/ManagedAgentsRetryStatusTerminal.md new file mode 100644 index 0000000..c92a8ce --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsRetryStatusTerminal.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRetryStatusTerminal + +# Interface: ManagedAgentsRetryStatusTerminal + +The session encountered a terminal error and will transition to `terminated` +state. + +## Properties + +### type + +> **type**: `"terminal"` + +Any of "terminal". diff --git a/docs/api/managed/interfaces/ManagedAgentsSchedule.md b/docs/api/managed/interfaces/ManagedAgentsSchedule.md new file mode 100644 index 0000000..2ccd21d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSchedule.md @@ -0,0 +1,57 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSchedule + +# Interface: ManagedAgentsSchedule + +5-field POSIX cron schedule with computed runtime timestamps. + +## Properties + +### expression + +> **expression**: `string` + +5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., +"0 9 \* \* 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean +Sunday. Extended cron syntax - seconds or year fields, and the special +characters L, W, #, and ? - is not supported, nor are predefined shortcuts +(@daily). + +*** + +### last\_run\_at? + +> `optional` **last\_run\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### timezone + +> **timezone**: `string` + +IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + +*** + +### type + +> **type**: `"cron"` + +Any of "cron". + +*** + +### upcoming\_runs\_at? + +> `optional` **upcoming\_runs\_at?**: `string`[] + +Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused +deployments (reflects what the schedule would do if unpaused); empty once the +deployment is archived (`archived_at` set). Each fire is offset by a small +per-schedule jitter, so a run will actually start at or shortly after its listed +time. diff --git a/docs/api/managed/interfaces/ManagedAgentsScheduleParams.md b/docs/api/managed/interfaces/ManagedAgentsScheduleParams.md new file mode 100644 index 0000000..0c6670f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsScheduleParams.md @@ -0,0 +1,39 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsScheduleParams + +# Interface: ManagedAgentsScheduleParams + +5-field POSIX cron schedule. Literal wall-clock matching in the configured +timezone. + +## Properties + +### expression + +> **expression**: `string` + +5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., +"0 9 \* \* 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean +Sunday. Extended cron syntax - seconds or year fields, and the special +characters L, W, #, and ? - is not supported, nor are predefined shortcuts +(@daily). + +*** + +### timezone + +> **timezone**: `string` + +Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). +Validated against the IANA timezone database. + +*** + +### type + +> **type**: `"cron"` + +Any of "cron". diff --git a/docs/api/managed/interfaces/ManagedAgentsScheduleTriggerContext.md b/docs/api/managed/interfaces/ManagedAgentsScheduleTriggerContext.md new file mode 100644 index 0000000..4765d51 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsScheduleTriggerContext.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsScheduleTriggerContext + +# Interface: ManagedAgentsScheduleTriggerContext + +The run was fired by the deployment's cron schedule. + +## Properties + +### scheduled\_at + +> **scheduled\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"schedule"` + +Any of "schedule". diff --git a/docs/api/managed/interfaces/ManagedAgentsSearchResultBlock.md b/docs/api/managed/interfaces/ManagedAgentsSearchResultBlock.md new file mode 100644 index 0000000..9b65f18 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSearchResultBlock.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSearchResultBlock + +# Interface: ManagedAgentsSearchResultBlock + +A block containing a web search result. + +## Properties + +### citations + +> **citations**: [`ManagedAgentsSearchResultCitations`](ManagedAgentsSearchResultCitations.md) + +Citation settings for a search result. + +*** + +### content + +> **content**: [`ManagedAgentsSearchResultContent`](ManagedAgentsSearchResultContent.md)[] + +Array of text content blocks from the search result. + +*** + +### source + +> **source**: `string` + +The URL source of the search result. + +*** + +### title + +> **title**: `string` + +The title of the search result. + +*** + +### type + +> **type**: `"search_result"` + +Any of "search_result". diff --git a/docs/api/managed/interfaces/ManagedAgentsSearchResultBlockParam.md b/docs/api/managed/interfaces/ManagedAgentsSearchResultBlockParam.md new file mode 100644 index 0000000..2f96812 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSearchResultBlockParam.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSearchResultBlockParam + +# Interface: ManagedAgentsSearchResultBlockParam + +A block containing a web search result. + +## Properties + +### citations + +> **citations**: [`ManagedAgentsSearchResultCitationsParam`](ManagedAgentsSearchResultCitationsParam.md) + +Citation settings for a search result. + +*** + +### content + +> **content**: [`ManagedAgentsSearchResultContentParam`](ManagedAgentsSearchResultContentParam.md)[] + +Array of text content blocks from the search result. + +*** + +### source + +> **source**: `string` + +The URL source of the search result. + +*** + +### title + +> **title**: `string` + +The title of the search result. + +*** + +### type + +> **type**: `"search_result"` + +Any of "search_result". diff --git a/docs/api/managed/interfaces/ManagedAgentsSearchResultCitations.md b/docs/api/managed/interfaces/ManagedAgentsSearchResultCitations.md new file mode 100644 index 0000000..429b075 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSearchResultCitations.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSearchResultCitations + +# Interface: ManagedAgentsSearchResultCitations + +Citation settings for a search result. + +## Properties + +### enabled + +> **enabled**: `boolean` + +Whether citations are enabled for this search result. diff --git a/docs/api/managed/interfaces/ManagedAgentsSearchResultCitationsParam.md b/docs/api/managed/interfaces/ManagedAgentsSearchResultCitationsParam.md new file mode 100644 index 0000000..e8d88a4 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSearchResultCitationsParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSearchResultCitationsParam + +# Interface: ManagedAgentsSearchResultCitationsParam + +Citation settings for a search result. + +## Properties + +### enabled + +> **enabled**: `boolean` + +Whether citations are enabled for this search result. diff --git a/docs/api/managed/interfaces/ManagedAgentsSearchResultContent.md b/docs/api/managed/interfaces/ManagedAgentsSearchResultContent.md new file mode 100644 index 0000000..2df0e15 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSearchResultContent.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSearchResultContent + +# Interface: ManagedAgentsSearchResultContent + +Text content within a search result. + +## Properties + +### text + +> **text**: `string` + +The text content. + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsSearchResultContentParam.md b/docs/api/managed/interfaces/ManagedAgentsSearchResultContentParam.md new file mode 100644 index 0000000..414298b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSearchResultContentParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSearchResultContentParam + +# Interface: ManagedAgentsSearchResultContentParam + +Text content within a search result. + +## Properties + +### text + +> **text**: `string` + +The text content. + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError.md new file mode 100644 index 0000000..4b8338e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError + +# Interface: ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError + +The deployment configures resources, but its environment is self-hosted and +cannot mount them. + +## Properties + +### type + +> **type**: `"self_hosted_resources_unsupported_error"` + +Any of "self_hosted_resources_unsupported_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsSelfHostedResourcesUnsupportedRunError.md b/docs/api/managed/interfaces/ManagedAgentsSelfHostedResourcesUnsupportedRunError.md new file mode 100644 index 0000000..65ea4d6 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSelfHostedResourcesUnsupportedRunError.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSelfHostedResourcesUnsupportedRunError + +# Interface: ManagedAgentsSelfHostedResourcesUnsupportedRunError + +The deployment configures resources, but its environment is self-hosted and +cannot mount them. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"self_hosted_resources_unsupported_error"` + +Any of "self_hosted_resources_unsupported_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsSendSessionEvents.md b/docs/api/managed/interfaces/ManagedAgentsSendSessionEvents.md new file mode 100644 index 0000000..30ce262 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSendSessionEvents.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSendSessionEvents + +# Interface: ManagedAgentsSendSessionEvents + +Events that were successfully sent to the session. + +## Properties + +### data? + +> `optional` **data?**: [`ManagedAgentsSendSessionEventsDataUnion`](../type-aliases/ManagedAgentsSendSessionEventsDataUnion.md)[] + +Sent events diff --git a/docs/api/managed/interfaces/ManagedAgentsServerToolUsage.md b/docs/api/managed/interfaces/ManagedAgentsServerToolUsage.md new file mode 100644 index 0000000..6072c07 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsServerToolUsage.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsServerToolUsage + +# Interface: ManagedAgentsServerToolUsage + +Cumulative count of server-executed tool invocations, broken down by tool. + +## Properties + +### web\_fetch\_requests? + +> `optional` **web\_fetch\_requests?**: `number` + +Number of server-executed web fetch requests. + +*** + +### web\_search\_requests? + +> `optional` **web\_search\_requests?**: `number` + +Number of server-executed web search requests. diff --git a/docs/api/managed/interfaces/ManagedAgentsServiceAccountActor.md b/docs/api/managed/interfaces/ManagedAgentsServiceAccountActor.md new file mode 100644 index 0000000..c0f89ff --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsServiceAccountActor.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsServiceAccountActor + +# Interface: ManagedAgentsServiceAccountActor + +Attribution for a write made by a workload authenticated as a service account, +for example via Workload Identity Federation. + +## Properties + +### service\_account\_id + +> **service\_account\_id**: `string` + +ID of the service account that performed the write (a `svac_...` value). + +*** + +### type? + +> `optional` **type?**: `"service_account_actor"` diff --git a/docs/api/managed/interfaces/ManagedAgentsSession.md b/docs/api/managed/interfaces/ManagedAgentsSession.md new file mode 100644 index 0000000..34cb417 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSession.md @@ -0,0 +1,148 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSession + +# Interface: ManagedAgentsSession + +A Managed Agents `session`. + +## Properties + +### agent + +> **agent**: [`ManagedAgentsSessionAgent`](ManagedAgentsSessionAgent.md) + +Resolved `agent` definition for a `session`. Snapshot of the `agent` at +`session` creation time. + +*** + +### archived\_at + +> **archived\_at**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### budget + +> **budget**: [`ManagedAgentsBudgetLimit`](ManagedAgentsBudgetLimit.md) + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### deployment\_id? + +> `optional` **deployment\_id?**: `string` \| `null` + +Deployment ID when the session was created from a deployment reference. Null +otherwise. + +*** + +### environment\_id + +> **environment\_id**: `string` + +*** + +### environment\_variables? + +> `optional` **environment\_variables?**: `Record`\<`string`, `string`\> + +*** + +### id + +> **id**: `string` + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `string`\> + +*** + +### outcome\_evaluations + +> **outcome\_evaluations**: [`ManagedAgentsOutcomeEvaluationResource`](ManagedAgentsOutcomeEvaluationResource.md)[] + +Per-outcome evaluation state. One entry per `define_outcome` event sent to the +session. + +*** + +### resources + +> **resources**: [`ManagedAgentsSessionResourceUnion`](../type-aliases/ManagedAgentsSessionResourceUnion.md)[] + +*** + +### stats + +> **stats**: [`ManagedAgentsSessionStats`](ManagedAgentsSessionStats.md) + +Timing statistics for a session. + +*** + +### status + +> **status**: [`ManagedAgentsSessionStatus`](../type-aliases/ManagedAgentsSessionStatus.md) + +SessionStatus enum + +Any of "rescheduling", "running", "idle", "terminated". + +*** + +### title + +> **title**: `string` + +*** + +### type + +> **type**: `"session"` + +Any of "session". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### usage + +> **usage**: [`ManagedAgentsSessionUsage`](ManagedAgentsSessionUsage.md) + +Cumulative token usage for a session across all turns. + +*** + +### vault\_ids + +> **vault\_ids**: `string`[] + +Vault IDs attached to the session at creation. Empty when no vaults were +supplied. diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionActor.md b/docs/api/managed/interfaces/ManagedAgentsSessionActor.md new file mode 100644 index 0000000..17f201a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionActor.md @@ -0,0 +1,28 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionActor + +# Interface: ManagedAgentsSessionActor + +Attribution for a write made by an agent during a session, through the mounted +filesystem at `/mnt/memory/`. + +## Properties + +### session\_id + +> **session\_id**: `string` + +ID of the session that performed the write (a `sesn_...` value). Look up the +session via [Retrieve a session](/en/api/beta/sessions/retrieve) for further +provenance. + +*** + +### type + +> **type**: `"session_actor"` + +Any of "session_actor". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionAgent.md b/docs/api/managed/interfaces/ManagedAgentsSessionAgent.md new file mode 100644 index 0000000..b09b0d6 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionAgent.md @@ -0,0 +1,83 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionAgent + +# Interface: ManagedAgentsSessionAgent + +Resolved `agent` definition for a `session`. Snapshot of the `agent` at +`session` creation time. + +## Properties + +### description + +> **description**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### mcp\_servers + +> **mcp\_servers**: [`ManagedAgentsMCPServerURLDefinition`](ManagedAgentsMCPServerURLDefinition.md)[] + +*** + +### model + +> **model**: [`ManagedAgentsModelConfig`](../type-aliases/ManagedAgentsModelConfig.md) + +Model identifier and configuration. + +*** + +### multiagent + +> **multiagent**: [`ManagedAgentsSessionMultiagentCoordinator`](ManagedAgentsSessionMultiagentCoordinator.md) + +Resolved coordinator topology with full agent definitions for each roster +member. + +*** + +### name + +> **name**: `string` + +*** + +### skills + +> **skills**: [`ManagedAgentsSessionAgentSkillUnion`](../type-aliases/ManagedAgentsSessionAgentSkillUnion.md)[] + +*** + +### system + +> **system**: `string` + +*** + +### tools + +> **tools**: [`ManagedAgentsSessionAgentToolUnion`](../type-aliases/ManagedAgentsSessionAgentToolUnion.md)[] + +*** + +### type + +> **type**: `"agent"` + +Any of "agent". + +*** + +### version + +> **version**: `number` diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfig.md b/docs/api/managed/interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfig.md new file mode 100644 index 0000000..0b81fbc --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfig.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionAgentToolUnionDefaultConfig + +# Interface: ManagedAgentsSessionAgentToolUnionDefaultConfig + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy`](ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy.md) + +This field is a union of +`ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion`, +`ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy.md b/docs/api/managed/interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy.md new file mode 100644 index 0000000..fdfca4b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy + +# Interface: ManagedAgentsSessionAgentToolUnionDefaultConfigPermissionPolicy + +## Properties + +### type? + +> `optional` **type?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionAgentUpdateParam.md b/docs/api/managed/interfaces/ManagedAgentsSessionAgentUpdateParam.md new file mode 100644 index 0000000..d8a1a8a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionAgentUpdateParam.md @@ -0,0 +1,47 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionAgentUpdateParam + +# Interface: ManagedAgentsSessionAgentUpdateParam + +Mid-session agent configuration update. Only `tools` and `mcp_servers` are +updatable. Full replacement: the provided array becomes the new value. To +preserve existing entries, GET the session, modify the array, and POST it back. + +## Properties + +### mcp\_servers? + +> `optional` **mcp\_servers?**: [`ManagedAgentsURLMCPServerParams`](ManagedAgentsURLMCPServerParams.md)[] \| `null` + +Replacement MCP server list. Full replacement: the provided array becomes the +new value. Send an empty array to clear; omit to preserve. + +*** + +### model? + +> `optional` **model?**: [`ManagedAgentsModelConfigParams`](../type-aliases/ManagedAgentsModelConfigParams.md) \| `null` + +*** + +### skills? + +> `optional` **skills?**: [`ManagedAgentsSkillParamsUnion`](../type-aliases/ManagedAgentsSkillParamsUnion.md)[] \| `null` + +*** + +### system? + +> `optional` **system?**: `string` \| `null` + +*** + +### tools? + +> `optional` **tools?**: [`ManagedAgentsSessionAgentUpdateToolUnionParam`](../type-aliases/ManagedAgentsSessionAgentUpdateToolUnionParam.md)[] \| `null` + +Replacement tool list. Full replacement: the provided array becomes the new +value. Send an empty array to clear; omit to preserve. diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionBudgetReached.md b/docs/api/managed/interfaces/ManagedAgentsSessionBudgetReached.md new file mode 100644 index 0000000..62e044a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionBudgetReached.md @@ -0,0 +1,20 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionBudgetReached + +# Interface: ManagedAgentsSessionBudgetReached + +The agent stopped because the session's tracked list cost reached its budget, or +because its usage includes a model with no list price (which the budget cannot +measure). Raise the budget to continue — or, if raising is rejected because a +model has no list price, remove the budget. + +## Properties + +### type + +> **type**: `"budget_reached"` + +Any of "budget_reached". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionCreationRejectedRunError.md b/docs/api/managed/interfaces/ManagedAgentsSessionCreationRejectedRunError.md new file mode 100644 index 0000000..b014989 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionCreationRejectedRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionCreationRejectedRunError + +# Interface: ManagedAgentsSessionCreationRejectedRunError + +The session create request was rejected with a non-retryable validation error. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"session_creation_rejected_error"` + +Any of "session_creation_rejected_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionDeletedEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionDeletedEvent.md new file mode 100644 index 0000000..a61b824 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionDeletedEvent.md @@ -0,0 +1,34 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionDeletedEvent + +# Interface: ManagedAgentsSessionDeletedEvent + +Emitted when a session has been deleted. Terminates any active event stream — no +further events will be emitted for this session. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"session.deleted"` + +Any of "session.deleted". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionEndTurn.md b/docs/api/managed/interfaces/ManagedAgentsSessionEndTurn.md new file mode 100644 index 0000000..745a3df --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionEndTurn.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionEndTurn + +# Interface: ManagedAgentsSessionEndTurn + +The agent completed its turn naturally and is ready for the next user message. + +## Properties + +### type + +> **type**: `"end_turn"` + +Any of "end_turn". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionErrorEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionErrorEvent.md new file mode 100644 index 0000000..ef9ebff --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionErrorEvent.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionErrorEvent + +# Interface: ManagedAgentsSessionErrorEvent + +An error event indicating a problem occurred during session execution. + +## Properties + +### error + +> **error**: [`ManagedAgentsSessionErrorEventErrorUnion`](../type-aliases/ManagedAgentsSessionErrorEventErrorUnion.md) + +An unknown or unexpected error occurred during session execution. A fallback +variant; clients that don't recognize a new error code can match on +`retry_status` and `message` alone. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"session.error"` + +Any of "session.error". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionErrorEventErrorUnionRetryStatus.md b/docs/api/managed/interfaces/ManagedAgentsSessionErrorEventErrorUnionRetryStatus.md new file mode 100644 index 0000000..8e45264 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionErrorEventErrorUnionRetryStatus.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionErrorEventErrorUnionRetryStatus + +# Interface: ManagedAgentsSessionErrorEventErrorUnionRetryStatus + +## Properties + +### type? + +> `optional` **type?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionEventUnionStopReason.md b/docs/api/managed/interfaces/ManagedAgentsSessionEventUnionStopReason.md new file mode 100644 index 0000000..e7ed7b4 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionEventUnionStopReason.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionEventUnionStopReason + +# Interface: ManagedAgentsSessionEventUnionStopReason + +## Properties + +### event\_ids? + +> `optional` **event\_ids?**: `string`[] + +This field is from variant +`ManagedAgentsSessionStatusIdleEventStopReasonUnion`, +`ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion`. + +*** + +### type? + +> `optional` **type?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionEventUnionUsage.md b/docs/api/managed/interfaces/ManagedAgentsSessionEventUnionUsage.md new file mode 100644 index 0000000..2a8ebf4 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionEventUnionUsage.md @@ -0,0 +1,73 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionEventUnionUsage + +# Interface: ManagedAgentsSessionEventUnionUsage + +## Properties + +### active\_seconds? + +> `optional` **active\_seconds?**: `number` + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### cache\_creation? + +> `optional` **cache\_creation?**: [`ManagedAgentsCacheCreationUsage`](ManagedAgentsCacheCreationUsage.md) + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### cache\_creation\_input\_tokens? + +> `optional` **cache\_creation\_input\_tokens?**: `number` + +This field is from variant `ManagedAgentsSpanModelUsage`. + +*** + +### cache\_read\_input\_tokens? + +> `optional` **cache\_read\_input\_tokens?**: `number` + +*** + +### input\_tokens? + +> `optional` **input\_tokens?**: `number` + +*** + +### list\_cost? + +> `optional` **list\_cost?**: [`MonetaryAmount`](MonetaryAmount.md) + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### output\_tokens? + +> `optional` **output\_tokens?**: `number` + +*** + +### server\_tool\_use? + +> `optional` **server\_tool\_use?**: [`ManagedAgentsServerToolUsage`](ManagedAgentsServerToolUsage.md) + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### speed? + +> `optional` **speed?**: [`ManagedAgentsSpanModelUsageSpeed`](../type-aliases/ManagedAgentsSpanModelUsageSpeed.md) + +This field is from variant `ManagedAgentsSpanModelUsage`. diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionMultiagentCoordinator.md b/docs/api/managed/interfaces/ManagedAgentsSessionMultiagentCoordinator.md new file mode 100644 index 0000000..cf0d0b5 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionMultiagentCoordinator.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionMultiagentCoordinator + +# Interface: ManagedAgentsSessionMultiagentCoordinator + +Resolved coordinator topology with full agent definitions for each roster +member. + +## Properties + +### agents + +> **agents**: [`ManagedAgentsSessionMultiagentCoordinatorAgentUnion`](../type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnion.md)[] + +Full `agent` definitions the coordinator may spawn as session threads. + +*** + +### type + +> **type**: `"coordinator"` + +Any of "coordinator". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionRateLimitedRunError.md b/docs/api/managed/interfaces/ManagedAgentsSessionRateLimitedRunError.md new file mode 100644 index 0000000..4eafdaf --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionRateLimitedRunError.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionRateLimitedRunError + +# Interface: ManagedAgentsSessionRateLimitedRunError + +Session creation was rejected due to rate limiting. The schedule keeps firing; +subsequent runs may succeed. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"session_rate_limited_error"` + +Any of "session_rate_limited_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionRequiresAction.md b/docs/api/managed/interfaces/ManagedAgentsSessionRequiresAction.md new file mode 100644 index 0000000..0556d6e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionRequiresAction.md @@ -0,0 +1,28 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionRequiresAction + +# Interface: ManagedAgentsSessionRequiresAction + +The agent is idle waiting on one or more blocking user-input events (tool +confirmation, custom tool result, etc.). Resolving all of them transitions the +session back to running. + +## Properties + +### event\_ids + +> **event\_ids**: `string`[] + +The ids of events the agent is blocked on. Resolving fewer than all re-emits +`session.status_idle` with the remainder. + +*** + +### type + +> **type**: `"requires_action"` + +Any of "requires_action". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError.md new file mode 100644 index 0000000..1912fbf --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError + +# Interface: ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError + +A referenced resource no longer exists and its kind was not reported. + +## Properties + +### type + +> **type**: `"session_resource_not_found_error"` + +Any of "session_resource_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionResourceNotFoundRunError.md b/docs/api/managed/interfaces/ManagedAgentsSessionResourceNotFoundRunError.md new file mode 100644 index 0000000..93df6f6 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionResourceNotFoundRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionResourceNotFoundRunError + +# Interface: ManagedAgentsSessionResourceNotFoundRunError + +A referenced resource no longer exists and its kind was not reported. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"session_resource_not_found_error"` + +Any of "session_resource_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionRetriesExhausted.md b/docs/api/managed/interfaces/ManagedAgentsSessionRetriesExhausted.md new file mode 100644 index 0000000..255b267 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionRetriesExhausted.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionRetriesExhausted + +# Interface: ManagedAgentsSessionRetriesExhausted + +The turn ended because repeated errors exhausted the retry budget or an error +escalated to `retry_status: 'exhausted'`. + +## Properties + +### type + +> **type**: `"retries_exhausted"` + +Any of "retries_exhausted". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionStats.md b/docs/api/managed/interfaces/ManagedAgentsSessionStats.md new file mode 100644 index 0000000..26a9da8 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionStats.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStats + +# Interface: ManagedAgentsSessionStats + +Timing statistics for a session. + +## Properties + +### active\_seconds? + +> `optional` **active\_seconds?**: `number` + +Cumulative time in seconds the session spent in `running` status. Excludes idle +time. + +*** + +### duration\_seconds? + +> `optional` **duration\_seconds?**: `number` + +Elapsed time since session creation in seconds. For terminated sessions, frozen +at the final update. diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionStatusIdleEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionStatusIdleEvent.md new file mode 100644 index 0000000..16a0e78 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionStatusIdleEvent.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatusIdleEvent + +# Interface: ManagedAgentsSessionStatusIdleEvent + +Indicates the agent has paused and is awaiting user input. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### stop\_reason + +> **stop\_reason**: [`ManagedAgentsSessionStatusIdleEventStopReasonUnion`](../type-aliases/ManagedAgentsSessionStatusIdleEventStopReasonUnion.md) + +The agent completed its turn naturally and is ready for the next user message. + +*** + +### type + +> **type**: `"session.status_idle"` + +Any of "session.status_idle". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionStatusRescheduledEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionStatusRescheduledEvent.md new file mode 100644 index 0000000..102c906 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionStatusRescheduledEvent.md @@ -0,0 +1,34 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatusRescheduledEvent + +# Interface: ManagedAgentsSessionStatusRescheduledEvent + +Indicates the session is recovering from an error state and is rescheduled for +execution. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"session.status_rescheduled"` + +Any of "session.status_rescheduled". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionStatusRunningEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionStatusRunningEvent.md new file mode 100644 index 0000000..49ba2da --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionStatusRunningEvent.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatusRunningEvent + +# Interface: ManagedAgentsSessionStatusRunningEvent + +Indicates the session is actively running and the agent is working. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"session.status_running"` + +Any of "session.status_running". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionStatusTerminatedEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionStatusTerminatedEvent.md new file mode 100644 index 0000000..27ece2c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionStatusTerminatedEvent.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatusTerminatedEvent + +# Interface: ManagedAgentsSessionStatusTerminatedEvent + +Indicates the session has terminated, either due to an error or completion. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"session.status_terminated"` + +Any of "session.status_terminated". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThread.md b/docs/api/managed/interfaces/ManagedAgentsSessionThread.md new file mode 100644 index 0000000..0f0b470 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThread.md @@ -0,0 +1,101 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThread + +# Interface: ManagedAgentsSessionThread + +An execution thread within a `session`. Each session has one primary thread plus +zero or more child threads spawned by the coordinator. + +## Properties + +### agent + +> **agent**: [`ManagedAgentsSessionThreadAgentUnion`](../type-aliases/ManagedAgentsSessionThreadAgentUnion.md) + +The resolved agent a session thread runs: a saved-agent snapshot, the platform +advisor entry, or an inline-defined (ephemeral) agent snapshot. + +*** + +### archived\_at + +> **archived\_at**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### id + +> **id**: `string` + +Unique identifier for this thread. + +*** + +### parent\_thread\_id + +> **parent\_thread\_id**: `string` \| `null` + +Parent thread that spawned this thread. Null for the primary thread. + +*** + +### session\_id + +> **session\_id**: `string` + +The session this thread belongs to. + +*** + +### stats + +> **stats**: [`ManagedAgentsSessionThreadStats`](ManagedAgentsSessionThreadStats.md) \| `null` + +Timing statistics for a session thread. + +*** + +### status + +> **status**: [`ManagedAgentsSessionThreadStatus`](../type-aliases/ManagedAgentsSessionThreadStatus.md) + +SessionThreadStatus enum + +Any of "running", "idle", "rescheduling", "terminated". + +*** + +### type + +> **type**: `"session_thread"` + +Any of "session_thread". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### usage + +> **usage**: [`ManagedAgentsSessionThreadUsage`](ManagedAgentsSessionThreadUsage.md) + +Cumulative token usage for a session thread across all turns. diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadAgent.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadAgent.md new file mode 100644 index 0000000..e11cc2a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadAgent.md @@ -0,0 +1,75 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadAgent + +# Interface: ManagedAgentsSessionThreadAgent + +Resolved `agent` definition for a single `session_thread`. Snapshot of the agent +at thread creation time. The multiagent roster is not repeated here; read it +from `Session.agent`. + +## Properties + +### description + +> **description**: `string` + +*** + +### id + +> **id**: `string` + +*** + +### mcp\_servers + +> **mcp\_servers**: [`ManagedAgentsMCPServerURLDefinition`](ManagedAgentsMCPServerURLDefinition.md)[] + +*** + +### model + +> **model**: [`ManagedAgentsModelConfig`](../type-aliases/ManagedAgentsModelConfig.md) + +Model identifier and configuration. + +*** + +### name + +> **name**: `string` + +*** + +### skills + +> **skills**: [`ManagedAgentsSessionThreadAgentSkillUnion`](../type-aliases/ManagedAgentsSessionThreadAgentSkillUnion.md)[] + +*** + +### system + +> **system**: `string` + +*** + +### tools + +> **tools**: [`ManagedAgentsSessionThreadAgentToolUnion`](../type-aliases/ManagedAgentsSessionThreadAgentToolUnion.md)[] + +*** + +### type + +> **type**: `"agent"` + +Any of "agent". + +*** + +### version + +> **version**: `number` diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfig.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfig.md new file mode 100644 index 0000000..c3492ce --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfig.md @@ -0,0 +1,28 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadAgentToolUnionDefaultConfig + +# Interface: ManagedAgentsSessionThreadAgentToolUnionDefaultConfig + +ManagedAgentsSessionThreadAgentToolUnionDefaultConfig is an implicit +subunion of `ManagedAgentsSessionThreadAgentToolUnion`. +ManagedAgentsSessionThreadAgentToolUnionDefaultConfig provides convenient +access to the sub-properties of the union. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy`](ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy.md) + +This field is a union of +`ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion`, +`ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion` diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy.md new file mode 100644 index 0000000..50b5f6f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy + +# Interface: ManagedAgentsSessionThreadAgentToolUnionDefaultConfigPermissionPolicy + +## Properties + +### type? + +> `optional` **type?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadCreatedEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadCreatedEvent.md new file mode 100644 index 0000000..cddf45c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadCreatedEvent.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadCreatedEvent + +# Interface: ManagedAgentsSessionThreadCreatedEvent + +Emitted when a subagent is spawned as a new thread. Written to the parent +thread's output stream so clients observing the session see child creation. + +## Properties + +### agent\_name + +> **agent\_name**: `string` + +Name of the callable agent the thread runs. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id + +> **session\_thread\_id**: `string` + +Public `sthr_` ID of the newly created thread. + +*** + +### type + +> **type**: `"session.thread_created"` + +Any of "session.thread_created". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadStats.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStats.md new file mode 100644 index 0000000..1a75c4d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStats.md @@ -0,0 +1,36 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStats + +# Interface: ManagedAgentsSessionThreadStats + +Timing statistics for a session thread. + +## Properties + +### active\_seconds? + +> `optional` **active\_seconds?**: `number` + +Cumulative time in seconds the thread spent actively running. Excludes idle +time. + +*** + +### duration\_seconds? + +> `optional` **duration\_seconds?**: `number` + +Elapsed time since thread creation in seconds. For archived threads, frozen at +the final update. + +*** + +### startup\_seconds? + +> `optional` **startup\_seconds?**: `number` + +Time in seconds for the thread to begin running. Zero for child threads, which +start immediately. diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusIdleEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusIdleEvent.md new file mode 100644 index 0000000..61876c3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusIdleEvent.md @@ -0,0 +1,58 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatusIdleEvent + +# Interface: ManagedAgentsSessionThreadStatusIdleEvent + +A session thread has yielded and is awaiting input. Emitted on the thread's own +stream and cross-posted to the primary stream for child threads. + +## Properties + +### agent\_name + +> **agent\_name**: `string` + +Name of the agent the thread runs. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id + +> **session\_thread\_id**: `string` + +Public sthr\_ ID of the thread that went idle. + +*** + +### stop\_reason + +> **stop\_reason**: [`ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion`](../type-aliases/ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion.md) + +The agent completed its turn naturally and is ready for the next user message. + +*** + +### type + +> **type**: `"session.thread_status_idle"` + +Any of "session.thread_status_idle". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusRescheduledEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusRescheduledEvent.md new file mode 100644 index 0000000..5979df5 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusRescheduledEvent.md @@ -0,0 +1,51 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatusRescheduledEvent + +# Interface: ManagedAgentsSessionThreadStatusRescheduledEvent + +A session thread hit a transient error and is retrying automatically. Emitted on +the thread's own stream and cross-posted to the primary stream for child +threads. + +## Properties + +### agent\_name + +> **agent\_name**: `string` + +Name of the agent the thread runs. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id + +> **session\_thread\_id**: `string` + +Public sthr\_ ID of the thread that is retrying. + +*** + +### type + +> **type**: `"session.thread_status_rescheduled"` + +Any of "session.thread_status_rescheduled". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusRunningEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusRunningEvent.md new file mode 100644 index 0000000..ea1fa1d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusRunningEvent.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatusRunningEvent + +# Interface: ManagedAgentsSessionThreadStatusRunningEvent + +A session thread has begun executing. Emitted on the thread's own stream and +cross-posted to the primary stream for child threads. + +## Properties + +### agent\_name + +> **agent\_name**: `string` + +Name of the agent the thread runs. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id + +> **session\_thread\_id**: `string` + +Public sthr\_ ID of the thread that started running. + +*** + +### type + +> **type**: `"session.thread_status_running"` + +Any of "session.thread_status_running". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusTerminatedEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusTerminatedEvent.md new file mode 100644 index 0000000..90b0b45 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadStatusTerminatedEvent.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatusTerminatedEvent + +# Interface: ManagedAgentsSessionThreadStatusTerminatedEvent + +A session thread has terminated and will accept no further input. Emitted on the +thread's own stream and cross-posted to the primary stream for child threads. + +## Properties + +### agent\_name + +> **agent\_name**: `string` + +Name of the agent the thread runs. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id + +> **session\_thread\_id**: `string` + +Public sthr\_ ID of the thread that terminated. + +*** + +### type + +> **type**: `"session.thread_status_terminated"` + +Any of "session.thread_status_terminated". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionThreadUsage.md b/docs/api/managed/interfaces/ManagedAgentsSessionThreadUsage.md new file mode 100644 index 0000000..513a22c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionThreadUsage.md @@ -0,0 +1,67 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadUsage + +# Interface: ManagedAgentsSessionThreadUsage + +Cumulative token usage for a session thread across all turns. + +## Properties + +### active\_seconds? + +> `optional` **active\_seconds?**: `number` + +Cumulative time in seconds this thread spent in running status. Equal to +`stats.active_seconds`; surfaced here so a thread's usage carries every quantity +its cost is priced on. + +*** + +### cache\_creation? + +> `optional` **cache\_creation?**: [`ManagedAgentsCacheCreationUsage`](ManagedAgentsCacheCreationUsage.md) + +Prompt-cache creation token usage broken down by cache lifetime. + +*** + +### cache\_read\_input\_tokens? + +> `optional` **cache\_read\_input\_tokens?**: `number` + +Total tokens read from prompt cache. + +*** + +### input\_tokens? + +> `optional` **input\_tokens?**: `number` + +Total input tokens consumed across all turns. + +*** + +### list\_cost? + +> `optional` **list\_cost?**: [`MonetaryAmount`](MonetaryAmount.md) \| `null` + +A monetary amount in a specific currency. + +*** + +### output\_tokens? + +> `optional` **output\_tokens?**: `number` + +Total output tokens generated across all turns. + +*** + +### server\_tool\_use? + +> `optional` **server\_tool\_use?**: [`ManagedAgentsServerToolUsage`](ManagedAgentsServerToolUsage.md) \| `null` + +Cumulative count of server-executed tool invocations, broken down by tool. diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionUpdatedEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionUpdatedEvent.md new file mode 100644 index 0000000..f57c74c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionUpdatedEvent.md @@ -0,0 +1,70 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionUpdatedEvent + +# Interface: ManagedAgentsSessionUpdatedEvent + +Emitted when an UpdateSession request changed at least one field. Carries only +the fields that changed; absent fields were not part of the update. The new +configuration applies from the next turn. + +## Properties + +### agent? + +> `optional` **agent?**: [`ManagedAgentsSessionAgent`](ManagedAgentsSessionAgent.md) \| `null` + +Resolved `agent` definition for a `session`. Snapshot of the `agent` at +`session` creation time. + +*** + +### budget? + +> `optional` **budget?**: [`ManagedAgentsBudgetLimit`](ManagedAgentsBudgetLimit.md) \| `null` + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> + +The session's full metadata bag after the update. Present when the update set +non-empty metadata; absent when metadata was unchanged or cleared to empty. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### title? + +> `optional` **title?**: `string` \| `null` + +The session's new title. Present only when the update changed it. + +*** + +### type + +> **type**: `"session.updated"` + +Any of "session.updated". diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionUsage.md b/docs/api/managed/interfaces/ManagedAgentsSessionUsage.md new file mode 100644 index 0000000..ff532ea --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionUsage.md @@ -0,0 +1,68 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionUsage + +# Interface: ManagedAgentsSessionUsage + +Cumulative token usage for a session across all turns. + +## Properties + +### active\_seconds? + +> `optional` **active\_seconds?**: `number` + +Cumulative time in seconds during which the session had at least one thread in +running status. Overlapping activity from concurrent threads is counted once, +unlike `stats.active_seconds`, which sums each thread's own active time. This is +the duration the session's runtime cost is priced on. + +*** + +### cache\_creation? + +> `optional` **cache\_creation?**: [`ManagedAgentsCacheCreationUsage`](ManagedAgentsCacheCreationUsage.md) + +Prompt-cache creation token usage broken down by cache lifetime. + +*** + +### cache\_read\_input\_tokens? + +> `optional` **cache\_read\_input\_tokens?**: `number` + +Total tokens read from prompt cache. + +*** + +### input\_tokens? + +> `optional` **input\_tokens?**: `number` + +Total input tokens consumed across all turns. + +*** + +### list\_cost? + +> `optional` **list\_cost?**: [`MonetaryAmount`](MonetaryAmount.md) \| `null` + +A monetary amount in a specific currency. + +*** + +### output\_tokens? + +> `optional` **output\_tokens?**: `number` + +Total output tokens generated across all turns. + +*** + +### server\_tool\_use? + +> `optional` **server\_tool\_use?**: [`ManagedAgentsServerToolUsage`](ManagedAgentsServerToolUsage.md) \| `null` + +Cumulative count of server-executed tool invocations, broken down by tool. diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionUsageEvent.md b/docs/api/managed/interfaces/ManagedAgentsSessionUsageEvent.md new file mode 100644 index 0000000..cc2c953 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionUsageEvent.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionUsageEvent + +# Interface: ManagedAgentsSessionUsageEvent + +Periodic snapshot of the session's cumulative usage and tracked list cost. + +## Properties + +### budget? + +> `optional` **budget?**: [`ManagedAgentsBudgetLimit`](ManagedAgentsBudgetLimit.md) \| `null` + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"session.usage"` + +Any of "session.usage". + +*** + +### usage + +> **usage**: [`ManagedAgentsSessionUsageSnapshot`](ManagedAgentsSessionUsageSnapshot.md) + +Point-in-time snapshot of a session's cumulative usage. diff --git a/docs/api/managed/interfaces/ManagedAgentsSessionUsageSnapshot.md b/docs/api/managed/interfaces/ManagedAgentsSessionUsageSnapshot.md new file mode 100644 index 0000000..6c5258f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSessionUsageSnapshot.md @@ -0,0 +1,67 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionUsageSnapshot + +# Interface: ManagedAgentsSessionUsageSnapshot + +Point-in-time snapshot of a session's cumulative usage. + +## Properties + +### active\_seconds? + +> `optional` **active\_seconds?**: `number` + +Cumulative time in seconds during which the session had at least one thread in +running status. Overlapping activity from concurrent threads is counted once. +This is the duration the session's runtime cost is priced on. + +*** + +### cache\_creation? + +> `optional` **cache\_creation?**: [`ManagedAgentsCacheCreationUsage`](ManagedAgentsCacheCreationUsage.md) + +Prompt-cache creation token usage broken down by cache lifetime. + +*** + +### cache\_read\_input\_tokens? + +> `optional` **cache\_read\_input\_tokens?**: `number` + +Total tokens read from prompt cache. + +*** + +### input\_tokens? + +> `optional` **input\_tokens?**: `number` + +Total input tokens consumed across all turns. + +*** + +### list\_cost? + +> `optional` **list\_cost?**: [`MonetaryAmount`](MonetaryAmount.md) + +A monetary amount in a specific currency. + +*** + +### output\_tokens? + +> `optional` **output\_tokens?**: `number` + +Total output tokens generated across all turns. + +*** + +### server\_tool\_use? + +> `optional` **server\_tool\_use?**: [`ManagedAgentsServerToolUsage`](ManagedAgentsServerToolUsage.md) + +Cumulative count of server-executed tool invocations, broken down by tool. diff --git a/docs/api/managed/interfaces/ManagedAgentsSkillNotFoundDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsSkillNotFoundDeploymentPausedReasonError.md new file mode 100644 index 0000000..a704169 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSkillNotFoundDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSkillNotFoundDeploymentPausedReasonError + +# Interface: ManagedAgentsSkillNotFoundDeploymentPausedReasonError + +A skill referenced by the deployment's agent no longer exists. + +## Properties + +### type + +> **type**: `"skill_not_found_error"` + +Any of "skill_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsSkillNotFoundRunError.md b/docs/api/managed/interfaces/ManagedAgentsSkillNotFoundRunError.md new file mode 100644 index 0000000..2d13692 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSkillNotFoundRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSkillNotFoundRunError + +# Interface: ManagedAgentsSkillNotFoundRunError + +A skill referenced by the deployment's agent no longer exists. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"skill_not_found_error"` + +Any of "skill_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsSpanModelRequestEndEvent.md b/docs/api/managed/interfaces/ManagedAgentsSpanModelRequestEndEvent.md new file mode 100644 index 0000000..4e66e09 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSpanModelRequestEndEvent.md @@ -0,0 +1,57 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanModelRequestEndEvent + +# Interface: ManagedAgentsSpanModelRequestEndEvent + +Emitted when a model request completes. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### is\_error + +> **is\_error**: `boolean` + +Whether the model request resulted in an error. + +*** + +### model\_request\_start\_id + +> **model\_request\_start\_id**: `string` + +The id of the corresponding `span.model_request_start` event. + +*** + +### model\_usage + +> **model\_usage**: [`ManagedAgentsSpanModelUsage`](ManagedAgentsSpanModelUsage.md) + +Token usage for a single model request. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"span.model_request_end"` + +Any of "span.model_request_end". diff --git a/docs/api/managed/interfaces/ManagedAgentsSpanModelRequestStartEvent.md b/docs/api/managed/interfaces/ManagedAgentsSpanModelRequestStartEvent.md new file mode 100644 index 0000000..c2580e0 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSpanModelRequestStartEvent.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanModelRequestStartEvent + +# Interface: ManagedAgentsSpanModelRequestStartEvent + +Emitted when a model request is initiated by the agent. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"span.model_request_start"` + +Any of "span.model_request_start". diff --git a/docs/api/managed/interfaces/ManagedAgentsSpanModelUsage.md b/docs/api/managed/interfaces/ManagedAgentsSpanModelUsage.md new file mode 100644 index 0000000..d681ca2 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSpanModelUsage.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanModelUsage + +# Interface: ManagedAgentsSpanModelUsage + +Token usage for a single model request. + +## Properties + +### cache\_creation\_input\_tokens + +> **cache\_creation\_input\_tokens**: `number` + +Tokens used to create prompt cache in this request. + +*** + +### cache\_read\_input\_tokens + +> **cache\_read\_input\_tokens**: `number` + +Tokens read from prompt cache in this request. + +*** + +### input\_tokens + +> **input\_tokens**: `number` + +Input tokens consumed by this request. + +*** + +### output\_tokens + +> **output\_tokens**: `number` + +Output tokens generated by this request. + +*** + +### speed? + +> `optional` **speed?**: [`ManagedAgentsSpanModelUsageSpeed`](../type-aliases/ManagedAgentsSpanModelUsageSpeed.md) \| `null` + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. + +Any of "standard", "fast". diff --git a/docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationEndEvent.md b/docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationEndEvent.md new file mode 100644 index 0000000..538b047 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationEndEvent.md @@ -0,0 +1,92 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanOutcomeEvaluationEndEvent + +# Interface: ManagedAgentsSpanOutcomeEvaluationEndEvent + +Emitted when an outcome evaluation cycle completes. Carries the verdict and +aggregate token usage. A verdict of `needs_revision` means another evaluation +cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` +are terminal — no further evaluation cycles follow. + +## Properties + +### explanation + +> **explanation**: `string` + +Human-readable explanation of the verdict. For `needs_revision`, describes which +criteria failed and why. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### iteration + +> **iteration**: `number` + +0-indexed revision cycle, matching the corresponding +`span.outcome_evaluation_start`. + +*** + +### outcome\_evaluation\_start\_id + +> **outcome\_evaluation\_start\_id**: `string` + +The id of the corresponding `span.outcome_evaluation_start` event. + +*** + +### outcome\_id + +> **outcome\_id**: `string` + +The `outc_` ID of the outcome being evaluated. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### result + +> **result**: `string` + +Evaluation verdict. 'satisfied': criteria met, session goes idle. +'needs_revision': criteria not met, another revision cycle follows. +'max_iterations_reached': evaluation budget exhausted with criteria still unmet +— one final acknowledgment turn follows before the session goes idle, but no +further evaluation runs. 'failed': grader determined the rubric does not apply +to the deliverables. 'interrupted': user sent an interrupt while evaluation was +in progress. + +*** + +### type + +> **type**: `"span.outcome_evaluation_end"` + +Any of "span.outcome_evaluation_end". + +*** + +### usage + +> **usage**: [`ManagedAgentsSpanModelUsage`](ManagedAgentsSpanModelUsage.md) + +Token usage for a single model request. diff --git a/docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationOngoingEvent.md b/docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationOngoingEvent.md new file mode 100644 index 0000000..84e7972 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationOngoingEvent.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanOutcomeEvaluationOngoingEvent + +# Interface: ManagedAgentsSpanOutcomeEvaluationOngoingEvent + +Periodic heartbeat emitted while an outcome evaluation cycle is in progress. +Distinguishes 'evaluation is actively running' from 'evaluation is stuck' +between the corresponding `span.outcome_evaluation_start` and +`span.outcome_evaluation_end` events. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### iteration + +> **iteration**: `number` + +0-indexed revision cycle, matching the corresponding +`span.outcome_evaluation_start`. + +*** + +### outcome\_id + +> **outcome\_id**: `string` + +The `outc_` ID of the outcome being evaluated. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"span.outcome_evaluation_ongoing"` + +Any of "span.outcome_evaluation_ongoing". diff --git a/docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationStartEvent.md b/docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationStartEvent.md new file mode 100644 index 0000000..349830f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSpanOutcomeEvaluationStartEvent.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanOutcomeEvaluationStartEvent + +# Interface: ManagedAgentsSpanOutcomeEvaluationStartEvent + +Emitted when an outcome evaluation cycle begins. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### iteration + +> **iteration**: `number` + +0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation +after the first revision; etc. + +*** + +### outcome\_id + +> **outcome\_id**: `string` + +The `outc_` ID of the outcome being evaluated. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"span.outcome_evaluation_start"` + +Any of "span.outcome_evaluation_start". diff --git a/docs/api/managed/interfaces/ManagedAgentsStartEvent.md b/docs/api/managed/interfaces/ManagedAgentsStartEvent.md new file mode 100644 index 0000000..3093a9a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsStartEvent.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStartEvent + +# Interface: ManagedAgentsStartEvent + +Opens a preview of a buffered event. Carries the previewed event's type and id +only. Followed by zero or more event_delta events with the same event id, +normally concluded by the buffered event carrying that id. If the producing +model request ends without that event (an error or interrupt mid-stream), its +terminal span.model_request_end closes the preview. Only sent on stream +connections that opt in via event_deltas; never appears in event history. + +## Properties + +### event + +> **event**: [`ManagedAgentsStartEventPreviewUnion`](../type-aliases/ManagedAgentsStartEventPreviewUnion.md) + +The previewed event's type and id. The event type determines which delta types +the preview's event_delta events carry: agent.message events stream +content_delta fragments; agent.thinking previews are start-only — no deltas +follow, and the buffered agent.thinking with the same id concludes them. + +*** + +### type + +> **type**: `"event_start"` + +Any of "event_start". diff --git a/docs/api/managed/interfaces/ManagedAgentsStaticBearerAuthResponse.md b/docs/api/managed/interfaces/ManagedAgentsStaticBearerAuthResponse.md new file mode 100644 index 0000000..347b943 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsStaticBearerAuthResponse.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStaticBearerAuthResponse + +# Interface: ManagedAgentsStaticBearerAuthResponse + +Static bearer token credential details for an MCP server. + +## Properties + +### mcp\_server\_url + +> **mcp\_server\_url**: `string` + +URL of the MCP server this credential authenticates against. + +*** + +### type + +> **type**: `"static_bearer"` + +Any of "static_bearer". diff --git a/docs/api/managed/interfaces/ManagedAgentsStaticBearerCreateParams.md b/docs/api/managed/interfaces/ManagedAgentsStaticBearerCreateParams.md new file mode 100644 index 0000000..32640af --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsStaticBearerCreateParams.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStaticBearerCreateParams + +# Interface: ManagedAgentsStaticBearerCreateParams + +Parameters for creating a static bearer token credential. + +## Properties + +### mcp\_server\_url + +> **mcp\_server\_url**: `string` + +URL of the MCP server this credential authenticates against. + +*** + +### token + +> **token**: `string` + +Static bearer token value. + +*** + +### type + +> **type**: `"static_bearer"` + +Any of "static_bearer". diff --git a/docs/api/managed/interfaces/ManagedAgentsStaticBearerUpdateParams.md b/docs/api/managed/interfaces/ManagedAgentsStaticBearerUpdateParams.md new file mode 100644 index 0000000..de5475f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsStaticBearerUpdateParams.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStaticBearerUpdateParams + +# Interface: ManagedAgentsStaticBearerUpdateParams + +Parameters for updating a static bearer token credential. The `mcp_server_url` +is immutable. + +## Properties + +### token? + +> `optional` **token?**: `string` \| `null` + +Updated static bearer token value. + +*** + +### type + +> **type**: `"static_bearer"` + +Any of "static_bearer". diff --git a/docs/api/managed/interfaces/ManagedAgentsStreamSessionEventsUnionStopReason.md b/docs/api/managed/interfaces/ManagedAgentsStreamSessionEventsUnionStopReason.md new file mode 100644 index 0000000..b57a795 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsStreamSessionEventsUnionStopReason.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStreamSessionEventsUnionStopReason + +# Interface: ManagedAgentsStreamSessionEventsUnionStopReason + +## Properties + +### event\_ids? + +> `optional` **event\_ids?**: `string`[] + +This field is from variant +`ManagedAgentsSessionStatusIdleEventStopReasonUnion`, +`ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion`. + +*** + +### type? + +> `optional` **type?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsStreamSessionEventsUnionUsage.md b/docs/api/managed/interfaces/ManagedAgentsStreamSessionEventsUnionUsage.md new file mode 100644 index 0000000..b0762fc --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsStreamSessionEventsUnionUsage.md @@ -0,0 +1,73 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStreamSessionEventsUnionUsage + +# Interface: ManagedAgentsStreamSessionEventsUnionUsage + +## Properties + +### active\_seconds? + +> `optional` **active\_seconds?**: `number` + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### cache\_creation? + +> `optional` **cache\_creation?**: [`ManagedAgentsCacheCreationUsage`](ManagedAgentsCacheCreationUsage.md) + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### cache\_creation\_input\_tokens? + +> `optional` **cache\_creation\_input\_tokens?**: `number` + +This field is from variant `ManagedAgentsSpanModelUsage`. + +*** + +### cache\_read\_input\_tokens? + +> `optional` **cache\_read\_input\_tokens?**: `number` + +*** + +### input\_tokens? + +> `optional` **input\_tokens?**: `number` + +*** + +### list\_cost? + +> `optional` **list\_cost?**: [`MonetaryAmount`](MonetaryAmount.md) + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### output\_tokens? + +> `optional` **output\_tokens?**: `number` + +*** + +### server\_tool\_use? + +> `optional` **server\_tool\_use?**: [`ManagedAgentsServerToolUsage`](ManagedAgentsServerToolUsage.md) + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### speed? + +> `optional` **speed?**: [`ManagedAgentsSpanModelUsageSpeed`](../type-aliases/ManagedAgentsSpanModelUsageSpeed.md) + +This field is from variant `ManagedAgentsSpanModelUsage`. diff --git a/docs/api/managed/interfaces/ManagedAgentsStreamSessionThreadEventsUnionStopReason.md b/docs/api/managed/interfaces/ManagedAgentsStreamSessionThreadEventsUnionStopReason.md new file mode 100644 index 0000000..ddff05f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsStreamSessionThreadEventsUnionStopReason.md @@ -0,0 +1,28 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStreamSessionThreadEventsUnionStopReason + +# Interface: ManagedAgentsStreamSessionThreadEventsUnionStopReason + +ManagedAgentsStreamSessionThreadEventsUnionStopReason is an implicit +subunion of `ManagedAgentsStreamSessionThreadEventsUnion`. +ManagedAgentsStreamSessionThreadEventsUnionStopReason provides convenient +access to the sub-properties of the union. + +## Properties + +### event\_ids? + +> `optional` **event\_ids?**: `string`[] + +This field is from variant +`ManagedAgentsSessionStatusIdleEventStopReasonUnion`, +`ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion`. + +*** + +### type? + +> `optional` **type?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsStreamSessionThreadEventsUnionUsage.md b/docs/api/managed/interfaces/ManagedAgentsStreamSessionThreadEventsUnionUsage.md new file mode 100644 index 0000000..1d63f0b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsStreamSessionThreadEventsUnionUsage.md @@ -0,0 +1,73 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStreamSessionThreadEventsUnionUsage + +# Interface: ManagedAgentsStreamSessionThreadEventsUnionUsage + +## Properties + +### active\_seconds? + +> `optional` **active\_seconds?**: `number` + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### cache\_creation? + +> `optional` **cache\_creation?**: [`ManagedAgentsCacheCreationUsage`](ManagedAgentsCacheCreationUsage.md) + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### cache\_creation\_input\_tokens? + +> `optional` **cache\_creation\_input\_tokens?**: `number` + +This field is from variant `ManagedAgentsSpanModelUsage`. + +*** + +### cache\_read\_input\_tokens? + +> `optional` **cache\_read\_input\_tokens?**: `number` + +*** + +### input\_tokens? + +> `optional` **input\_tokens?**: `number` + +*** + +### list\_cost? + +> `optional` **list\_cost?**: [`MonetaryAmount`](MonetaryAmount.md) + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### output\_tokens? + +> `optional` **output\_tokens?**: `number` + +*** + +### server\_tool\_use? + +> `optional` **server\_tool\_use?**: [`ManagedAgentsServerToolUsage`](ManagedAgentsServerToolUsage.md) + +This field is from variant `ManagedAgentsSessionUsageSnapshot`. + +*** + +### speed? + +> `optional` **speed?**: [`ManagedAgentsSpanModelUsageSpeed`](../type-aliases/ManagedAgentsSpanModelUsageSpeed.md) + +This field is from variant `ManagedAgentsSpanModelUsage`. diff --git a/docs/api/managed/interfaces/ManagedAgentsSystemContentBlock.md b/docs/api/managed/interfaces/ManagedAgentsSystemContentBlock.md new file mode 100644 index 0000000..8c975fe --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSystemContentBlock.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSystemContentBlock + +# Interface: ManagedAgentsSystemContentBlock + +Regular text content. + +## Properties + +### text + +> **text**: `string` + +The text content. + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsSystemContentBlockParam.md b/docs/api/managed/interfaces/ManagedAgentsSystemContentBlockParam.md new file mode 100644 index 0000000..6d4c381 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSystemContentBlockParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSystemContentBlockParam + +# Interface: ManagedAgentsSystemContentBlockParam + +Regular text content. + +## Properties + +### text + +> **text**: `string` + +The text content. + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsSystemMessageEvent.md b/docs/api/managed/interfaces/ManagedAgentsSystemMessageEvent.md new file mode 100644 index 0000000..0ef2307 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSystemMessageEvent.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSystemMessageEvent + +# Interface: ManagedAgentsSystemMessageEvent + +A mid-conversation system message event. Carries system-role content that is +appended to the session as a `role: "system"` turn. + +## Properties + +### content + +> **content**: [`ManagedAgentsSystemContentBlock`](ManagedAgentsSystemContentBlock.md)[] + +System content blocks. Text-only. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at? + +> `optional` **processed\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"system.message"` + +Any of "system.message". diff --git a/docs/api/managed/interfaces/ManagedAgentsSystemMessageEventParams.md b/docs/api/managed/interfaces/ManagedAgentsSystemMessageEventParams.md new file mode 100644 index 0000000..d01a147 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsSystemMessageEventParams.md @@ -0,0 +1,30 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSystemMessageEventParams + +# Interface: ManagedAgentsSystemMessageEventParams + +Privileged context for the accompanying turn and all subsequent turns, appended +to the session's system context as a `role: "system"` turn rather than replacing +the top-level system prompt. At most one per request: it must be the final event +and immediately follow the `user.message`, `user.tool_result`, or +`user.custom_tool_result` it accompanies. Only supported on models that accept +mid-conversation system messages. + +## Properties + +### content + +> **content**: [`ManagedAgentsSystemContentBlockParam`](ManagedAgentsSystemContentBlockParam.md)[] + +System content blocks to append. Text-only. + +*** + +### type + +> **type**: `"system.message"` + +Any of "system.message". diff --git a/docs/api/managed/interfaces/ManagedAgentsTextBlock.md b/docs/api/managed/interfaces/ManagedAgentsTextBlock.md new file mode 100644 index 0000000..e1c7420 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTextBlock.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTextBlock + +# Interface: ManagedAgentsTextBlock + +Regular text content. + +## Properties + +### text + +> **text**: `string` + +The text content. + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsTextBlockParam.md b/docs/api/managed/interfaces/ManagedAgentsTextBlockParam.md new file mode 100644 index 0000000..87cbf7f --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTextBlockParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTextBlockParam + +# Interface: ManagedAgentsTextBlockParam + +Regular text content. + +## Properties + +### text + +> **text**: `string` + +The text content. + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsTextRubric.md b/docs/api/managed/interfaces/ManagedAgentsTextRubric.md new file mode 100644 index 0000000..b1df863 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTextRubric.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTextRubric + +# Interface: ManagedAgentsTextRubric + +Rubric content provided inline as text. + +## Properties + +### content + +> **content**: `string` + +Rubric content. Plain text or markdown — the grader treats it as freeform text. + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsTextRubricParams.md b/docs/api/managed/interfaces/ManagedAgentsTextRubricParams.md new file mode 100644 index 0000000..a25065b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTextRubricParams.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTextRubricParams + +# Interface: ManagedAgentsTextRubricParams + +Rubric content provided inline as text. + +## Properties + +### content + +> **content**: `string` + +Rubric content. Plain text or markdown — the grader treats it as freeform text. +Maximum 262144 characters. + +*** + +### type + +> **type**: `"text"` + +Any of "text". diff --git a/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicParam.md b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicParam.md new file mode 100644 index 0000000..650b28d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthBasicParam + +# Interface: ManagedAgentsTokenEndpointAuthBasicParam + +Token endpoint uses HTTP Basic authentication with client credentials. + +## Properties + +### client\_secret + +> **client\_secret**: `string` + +OAuth client secret. + +*** + +### type + +> **type**: `"client_secret_basic"` + +Any of "client_secret_basic". diff --git a/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicResponse.md b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicResponse.md new file mode 100644 index 0000000..3d0487e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicResponse.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthBasicResponse + +# Interface: ManagedAgentsTokenEndpointAuthBasicResponse + +Token endpoint uses HTTP Basic authentication with client credentials. + +## Properties + +### type + +> **type**: `"client_secret_basic"` + +Any of "client_secret_basic". diff --git a/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicUpdateParam.md b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicUpdateParam.md new file mode 100644 index 0000000..c3c8594 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthBasicUpdateParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthBasicUpdateParam + +# Interface: ManagedAgentsTokenEndpointAuthBasicUpdateParam + +Updated HTTP Basic authentication parameters for the token endpoint. + +## Properties + +### client\_secret? + +> `optional` **client\_secret?**: `string` \| `null` + +Updated OAuth client secret. + +*** + +### type + +> **type**: `"client_secret_basic"` + +Any of "client_secret_basic". diff --git a/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthNoneParam.md b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthNoneParam.md new file mode 100644 index 0000000..0482ad6 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthNoneParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthNoneParam + +# Interface: ManagedAgentsTokenEndpointAuthNoneParam + +Token endpoint requires no client authentication. + +## Properties + +### type + +> **type**: `"none"` + +Any of "none". diff --git a/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthNoneResponse.md b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthNoneResponse.md new file mode 100644 index 0000000..b0006f3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthNoneResponse.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthNoneResponse + +# Interface: ManagedAgentsTokenEndpointAuthNoneResponse + +Token endpoint requires no client authentication. + +## Properties + +### type + +> **type**: `"none"` + +Any of "none". diff --git a/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostParam.md b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostParam.md new file mode 100644 index 0000000..0abcc9d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthPostParam + +# Interface: ManagedAgentsTokenEndpointAuthPostParam + +Token endpoint uses POST body authentication with client credentials. + +## Properties + +### client\_secret + +> **client\_secret**: `string` + +OAuth client secret. + +*** + +### type + +> **type**: `"client_secret_post"` + +Any of "client_secret_post". diff --git a/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostResponse.md b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostResponse.md new file mode 100644 index 0000000..065c053 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostResponse.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthPostResponse + +# Interface: ManagedAgentsTokenEndpointAuthPostResponse + +Token endpoint uses POST body authentication with client credentials. + +## Properties + +### type + +> **type**: `"client_secret_post"` + +Any of "client_secret_post". diff --git a/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostUpdateParam.md b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostUpdateParam.md new file mode 100644 index 0000000..fea0f3e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsTokenEndpointAuthPostUpdateParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthPostUpdateParam + +# Interface: ManagedAgentsTokenEndpointAuthPostUpdateParam + +Updated POST body authentication parameters for the token endpoint. + +## Properties + +### client\_secret? + +> `optional` **client\_secret?**: `string` \| `null` + +Updated OAuth client secret. + +*** + +### type + +> **type**: `"client_secret_post"` + +Any of "client_secret_post". diff --git a/docs/api/managed/interfaces/ManagedAgentsURLDocumentSource.md b/docs/api/managed/interfaces/ManagedAgentsURLDocumentSource.md new file mode 100644 index 0000000..7d537b2 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsURLDocumentSource.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsURLDocumentSource + +# Interface: ManagedAgentsURLDocumentSource + +Document referenced by URL. + +## Properties + +### type + +> **type**: `"url"` + +Any of "url". + +*** + +### url + +> **url**: `string` + +URL of the document to fetch. diff --git a/docs/api/managed/interfaces/ManagedAgentsURLDocumentSourceParam.md b/docs/api/managed/interfaces/ManagedAgentsURLDocumentSourceParam.md new file mode 100644 index 0000000..10d1b1a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsURLDocumentSourceParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsURLDocumentSourceParam + +# Interface: ManagedAgentsURLDocumentSourceParam + +Document referenced by URL. + +## Properties + +### type + +> **type**: `"url"` + +Any of "url". + +*** + +### url + +> **url**: `string` + +URL of the document to fetch. diff --git a/docs/api/managed/interfaces/ManagedAgentsURLImageSource.md b/docs/api/managed/interfaces/ManagedAgentsURLImageSource.md new file mode 100644 index 0000000..588dc41 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsURLImageSource.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsURLImageSource + +# Interface: ManagedAgentsURLImageSource + +Image referenced by URL. + +## Properties + +### type + +> **type**: `"url"` + +Any of "url". + +*** + +### url + +> **url**: `string` + +URL of the image to fetch. diff --git a/docs/api/managed/interfaces/ManagedAgentsURLImageSourceParam.md b/docs/api/managed/interfaces/ManagedAgentsURLImageSourceParam.md new file mode 100644 index 0000000..eaa3363 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsURLImageSourceParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsURLImageSourceParam + +# Interface: ManagedAgentsURLImageSourceParam + +Image referenced by URL. + +## Properties + +### type + +> **type**: `"url"` + +Any of "url". + +*** + +### url + +> **url**: `string` + +URL of the image to fetch. diff --git a/docs/api/managed/interfaces/ManagedAgentsURLMCPServerParams.md b/docs/api/managed/interfaces/ManagedAgentsURLMCPServerParams.md new file mode 100644 index 0000000..1c1d0f3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsURLMCPServerParams.md @@ -0,0 +1,34 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsURLMCPServerParams + +# Interface: ManagedAgentsURLMCPServerParams + +URL-based MCP server connection. + +## Properties + +### name + +> **name**: `string` + +Unique name for this server, referenced by mcp_toolset configurations. 1-255 +characters. + +*** + +### type + +> **type**: `"url"` + +Any of "url". + +*** + +### url + +> **url**: `string` + +Endpoint URL for the MCP server. diff --git a/docs/api/managed/interfaces/ManagedAgentsUnknownDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsUnknownDeploymentPausedReasonError.md new file mode 100644 index 0000000..4f05f04 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUnknownDeploymentPausedReasonError.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnknownDeploymentPausedReasonError + +# Interface: ManagedAgentsUnknownDeploymentPausedReasonError + +An unrecognized error auto-paused the deployment. A fallback variant; matches a +run whose `error.type` is `unknown_error`. + +## Properties + +### type + +> **type**: `"unknown_error"` + +Any of "unknown_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsUnknownError.md b/docs/api/managed/interfaces/ManagedAgentsUnknownError.md new file mode 100644 index 0000000..43aa4c7 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUnknownError.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnknownError + +# Interface: ManagedAgentsUnknownError + +An unknown or unexpected error occurred during session execution. A fallback +variant; clients that don't recognize a new error code can match on +`retry_status` and `message` alone. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### retry\_status + +> **retry\_status**: [`ManagedAgentsUnknownErrorRetryStatusUnion`](../type-aliases/ManagedAgentsUnknownErrorRetryStatusUnion.md) + +What the client should do next in response to this error. + +*** + +### type + +> **type**: `"unknown_error"` + +Any of "unknown_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsUnknownRunError.md b/docs/api/managed/interfaces/ManagedAgentsUnknownRunError.md new file mode 100644 index 0000000..582c54c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUnknownRunError.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnknownRunError + +# Interface: ManagedAgentsUnknownRunError + +An unknown or unexpected error caused the run to fail. A fallback variant; +clients that do not recognize a new error type can match on message alone. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"unknown_error"` + +Any of "unknown_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsUnrestrictedCredentialNetworkingParams.md b/docs/api/managed/interfaces/ManagedAgentsUnrestrictedCredentialNetworkingParams.md new file mode 100644 index 0000000..8a79cfb --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUnrestrictedCredentialNetworkingParams.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnrestrictedCredentialNetworkingParams + +# Interface: ManagedAgentsUnrestrictedCredentialNetworkingParams + +Substitute the secret on any host the session's Environment network policy +permits egress to. The Environment's network policy is the only boundary on +where the secret can reach. + +## Properties + +### type + +> **type**: `"unrestricted"` + +Any of "unrestricted". diff --git a/docs/api/managed/interfaces/ManagedAgentsUnrestrictedCredentialNetworkingResponse.md b/docs/api/managed/interfaces/ManagedAgentsUnrestrictedCredentialNetworkingResponse.md new file mode 100644 index 0000000..5bf26b6 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUnrestrictedCredentialNetworkingResponse.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnrestrictedCredentialNetworkingResponse + +# Interface: ManagedAgentsUnrestrictedCredentialNetworkingResponse + +The secret is substituted on any host the session's Environment network policy +permits egress to. + +## Properties + +### type + +> **type**: `"unrestricted"` + +Any of "unrestricted". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserActor.md b/docs/api/managed/interfaces/ManagedAgentsUserActor.md new file mode 100644 index 0000000..da1dee3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserActor.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserActor + +# Interface: ManagedAgentsUserActor + +Attribution for a write made by a human user through the Qoder Console. + +## Properties + +### type + +> **type**: `"user_actor"` + +Any of "user_actor". + +*** + +### user\_id + +> **user\_id**: `string` + +ID of the user who performed the write (a `user_...` value). diff --git a/docs/api/managed/interfaces/ManagedAgentsUserCustomToolResultEvent.md b/docs/api/managed/interfaces/ManagedAgentsUserCustomToolResultEvent.md new file mode 100644 index 0000000..9f63d7d --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserCustomToolResultEvent.md @@ -0,0 +1,69 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserCustomToolResultEvent + +# Interface: ManagedAgentsUserCustomToolResultEvent + +Event sent by the client providing the result of a custom tool execution. + +## Properties + +### content? + +> `optional` **content?**: [`ManagedAgentsUserCustomToolResultEventContentUnion`](../type-aliases/ManagedAgentsUserCustomToolResultEventContentUnion.md)[] + +The result content returned by the tool. + +*** + +### custom\_tool\_use\_id + +> **custom\_tool\_use\_id**: `string` + +The id of the `agent.custom_tool_use` event this result corresponds to, which +can be found in the last `session.status_idle` +[event's](https://docs.qoder.com/cloud-agents/api/sessions/schemas) +`stop_reason.event_ids` field. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### is\_error? + +> `optional` **is\_error?**: `boolean` \| `null` + +Whether the tool execution resulted in an error. + +*** + +### processed\_at? + +> `optional` **processed\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id? + +> `optional` **session\_thread\_id?**: `string` \| `null` + +Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` +event's `session_thread_id`. + +*** + +### type + +> **type**: `"user.custom_tool_result"` + +Any of "user.custom_tool_result". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserCustomToolResultEventParams.md b/docs/api/managed/interfaces/ManagedAgentsUserCustomToolResultEventParams.md new file mode 100644 index 0000000..bfb9cb6 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserCustomToolResultEventParams.md @@ -0,0 +1,44 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserCustomToolResultEventParams + +# Interface: ManagedAgentsUserCustomToolResultEventParams + +Parameters for providing the result of a custom tool execution. + +## Properties + +### content? + +> `optional` **content?**: [`ManagedAgentsUserCustomToolResultEventParamsContentUnion`](../type-aliases/ManagedAgentsUserCustomToolResultEventParamsContentUnion.md)[] \| `null` + +The result content returned by the tool. + +*** + +### custom\_tool\_use\_id + +> **custom\_tool\_use\_id**: `string` + +The id of the `agent.custom_tool_use` event this result corresponds to, which +can be found in the last `session.status_idle` +[event's](https://docs.qoder.com/cloud-agents/api/sessions/schemas) +`stop_reason.event_ids` field. + +*** + +### is\_error? + +> `optional` **is\_error?**: `boolean` \| `null` + +Whether the tool execution resulted in an error. + +*** + +### type + +> **type**: `"user.custom_tool_result"` + +Any of "user.custom_tool_result". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserDefineOutcomeEvent.md b/docs/api/managed/interfaces/ManagedAgentsUserDefineOutcomeEvent.md new file mode 100644 index 0000000..fe6e22b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserDefineOutcomeEvent.md @@ -0,0 +1,67 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserDefineOutcomeEvent + +# Interface: ManagedAgentsUserDefineOutcomeEvent + +Echo of a `user.define_outcome` input event. Carries the server-generated +`outcome_id` that subsequent `span.outcome_evaluation_*` events reference. + +## Properties + +### description + +> **description**: `string` + +What the agent should produce. Copied from the input event. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### max\_iterations + +> **max\_iterations**: `number` + +Evaluate-then-revise cycles before giving up. Default 3, max 20. + +*** + +### outcome\_id + +> **outcome\_id**: `string` + +Server-generated `outc_` ID for this outcome. Referenced by +`span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. + +*** + +### processed\_at + +> **processed\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### rubric + +> **rubric**: [`ManagedAgentsUserDefineOutcomeEventRubricUnion`](../type-aliases/ManagedAgentsUserDefineOutcomeEventRubricUnion.md) + +Rubric for grading the quality of an outcome. + +*** + +### type + +> **type**: `"user.define_outcome"` + +Any of "user.define_outcome". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserDefineOutcomeEventParams.md b/docs/api/managed/interfaces/ManagedAgentsUserDefineOutcomeEventParams.md new file mode 100644 index 0000000..fc0961b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserDefineOutcomeEventParams.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserDefineOutcomeEventParams + +# Interface: ManagedAgentsUserDefineOutcomeEventParams + +Parameters for defining an outcome the agent should work toward. The agent +begins work on receipt. + +## Properties + +### description + +> **description**: `string` + +What the agent should produce. This is the task specification. + +*** + +### max\_iterations? + +> `optional` **max\_iterations?**: `number` \| `null` + +Eval→revision cycles before giving up. Default 3, max 20. + +*** + +### rubric + +> **rubric**: [`ManagedAgentsUserDefineOutcomeEventParamsRubricUnion`](../type-aliases/ManagedAgentsUserDefineOutcomeEventParamsRubricUnion.md) + +Rubric for grading the quality of an outcome. + +*** + +### type + +> **type**: `"user.define_outcome"` + +Any of "user.define_outcome". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserInterruptEvent.md b/docs/api/managed/interfaces/ManagedAgentsUserInterruptEvent.md new file mode 100644 index 0000000..74743b1 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserInterruptEvent.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserInterruptEvent + +# Interface: ManagedAgentsUserInterruptEvent + +An interrupt event that pauses agent execution and returns control to the user. + +## Properties + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at? + +> `optional` **processed\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id? + +> `optional` **session\_thread\_id?**: `string` \| `null` + +If absent, interrupts every non-archived thread in a multiagent session (or the +primary alone in a single-agent session). If present, interrupts only the named +thread. + +*** + +### type + +> **type**: `"user.interrupt"` + +Any of "user.interrupt". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserInterruptEventParams.md b/docs/api/managed/interfaces/ManagedAgentsUserInterruptEventParams.md new file mode 100644 index 0000000..96d197a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserInterruptEventParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserInterruptEventParams + +# Interface: ManagedAgentsUserInterruptEventParams + +Parameters for sending an interrupt to pause the agent. + +## Properties + +### session\_thread\_id? + +> `optional` **session\_thread\_id?**: `string` \| `null` + +If absent, interrupts every non-archived thread in a multiagent session (or the +primary alone in a single-agent session). If present, interrupts only the named +thread. + +*** + +### type + +> **type**: `"user.interrupt"` + +Any of "user.interrupt". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserLocation.md b/docs/api/managed/interfaces/ManagedAgentsUserLocation.md new file mode 100644 index 0000000..cac1bf4 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserLocation.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserLocation + +# Interface: ManagedAgentsUserLocation + +Approximate user location for search result localization. + +## Properties + +### city? + +> `optional` **city?**: `string` \| `null` + +City name. + +*** + +### country? + +> `optional` **country?**: `string` \| `null` + +Two-letter ISO 3166-1 country code, uppercase. + +*** + +### region? + +> `optional` **region?**: `string` \| `null` + +Region or state name. + +*** + +### timezone? + +> `optional` **timezone?**: `string` \| `null` + +IANA timezone identifier, e.g. "America/Los_Angeles". + +*** + +### type? + +> `optional` **type?**: `"approximate"` + +Location precision. Only "approximate" is supported. diff --git a/docs/api/managed/interfaces/ManagedAgentsUserLocationParam.md b/docs/api/managed/interfaces/ManagedAgentsUserLocationParam.md new file mode 100644 index 0000000..a488197 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserLocationParam.md @@ -0,0 +1,51 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserLocationParam + +# Interface: ManagedAgentsUserLocationParam + +Approximate user location for search result localization. + +## Properties + +### city? + +> `optional` **city?**: `string` \| `null` + +City name. + +*** + +### country? + +> `optional` **country?**: `string` \| `null` + +Two-letter ISO 3166-1 country code, uppercase. + +*** + +### region? + +> `optional` **region?**: `string` \| `null` + +Region or state name. + +*** + +### timezone? + +> `optional` **timezone?**: `string` \| `null` + +IANA timezone identifier, e.g. "America/Los_Angeles". + +*** + +### type? + +> `optional` **type?**: `"approximate"` \| `null` + +Location precision. Only "approximate" is supported. + +This field can be elided, and will marshal its zero value as "approximate". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserMessageEvent.md b/docs/api/managed/interfaces/ManagedAgentsUserMessageEvent.md new file mode 100644 index 0000000..5dfaf36 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserMessageEvent.md @@ -0,0 +1,41 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserMessageEvent + +# Interface: ManagedAgentsUserMessageEvent + +A user message event in the session conversation. + +## Properties + +### content + +> **content**: [`ManagedAgentsUserMessageEventContentUnion`](../type-aliases/ManagedAgentsUserMessageEventContentUnion.md)[] + +Array of content blocks comprising the user message. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at? + +> `optional` **processed\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### type + +> **type**: `"user.message"` + +Any of "user.message". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserMessageEventContentUnionSource.md b/docs/api/managed/interfaces/ManagedAgentsUserMessageEventContentUnionSource.md new file mode 100644 index 0000000..102c2a3 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserMessageEventContentUnionSource.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserMessageEventContentUnionSource + +# Interface: ManagedAgentsUserMessageEventContentUnionSource + +## Properties + +### data? + +> `optional` **data?**: `string` + +*** + +### file\_id? + +> `optional` **file\_id?**: `string` + +*** + +### media\_type? + +> `optional` **media\_type?**: `string` + +*** + +### type? + +> `optional` **type?**: `string` + +*** + +### url? + +> `optional` **url?**: `string` diff --git a/docs/api/managed/interfaces/ManagedAgentsUserMessageEventParams.md b/docs/api/managed/interfaces/ManagedAgentsUserMessageEventParams.md new file mode 100644 index 0000000..6b14eb5 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserMessageEventParams.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserMessageEventParams + +# Interface: ManagedAgentsUserMessageEventParams + +Parameters for sending a user message to the session. + +## Properties + +### content + +> **content**: [`ManagedAgentsUserMessageEventParamsContentUnion`](../type-aliases/ManagedAgentsUserMessageEventParamsContentUnion.md)[] + +Array of content blocks for the user message. + +*** + +### type + +> **type**: `"user.message"` + +Any of "user.message". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserToolConfirmationEvent.md b/docs/api/managed/interfaces/ManagedAgentsUserToolConfirmationEvent.md new file mode 100644 index 0000000..d71c62b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserToolConfirmationEvent.md @@ -0,0 +1,73 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolConfirmationEvent + +# Interface: ManagedAgentsUserToolConfirmationEvent + +A tool confirmation event that approves or denies a pending tool execution. + +## Properties + +### deny\_message? + +> `optional` **deny\_message?**: `string` \| `null` + +Optional message providing context for a 'deny' decision. Only allowed when +result is 'deny'. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### processed\_at? + +> `optional` **processed\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### result + +> **result**: [`ManagedAgentsUserToolConfirmationEventResult`](../type-aliases/ManagedAgentsUserToolConfirmationEventResult.md) + +UserToolConfirmationResult enum + +Any of "allow", "deny". + +*** + +### session\_thread\_id? + +> `optional` **session\_thread\_id?**: `string` \| `null` + +When set, the confirmation routes to this subagent's thread rather than the +primary. Echo this from the `session_thread_id` on the `agent.tool_use` or +`agent.mcp_tool_use` event that prompted the approval. + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result +corresponds to, which can be found in the last `session.status_idle` +[event's](https://docs.qoder.com/cloud-agents/api/sessions/schemas) +`stop_reason.event_ids` field. + +*** + +### type + +> **type**: `"user.tool_confirmation"` + +Any of "user.tool_confirmation". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserToolConfirmationEventParams.md b/docs/api/managed/interfaces/ManagedAgentsUserToolConfirmationEventParams.md new file mode 100644 index 0000000..e1c62f5 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserToolConfirmationEventParams.md @@ -0,0 +1,47 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolConfirmationEventParams + +# Interface: ManagedAgentsUserToolConfirmationEventParams + +Parameters for confirming or denying a tool execution request. + +## Properties + +### deny\_message? + +> `optional` **deny\_message?**: `string` \| `null` + +Optional message providing context for a 'deny' decision. Only allowed when +result is 'deny'. + +*** + +### result + +> **result**: [`ManagedAgentsUserToolConfirmationEventParamsResult`](../type-aliases/ManagedAgentsUserToolConfirmationEventParamsResult.md) + +UserToolConfirmationResult enum + +Any of "allow", "deny". + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result +corresponds to, which can be found in the last `session.status_idle` +[event's](https://docs.qoder.com/cloud-agents/api/sessions/schemas) +`stop_reason.event_ids` field. + +*** + +### type + +> **type**: `"user.tool_confirmation"` + +Any of "user.tool_confirmation". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserToolResultEvent.md b/docs/api/managed/interfaces/ManagedAgentsUserToolResultEvent.md new file mode 100644 index 0000000..bf93519 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserToolResultEvent.md @@ -0,0 +1,71 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolResultEvent + +# Interface: ManagedAgentsUserToolResultEvent + +Event sent by the client providing the result of an agent-toolset tool +execution. Only valid on `self_hosted` environments, where sandbox-routed tools +are executed by the client rather than the server. + +## Properties + +### content? + +> `optional` **content?**: [`ManagedAgentsUserToolResultEventContentUnion`](../type-aliases/ManagedAgentsUserToolResultEventContentUnion.md)[] + +The result content returned by the tool. + +*** + +### id + +> **id**: `string` + +Unique identifier for this event. + +*** + +### is\_error? + +> `optional` **is\_error?**: `boolean` \| `null` + +Whether the tool execution resulted in an error. + +*** + +### processed\_at? + +> `optional` **processed\_at?**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### session\_thread\_id? + +> `optional` **session\_thread\_id?**: `string` \| `null` + +Routes this result to a subagent thread. Copy from the `agent.tool_use` event's +`session_thread_id`. + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +The id of the `agent.tool_use` event this result corresponds to, which can be +found in the last `session.status_idle` +[event's](https://docs.qoder.com/cloud-agents/api/sessions/schemas) +`stop_reason.event_ids` field. + +*** + +### type + +> **type**: `"user.tool_result"` + +Any of "user.tool_result". diff --git a/docs/api/managed/interfaces/ManagedAgentsUserToolResultEventParams.md b/docs/api/managed/interfaces/ManagedAgentsUserToolResultEventParams.md new file mode 100644 index 0000000..2b705d9 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsUserToolResultEventParams.md @@ -0,0 +1,46 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolResultEventParams + +# Interface: ManagedAgentsUserToolResultEventParams + +Parameters for providing the result of an agent-toolset tool execution. Only +valid on `self_hosted` environments, where sandbox-routed tools are executed by +the client rather than the server. + +## Properties + +### content? + +> `optional` **content?**: [`ManagedAgentsUserToolResultEventParamsContentUnion`](../type-aliases/ManagedAgentsUserToolResultEventParamsContentUnion.md)[] \| `null` + +The result content returned by the tool. + +*** + +### is\_error? + +> `optional` **is\_error?**: `boolean` \| `null` + +Whether the tool execution resulted in an error. + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +The id of the `agent.tool_use` event this result corresponds to, which can be +found in the last `session.status_idle` +[event's](https://docs.qoder.com/cloud-agents/api/sessions/schemas) +`stop_reason.event_ids` field. + +*** + +### type + +> **type**: `"user.tool_result"` + +Any of "user.tool_result". diff --git a/docs/api/managed/interfaces/ManagedAgentsVault.md b/docs/api/managed/interfaces/ManagedAgentsVault.md new file mode 100644 index 0000000..6a2d12a --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsVault.md @@ -0,0 +1,65 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVault + +# Interface: ManagedAgentsVault + +A vault that stores credentials for use by agents during sessions. + +## Properties + +### archived\_at + +> **archived\_at**: `string` \| `null` + +A timestamp in RFC 3339 format + +*** + +### created\_at + +> **created\_at**: `string` + +A timestamp in RFC 3339 format + +*** + +### display\_name + +> **display\_name**: `string` + +Human-readable name for the vault. + +*** + +### id + +> **id**: `string` + +Unique identifier for the vault. + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `string`\> + +Arbitrary key-value metadata attached to the vault. + +*** + +### type + +> **type**: `"vault"` + +Any of "vault". + +*** + +### updated\_at + +> **updated\_at**: `string` + +A timestamp in RFC 3339 format diff --git a/docs/api/managed/interfaces/ManagedAgentsVaultArchivedDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsVaultArchivedDeploymentPausedReasonError.md new file mode 100644 index 0000000..41c9892 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsVaultArchivedDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVaultArchivedDeploymentPausedReasonError + +# Interface: ManagedAgentsVaultArchivedDeploymentPausedReasonError + +A vault referenced by the deployment is archived. + +## Properties + +### type + +> **type**: `"vault_archived_error"` + +Any of "vault_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsVaultArchivedRunError.md b/docs/api/managed/interfaces/ManagedAgentsVaultArchivedRunError.md new file mode 100644 index 0000000..aee602b --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsVaultArchivedRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVaultArchivedRunError + +# Interface: ManagedAgentsVaultArchivedRunError + +A vault referenced by the deployment is archived. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"vault_archived_error"` + +Any of "vault_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsVaultNotFoundDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsVaultNotFoundDeploymentPausedReasonError.md new file mode 100644 index 0000000..2444fcd --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsVaultNotFoundDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVaultNotFoundDeploymentPausedReasonError + +# Interface: ManagedAgentsVaultNotFoundDeploymentPausedReasonError + +A vault referenced by the deployment no longer exists. + +## Properties + +### type + +> **type**: `"vault_not_found_error"` + +Any of "vault_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsVaultNotFoundRunError.md b/docs/api/managed/interfaces/ManagedAgentsVaultNotFoundRunError.md new file mode 100644 index 0000000..7003078 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsVaultNotFoundRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVaultNotFoundRunError + +# Interface: ManagedAgentsVaultNotFoundRunError + +A vault referenced by the deployment no longer exists. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"vault_not_found_error"` + +Any of "vault_not_found_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsWebFetchToolConfig.md b/docs/api/managed/interfaces/ManagedAgentsWebFetchToolConfig.md new file mode 100644 index 0000000..e0bd557 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsWebFetchToolConfig.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebFetchToolConfig + +# Interface: ManagedAgentsWebFetchToolConfig + +Configuration for the web_fetch tool. + +## Properties + +### allowed\_domains? + +> `optional` **allowed\_domains?**: `string`[] + +*** + +### blocked\_domains? + +> `optional` **blocked\_domains?**: `string`[] + +*** + +### enabled + +> **enabled**: `boolean` + +*** + +### max\_content\_tokens? + +> `optional` **max\_content\_tokens?**: `number` \| `null` + +*** + +### name? + +> `optional` **name?**: `"web_fetch"` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsWebFetchToolConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsWebFetchToolConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"web_fetch"` diff --git a/docs/api/managed/interfaces/ManagedAgentsWebFetchToolConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsWebFetchToolConfigParams.md new file mode 100644 index 0000000..7b12389 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsWebFetchToolConfigParams.md @@ -0,0 +1,75 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebFetchToolConfigParams + +# Interface: ManagedAgentsWebFetchToolConfigParams + +Configuration override for the web_fetch tool. + +## Properties + +### allowed\_domains? + +> `optional` **allowed\_domains?**: `string`[] \| `null` + +Only fetch URLs whose host is one of these domains or a subdomain of one. Each +entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At +most 64 entries; an empty list is rejected (omit the field instead). Cannot be +combined with blocked_domains. + +*** + +### blocked\_domains? + +> `optional` **blocked\_domains?**: `string`[] \| `null` + +Never fetch URLs whose host is one of these domains or a subdomain of one. Each +entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At +most 64 entries; an empty list is rejected (omit the field instead). Cannot be +combined with allowed_domains. + +*** + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether this tool is enabled and available to Claude. Overrides the +default_config setting. + +*** + +### max\_content\_tokens? + +> `optional` **max\_content\_tokens?**: `number` \| `null` + +Maximum number of tokens of fetched text content to include in context per call. +Does not apply to binary content such as PDFs. + +*** + +### name? + +> `optional` **name?**: `"web_fetch"` \| `null` + +Must be "web_fetch". + +This field can be elided, and will marshal its zero value as "web_fetch". + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"web_fetch"` \| `null` + +Any of "web_fetch". diff --git a/docs/api/managed/interfaces/ManagedAgentsWebSearchToolConfig.md b/docs/api/managed/interfaces/ManagedAgentsWebSearchToolConfig.md new file mode 100644 index 0000000..b9a5c11 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsWebSearchToolConfig.md @@ -0,0 +1,55 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebSearchToolConfig + +# Interface: ManagedAgentsWebSearchToolConfig + +Configuration for the web_search tool. + +## Properties + +### allowed\_domains? + +> `optional` **allowed\_domains?**: `string`[] + +*** + +### blocked\_domains? + +> `optional` **blocked\_domains?**: `string`[] + +*** + +### enabled + +> **enabled**: `boolean` + +*** + +### name? + +> `optional` **name?**: `"web_search"` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsWebSearchToolConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsWebSearchToolConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"web_search"` + +*** + +### user\_location? + +> `optional` **user\_location?**: [`ManagedAgentsUserLocation`](ManagedAgentsUserLocation.md) \| `null` + +Approximate user location for search result localization. diff --git a/docs/api/managed/interfaces/ManagedAgentsWebSearchToolConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsWebSearchToolConfigParams.md new file mode 100644 index 0000000..eac8a64 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsWebSearchToolConfigParams.md @@ -0,0 +1,74 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebSearchToolConfigParams + +# Interface: ManagedAgentsWebSearchToolConfigParams + +Configuration override for the web_search tool. + +## Properties + +### allowed\_domains? + +> `optional` **allowed\_domains?**: `string`[] \| `null` + +Only return search results whose host is one of these domains or a subdomain of +one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; +an optional path suffix is accepted). At most 64 entries; an empty list is +rejected (omit the field instead). Cannot be combined with blocked_domains. + +*** + +### blocked\_domains? + +> `optional` **blocked\_domains?**: `string`[] \| `null` + +Never return search results whose host is one of these domains or a subdomain of +one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; +an optional path suffix is accepted). At most 64 entries; an empty list is +rejected (omit the field instead). Cannot be combined with allowed_domains. + +*** + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether this tool is enabled and available to Claude. Overrides the +default_config setting. + +*** + +### name? + +> `optional` **name?**: `"web_search"` \| `null` + +Must be "web_search". + +This field can be elided, and will marshal its zero value as "web_search". + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"web_search"` \| `null` + +Any of "web_search". + +*** + +### user\_location? + +> `optional` **user\_location?**: [`ManagedAgentsUserLocationParam`](ManagedAgentsUserLocationParam.md) \| `null` + +Approximate user location for search result localization. diff --git a/docs/api/managed/interfaces/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError.md b/docs/api/managed/interfaces/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError.md new file mode 100644 index 0000000..c6e777e --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError + +# Interface: ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError + +The deployment's workspace was archived. + +## Properties + +### type + +> **type**: `"workspace_archived_error"` + +Any of "workspace_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsWorkspaceArchivedRunError.md b/docs/api/managed/interfaces/ManagedAgentsWorkspaceArchivedRunError.md new file mode 100644 index 0000000..1f05824 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsWorkspaceArchivedRunError.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWorkspaceArchivedRunError + +# Interface: ManagedAgentsWorkspaceArchivedRunError + +The deployment's workspace was archived. + +## Properties + +### message + +> **message**: `string` + +Human-readable error description. + +*** + +### type + +> **type**: `"workspace_archived_error"` + +Any of "workspace_archived_error". diff --git a/docs/api/managed/interfaces/ManagedAgentsWriteToolConfig.md b/docs/api/managed/interfaces/ManagedAgentsWriteToolConfig.md new file mode 100644 index 0000000..b77fb90 --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsWriteToolConfig.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWriteToolConfig + +# Interface: ManagedAgentsWriteToolConfig + +Configuration for the write tool. + +## Properties + +### enabled + +> **enabled**: `boolean` + +*** + +### name? + +> `optional` **name?**: `"write"` + +*** + +### permission\_policy + +> **permission\_policy**: [`ManagedAgentsWriteToolConfigPermissionPolicyUnion`](../type-aliases/ManagedAgentsWriteToolConfigPermissionPolicyUnion.md) + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"write"` diff --git a/docs/api/managed/interfaces/ManagedAgentsWriteToolConfigParams.md b/docs/api/managed/interfaces/ManagedAgentsWriteToolConfigParams.md new file mode 100644 index 0000000..f53b79c --- /dev/null +++ b/docs/api/managed/interfaces/ManagedAgentsWriteToolConfigParams.md @@ -0,0 +1,44 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWriteToolConfigParams + +# Interface: ManagedAgentsWriteToolConfigParams + +Configuration override for the write tool. + +## Properties + +### enabled? + +> `optional` **enabled?**: `boolean` \| `null` + +Whether this tool is enabled and available to Claude. Overrides the +default_config setting. + +*** + +### name? + +> `optional` **name?**: `"write"` \| `null` + +Must be "write". + +This field can be elided, and will marshal its zero value as "write". + +*** + +### permission\_policy? + +> `optional` **permission\_policy?**: [`ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion`](../type-aliases/ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion.md) \| `null` + +Permission policy for tool execution. + +*** + +### type? + +> `optional` **type?**: `"write"` \| `null` + +Any of "write". diff --git a/docs/api/managed/interfaces/MemoryStoreArchiveParams.md b/docs/api/managed/interfaces/MemoryStoreArchiveParams.md new file mode 100644 index 0000000..97387df --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreArchiveParams + +# Interface: MemoryStoreArchiveParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreDeleteParams.md b/docs/api/managed/interfaces/MemoryStoreDeleteParams.md new file mode 100644 index 0000000..5c860a9 --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreDeleteParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreDeleteParams + +# Interface: MemoryStoreDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreGetParams.md b/docs/api/managed/interfaces/MemoryStoreGetParams.md new file mode 100644 index 0000000..ab5905f --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreGetParams + +# Interface: MemoryStoreGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreListParams.md b/docs/api/managed/interfaces/MemoryStoreListParams.md new file mode 100644 index 0000000..fc3b175 --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreListParams.md @@ -0,0 +1,72 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreListParams + +# Interface: MemoryStoreListParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### created\_at\[gte\]? + +> `optional` **created\_at\[gte\]?**: `string` + +Return only stores whose `created_at` is at or after this time (inclusive). Sent +on the wire as `created_at`gte``. + +*** + +### created\_at\[lte\]? + +> `optional` **created\_at\[lte\]?**: `string` + +Return only stores whose `created_at` is at or before this time (inclusive). +Sent on the wire as `created_at`lte``. + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` + +When `true`, archived stores are included in the results. Defaults to `false` +(archived stores are excluded). + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum number of stores to return per page. Must be between 1 and 100. Defaults +to 20 when omitted. + +*** + +### name? + +> `optional` **name?**: `string` + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination cursor (a `page_...` value). Pass the `next_page` value from a +previous response to fetch the next page; omit for the first page. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreMemoryDeleteParams.md b/docs/api/managed/interfaces/MemoryStoreMemoryDeleteParams.md new file mode 100644 index 0000000..1ffdf79 --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreMemoryDeleteParams.md @@ -0,0 +1,35 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryDeleteParams + +# Interface: MemoryStoreMemoryDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### expected\_content\_sha256? + +> `optional` **expected\_content\_sha256?**: `string` + +Query parameter for expected_content_sha256 + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreMemoryGetParams.md b/docs/api/managed/interfaces/MemoryStoreMemoryGetParams.md new file mode 100644 index 0000000..b03ea90 --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreMemoryGetParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryGetParams + +# Interface: MemoryStoreMemoryGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### view? + +> `optional` **view?**: [`ManagedAgentsMemoryView`](../type-aliases/ManagedAgentsMemoryView.md) + +Query parameter for view + +Any of "basic", "full". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreMemoryListParams.md b/docs/api/managed/interfaces/MemoryStoreMemoryListParams.md new file mode 100644 index 0000000..94708c3 --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreMemoryListParams.md @@ -0,0 +1,72 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryListParams + +# Interface: MemoryStoreMemoryListParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### depth? + +> `optional` **depth?**: `number` + +`0` (or omitted) returns all descendants below `path_prefix` (recursive). `1` +returns immediate children only; deeper entries roll up as `memory_prefix` +items. `depth=1` behaves like `ls`; omitting `depth` behaves like `find`. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum number of items to return per page. Must be between 1 and 100. Defaults +to 20 when omitted. Capped at 20 when `view=full`. Both `memory` and +`memory_prefix` items count toward the limit. + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination cursor (a `page_...` value). Pass the `next_page` value from a +previous response to fetch the next page; omit for the first page. + +*** + +### path\_prefix? + +> `optional` **path\_prefix?**: `string` + +Optional path prefix filter. Must end with `/` (segment-aligned), e.g., +`/notes/`. This value appears in request URLs. Do not include secrets or +personally identifiable information. + +*** + +### view? + +> `optional` **view?**: [`ManagedAgentsMemoryView`](../type-aliases/ManagedAgentsMemoryView.md) + +Which projection of each `memory` to return. Defaults to `basic` (content +omitted). `full` populates `content` on each item and caps `limit` at 20; use +this as the bulk-read path for export and sync. + +Any of "basic", "full". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreMemoryNewParams.md b/docs/api/managed/interfaces/MemoryStoreMemoryNewParams.md new file mode 100644 index 0000000..fddcb4d --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreMemoryNewParams.md @@ -0,0 +1,58 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryNewParams + +# Interface: MemoryStoreMemoryNewParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### content + +> **content**: `string` + +UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; +pass `""` explicitly to create an empty memory. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +*** + +### path + +> **path**: `string` + +Hierarchical path for the new memory, e.g. `/projects/foo/notes.md`. Must start +with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. +Must not contain empty segments, `.` or `..` segments, control or format +characters, or the Unicode line and paragraph separators (U+2028, U+2029), and +must be NFC-normalized. Paths are case-sensitive. + +*** + +### view? + +> `optional` **view?**: [`ManagedAgentsMemoryView`](../type-aliases/ManagedAgentsMemoryView.md) + +Query parameter for view + +Any of "basic", "full". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreMemoryUpdateParams.md b/docs/api/managed/interfaces/MemoryStoreMemoryUpdateParams.md new file mode 100644 index 0000000..1fecb76 --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreMemoryUpdateParams.md @@ -0,0 +1,84 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryUpdateParams + +# Interface: MemoryStoreMemoryUpdateParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### content? + +> `optional` **content?**: `string` \| `null` + +New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to +leave the content unchanged (e.g., for a rename-only update). + +*** + +### content\_sha256? + +> `optional` **content\_sha256?**: `string` \| `null` + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +*** + +### path? + +> `optional` **path?**: `string` \| `null` + +New path for the memory (a rename). Must start with `/`, contain at least one +non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, +`.` or `..` segments, control or format characters, or the Unicode line and +paragraph separators (U+2028, U+2029), and must be NFC-normalized. Paths are +case-sensitive. The memory's `id` is preserved across renames. Omit to leave the +path unchanged. + +*** + +### precondition? + +> `optional` **precondition?**: [`ManagedAgentsPreconditionParam`](ManagedAgentsPreconditionParam.md) \| `null` + +Optimistic-concurrency precondition: the update applies only if the memory's +stored `content_sha256` equals the supplied value. On mismatch, the request +returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and +retry against the fresh state. If the precondition fails but the stored state +already exactly matches the requested `content` and `path`, the server returns +200 instead of 409. + +*** + +### view? + +> `optional` **view?**: [`ManagedAgentsMemoryView`](../type-aliases/ManagedAgentsMemoryView.md) + +Query parameter for view + +Any of "basic", "full". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreMemoryVersionGetParams.md b/docs/api/managed/interfaces/MemoryStoreMemoryVersionGetParams.md new file mode 100644 index 0000000..5d12b8a --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreMemoryVersionGetParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryVersionGetParams + +# Interface: MemoryStoreMemoryVersionGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### view? + +> `optional` **view?**: [`ManagedAgentsMemoryView`](../type-aliases/ManagedAgentsMemoryView.md) + +Query parameter for view + +Any of "basic", "full". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreMemoryVersionListParams.md b/docs/api/managed/interfaces/MemoryStoreMemoryVersionListParams.md new file mode 100644 index 0000000..2ead38b --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreMemoryVersionListParams.md @@ -0,0 +1,105 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryVersionListParams + +# Interface: MemoryStoreMemoryVersionListParams + +## Properties + +### api\_key\_id? + +> `optional` **api\_key\_id?**: `string` + +Query parameter for api_key_id + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### created\_at\[gte\]? + +> `optional` **created\_at\[gte\]?**: `string` + +Return versions created at or after this time (inclusive). + +*** + +### created\_at\[lte\]? + +> `optional` **created\_at\[lte\]?**: `string` + +Return versions created at or before this time (inclusive). + +*** + +### limit? + +> `optional` **limit?**: `number` + +Query parameter for limit + +*** + +### memory\_id? + +> `optional` **memory\_id?**: `string` + +Query parameter for memory_id + +*** + +### operation? + +> `optional` **operation?**: [`ManagedAgentsMemoryVersionOperation`](../type-aliases/ManagedAgentsMemoryVersionOperation.md) + +Query parameter for operation + +Any of "created", "modified", "deleted". + +*** + +### page? + +> `optional` **page?**: `string` + +Query parameter for page + +*** + +### service\_account\_id? + +> `optional` **service\_account\_id?**: `string` + +Query parameter for service_account_id + +*** + +### session\_id? + +> `optional` **session\_id?**: `string` + +Query parameter for session_id + +*** + +### view? + +> `optional` **view?**: [`ManagedAgentsMemoryView`](../type-aliases/ManagedAgentsMemoryView.md) + +Query parameter for view + +Any of "basic", "full". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreMemoryVersionRedactParams.md b/docs/api/managed/interfaces/MemoryStoreMemoryVersionRedactParams.md new file mode 100644 index 0000000..d4f8f1f --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreMemoryVersionRedactParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryVersionRedactParams + +# Interface: MemoryStoreMemoryVersionRedactParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreNewParams.md b/docs/api/managed/interfaces/MemoryStoreNewParams.md new file mode 100644 index 0000000..a789024 --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreNewParams.md @@ -0,0 +1,52 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreNewParams + +# Interface: MemoryStoreNewParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +Free-text description of what the store contains, up to 1024 characters. +Included in the agent's system prompt when the store is attached, so word it to +be useful to the agent. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +Arbitrary key-value tags for your own bookkeeping (such as the end user a store +belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. +Not visible to the agent. + +*** + +### name + +> **name**: `string` + +Human-readable name for the store. Required; 1–255 characters; no control +characters. The mount-path slug under `/mnt/memory/` is derived from this name +(lowercased, non-alphanumeric runs collapsed to a hyphen). Names need not be +unique within a workspace. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MemoryStoreUpdateParams.md b/docs/api/managed/interfaces/MemoryStoreUpdateParams.md new file mode 100644 index 0000000..a2cf0f1 --- /dev/null +++ b/docs/api/managed/interfaces/MemoryStoreUpdateParams.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreUpdateParams + +# Interface: MemoryStoreUpdateParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### description? + +> `optional` **description?**: `string` \| `null` + +New description for the store, up to 1024 characters. Pass an empty string to +clear it. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +Metadata patch. Set a key to a string to upsert it, or to null to delete it. +Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars +each) with values up to 512 chars. + +*** + +### name? + +> `optional` **name?**: `string` \| `null` + +New human-readable name for the store. 1–255 characters; no control characters. +Renaming changes the slug used for the store's `mount_path` in sessions created +after the update. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/ModelCapabilities.md b/docs/api/managed/interfaces/ModelCapabilities.md new file mode 100644 index 0000000..a712f9a --- /dev/null +++ b/docs/api/managed/interfaces/ModelCapabilities.md @@ -0,0 +1,81 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ModelCapabilities + +# Interface: ModelCapabilities + +Model capability information. + +## Properties + +### batch + +> **batch**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports the Batch API. + +*** + +### citations + +> **citations**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports citation generation. + +*** + +### code\_execution + +> **code\_execution**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports code execution tools. + +*** + +### context\_management + +> **context\_management**: [`ContextManagementCapability`](ContextManagementCapability.md) + +Context management support and available strategies. + +*** + +### effort + +> **effort**: [`EffortCapability`](EffortCapability.md) + +Effort (reasoning_effort) support and available levels. + +*** + +### image\_input + +> **image\_input**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model accepts image content blocks. + +*** + +### pdf\_input + +> **pdf\_input**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model accepts PDF content blocks. + +*** + +### structured\_outputs + +> **structured\_outputs**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports structured output / JSON mode / strict tool schemas. + +*** + +### thinking + +> **thinking**: [`ThinkingCapability`](ThinkingCapability.md) + +Thinking capability and supported type configurations. diff --git a/docs/api/managed/interfaces/ModelInfo.md b/docs/api/managed/interfaces/ModelInfo.md new file mode 100644 index 0000000..3a1003c --- /dev/null +++ b/docs/api/managed/interfaces/ModelInfo.md @@ -0,0 +1,124 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ModelInfo + +# Interface: ModelInfo + +## Properties + +### allowed\_fallback\_models + +> **allowed\_fallback\_models**: `string`[] + +Model IDs this model accepts as `fallbacks`i`.model` on the Messages API. An +empty list means the `fallbacks` parameter is not supported for this model as +primary. + +*** + +### available\_context\_windows? + +> `optional` **available\_context\_windows?**: `number`[] + +*** + +### capabilities + +> **capabilities**: [`ModelCapabilities`](ModelCapabilities.md) + +Model capability information. + +*** + +### created\_at + +> **created\_at**: `string` + +RFC 3339 datetime string representing the time at which the model was released. +May be set to an epoch value if the release date is unknown. + +*** + +### default\_context\_window? + +> `optional` **default\_context\_window?**: `number` + +*** + +### default\_effort? + +> `optional` **default\_effort?**: `string` + +*** + +### display\_name + +> **display\_name**: `string` + +A human-readable name for the model. + +*** + +### efforts? + +> `optional` **efforts?**: `string`[] + +*** + +### id + +> **id**: `string` + +Unique model identifier. + +*** + +### is\_enabled? + +> `optional` **is\_enabled?**: `boolean` + +*** + +### is\_new? + +> `optional` **is\_new?**: `boolean` + +*** + +### max\_input\_tokens + +> **max\_input\_tokens**: `number` + +Maximum input context window size in tokens for this model. + +*** + +### max\_tokens + +> **max\_tokens**: `number` + +Maximum value for the `max_tokens` parameter when using this model. + +*** + +### price\_factor? + +> `optional` **price\_factor?**: `number` + +*** + +### source? + +> `optional` **source?**: `string` + +*** + +### type? + +> `optional` **type?**: `"model"` + +Object type. + +For Models, this is always `"model"`. diff --git a/docs/api/managed/interfaces/ModelListParams.md b/docs/api/managed/interfaces/ModelListParams.md new file mode 100644 index 0000000..46521d7 --- /dev/null +++ b/docs/api/managed/interfaces/ModelListParams.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ModelListParams + +# Interface: ModelListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +ID of the object to use as a cursor for pagination. When provided, returns the +page of results immediately after this object. + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +ID of the object to use as a cursor for pagination. When provided, returns the +page of results immediately before this object. + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Number of items to return per page. + +Defaults to `20`. Ranges from `1` to `1000`. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/MonetaryAmount.md b/docs/api/managed/interfaces/MonetaryAmount.md new file mode 100644 index 0000000..c5fa972 --- /dev/null +++ b/docs/api/managed/interfaces/MonetaryAmount.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MonetaryAmount + +# Interface: MonetaryAmount + +A monetary amount in a specific currency. + +## Properties + +### amount + +> **amount**: `string` + +Amount in minor units of the currency, as an integer decimal string with no +leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a +number so no float rounding is ever applied. + +*** + +### currency + +> **currency**: `"USD"` + +Uppercase ISO-4217 currency code. `USD` is the only currency currently +supported; the accepted set is closed and grows only when a new currency is +priced. + +Any of "USD". diff --git a/docs/api/managed/interfaces/MonetaryAmountParam.md b/docs/api/managed/interfaces/MonetaryAmountParam.md new file mode 100644 index 0000000..e7f6e87 --- /dev/null +++ b/docs/api/managed/interfaces/MonetaryAmountParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MonetaryAmountParam + +# Interface: MonetaryAmountParam + +A monetary amount in a specific currency. + +## Properties + +### amount + +> **amount**: `string` + +Amount in minor units of the currency, as an integer decimal string with no +leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a +number so no float rounding is ever applied. + +*** + +### currency + +> **currency**: `"USD"` + +Uppercase ISO-4217 currency code. `USD` is the only currency currently +supported; the accepted set is closed and grows only when a new currency is +priced. + +Any of "USD". diff --git a/docs/api/managed/interfaces/OutputBehaviorCreateNew.md b/docs/api/managed/interfaces/OutputBehaviorCreateNew.md new file mode 100644 index 0000000..dc98381 --- /dev/null +++ b/docs/api/managed/interfaces/OutputBehaviorCreateNew.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / OutputBehaviorCreateNew + +# Interface: OutputBehaviorCreateNew + +The default destination: the job creates a new output memory store as a clone of +the memory_store input and writes the consolidated memories into it. The input +store is never mutated. + +## Properties + +### type + +> **type**: `"create_new"` + +Any of "create_new". diff --git a/docs/api/managed/interfaces/OutputBehaviorCreateNewParam.md b/docs/api/managed/interfaces/OutputBehaviorCreateNewParam.md new file mode 100644 index 0000000..4718c80 --- /dev/null +++ b/docs/api/managed/interfaces/OutputBehaviorCreateNewParam.md @@ -0,0 +1,19 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / OutputBehaviorCreateNewParam + +# Interface: OutputBehaviorCreateNewParam + +The default destination: the job creates a new output memory store as a clone of +the memory_store input and writes the consolidated memories into it. The input +store is never mutated. + +## Properties + +### type + +> **type**: `"create_new"` + +Any of "create_new". diff --git a/docs/api/managed/interfaces/OutputBehaviorUpdateExisting.md b/docs/api/managed/interfaces/OutputBehaviorUpdateExisting.md new file mode 100644 index 0000000..b1df6a4 --- /dev/null +++ b/docs/api/managed/interfaces/OutputBehaviorUpdateExisting.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / OutputBehaviorUpdateExisting + +# Interface: OutputBehaviorUpdateExisting + +The job writes the consolidated memories into this existing memory store instead +of creating one. In EAP the store must be the job's own memory_store input, so +the job consolidates the store in place. + +## Properties + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### type + +> **type**: `"update_existing"` + +Any of "update_existing". diff --git a/docs/api/managed/interfaces/OutputBehaviorUpdateExistingParam.md b/docs/api/managed/interfaces/OutputBehaviorUpdateExistingParam.md new file mode 100644 index 0000000..c0f0fe8 --- /dev/null +++ b/docs/api/managed/interfaces/OutputBehaviorUpdateExistingParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / OutputBehaviorUpdateExistingParam + +# Interface: OutputBehaviorUpdateExistingParam + +The job writes the consolidated memories into this existing memory store instead +of creating one. In EAP the store must be the job's own memory_store input, so +the job consolidates the store in place. + +## Properties + +### memory\_store\_id + +> **memory\_store\_id**: `string` + +*** + +### type + +> **type**: `"update_existing"` + +Any of "update_existing". diff --git a/docs/api/managed/interfaces/Packages.md b/docs/api/managed/interfaces/Packages.md new file mode 100644 index 0000000..2c848d4 --- /dev/null +++ b/docs/api/managed/interfaces/Packages.md @@ -0,0 +1,67 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Packages + +# Interface: Packages + +Packages (and their versions) available in this environment. + +## Properties + +### apt + +> **apt**: `string`[] + +Ubuntu/Debian packages to install + +*** + +### cargo + +> **cargo**: `string`[] + +Rust packages to install + +*** + +### gem + +> **gem**: `string`[] + +Ruby packages to install + +*** + +### go + +> **go**: `string`[] + +Go packages to install + +*** + +### npm + +> **npm**: `string`[] + +Node.js packages to install + +*** + +### pip + +> **pip**: `string`[] + +Python packages to install + +*** + +### type? + +> `optional` **type?**: `"packages"` + +Package configuration type + +Any of "packages". diff --git a/docs/api/managed/interfaces/PackagesParams.md b/docs/api/managed/interfaces/PackagesParams.md new file mode 100644 index 0000000..63b9f9a --- /dev/null +++ b/docs/api/managed/interfaces/PackagesParams.md @@ -0,0 +1,74 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / PackagesParams + +# Interface: PackagesParams + +Specify packages (and optionally their versions) available in this environment. + +When versioning, use the version semantics relevant for the package manager, +e.g. for `pip` use `package==1.0.0`. You are responsible for validating the +package and version exist. Unversioned installs the latest. + +Under `limited` networking, requires `networking.allow_package_managers` to be +`true`. + +## Properties + +### apt? + +> `optional` **apt?**: `string`[] \| `null` + +Ubuntu/Debian packages to install + +*** + +### cargo? + +> `optional` **cargo?**: `string`[] \| `null` + +Rust packages to install + +*** + +### gem? + +> `optional` **gem?**: `string`[] \| `null` + +Ruby packages to install + +*** + +### go? + +> `optional` **go?**: `string`[] \| `null` + +Go packages to install + +*** + +### npm? + +> `optional` **npm?**: `string`[] \| `null` + +Node.js packages to install + +*** + +### pip? + +> `optional` **pip?**: `string`[] \| `null` + +Python packages to install + +*** + +### type? + +> `optional` **type?**: `"packages"` \| `null` + +Package configuration type + +Any of "packages". diff --git a/docs/api/managed/interfaces/PlainTextSourceParam.md b/docs/api/managed/interfaces/PlainTextSourceParam.md new file mode 100644 index 0000000..b0f3241 --- /dev/null +++ b/docs/api/managed/interfaces/PlainTextSourceParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / PlainTextSourceParam + +# Interface: PlainTextSourceParam + +The properties Data, MediaType, Type are required. + +## Properties + +### data + +> **data**: `string` + +*** + +### media\_type? + +> `optional` **media\_type?**: `"text/plain"` \| `null` + +This field can be elided, and will marshal its zero value as "text/plain". + +*** + +### type? + +> `optional` **type?**: `"text"` \| `null` + +This field can be elided, and will marshal its zero value as "text". diff --git a/docs/api/managed/interfaces/RedactedThinkingBlockParam.md b/docs/api/managed/interfaces/RedactedThinkingBlockParam.md new file mode 100644 index 0000000..4e46e6b --- /dev/null +++ b/docs/api/managed/interfaces/RedactedThinkingBlockParam.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / RedactedThinkingBlockParam + +# Interface: RedactedThinkingBlockParam + +The properties Data, Type are required. + +## Properties + +### data + +> **data**: `string` + +The `data` value of this redacted thinking block, exactly as returned by the API +in a previous response. Opaque and encrypted; pass it back unchanged. + +*** + +### type? + +> `optional` **type?**: `"redacted_thinking"` \| `null` + +This field can be elided, and will marshal its zero value as +"redacted_thinking". diff --git a/docs/api/managed/interfaces/RequestDocumentBlockParam.md b/docs/api/managed/interfaces/RequestDocumentBlockParam.md new file mode 100644 index 0000000..ceafbe7 --- /dev/null +++ b/docs/api/managed/interfaces/RequestDocumentBlockParam.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / RequestDocumentBlockParam + +# Interface: RequestDocumentBlockParam + +The properties Source, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### citations? + +> `optional` **citations?**: [`CitationsConfigParam`](CitationsConfigParam.md) \| `null` + +*** + +### context? + +> `optional` **context?**: `string` \| `null` + +*** + +### source + +> **source**: [`RequestDocumentBlockSourceUnionParam`](../type-aliases/RequestDocumentBlockSourceUnionParam.md) + +*** + +### title? + +> `optional` **title?**: `string` \| `null` + +*** + +### type? + +> `optional` **type?**: `"document"` \| `null` + +This field can be elided, and will marshal its zero value as "document". diff --git a/docs/api/managed/interfaces/RequestMCPToolResultBlockParam.md b/docs/api/managed/interfaces/RequestMCPToolResultBlockParam.md new file mode 100644 index 0000000..9b87546 --- /dev/null +++ b/docs/api/managed/interfaces/RequestMCPToolResultBlockParam.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / RequestMCPToolResultBlockParam + +# Interface: RequestMCPToolResultBlockParam + +The properties ToolUseID, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### content? + +> `optional` **content?**: [`RequestMCPToolResultBlockParamContentUnion`](../type-aliases/RequestMCPToolResultBlockParamContentUnion.md) \| `null` + +*** + +### is\_error? + +> `optional` **is\_error?**: `boolean` \| `null` + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"mcp_tool_result"` \| `null` + +This field can be elided, and will marshal its zero value as "mcp_tool_result". diff --git a/docs/api/managed/interfaces/RequestToolAdditionBlockParam.md b/docs/api/managed/interfaces/RequestToolAdditionBlockParam.md new file mode 100644 index 0000000..1dd6c48 --- /dev/null +++ b/docs/api/managed/interfaces/RequestToolAdditionBlockParam.md @@ -0,0 +1,38 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / RequestToolAdditionBlockParam + +# Interface: RequestToolAdditionBlockParam + +Mid-conversation directive to surface a declared tool. + +`tool` references a tool (or MCP toolset) by name from the request's `tools`; it +is offered to the model from this point in the conversation onward. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### tool + +> **tool**: [`RequestToolAdditionBlockToolUnionParam`](../type-aliases/RequestToolAdditionBlockToolUnionParam.md) + +Reference to a single tool the caller declared directly in `tools[]`. Does not +accept the composed `{server}_{name}` form the server assigns to MCP-resolved +tools — use `mcp_tool_reference` or `mcp_toolset_reference` for those. + +*** + +### type? + +> `optional` **type?**: `"tool_addition"` \| `null` + +This field can be elided, and will marshal its zero value as "tool_addition". diff --git a/docs/api/managed/interfaces/RequestToolRemovalBlockParam.md b/docs/api/managed/interfaces/RequestToolRemovalBlockParam.md new file mode 100644 index 0000000..498a369 --- /dev/null +++ b/docs/api/managed/interfaces/RequestToolRemovalBlockParam.md @@ -0,0 +1,38 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / RequestToolRemovalBlockParam + +# Interface: RequestToolRemovalBlockParam + +Mid-conversation directive to withdraw a tool. + +`tool` references a tool (or MCP toolset) by name from the request's `tools`; it +is no longer offered to the model from this point in the conversation onward. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### tool + +> **tool**: [`RequestToolRemovalBlockToolUnionParam`](../type-aliases/RequestToolRemovalBlockToolUnionParam.md) + +Reference to a single tool the caller declared directly in `tools[]`. Does not +accept the composed `{server}_{name}` form the server assigns to MCP-resolved +tools — use `mcp_tool_reference` or `mcp_toolset_reference` for those. + +*** + +### type? + +> `optional` **type?**: `"tool_removal"` \| `null` + +This field can be elided, and will marshal its zero value as "tool_removal". diff --git a/docs/api/managed/interfaces/SearchResultBlockParam.md b/docs/api/managed/interfaces/SearchResultBlockParam.md new file mode 100644 index 0000000..8f1243f --- /dev/null +++ b/docs/api/managed/interfaces/SearchResultBlockParam.md @@ -0,0 +1,49 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SearchResultBlockParam + +# Interface: SearchResultBlockParam + +The properties Content, Source, Title, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### citations? + +> `optional` **citations?**: [`CitationsConfigParam`](CitationsConfigParam.md) \| `null` + +*** + +### content + +> **content**: [`TextBlockParam`](TextBlockParam.md)[] + +*** + +### source + +> **source**: `string` + +*** + +### title + +> **title**: `string` + +*** + +### type? + +> `optional` **type?**: `"search_result"` \| `null` + +This field can be elided, and will marshal its zero value as "search_result". diff --git a/docs/api/managed/interfaces/SelfHostedConfig.md b/docs/api/managed/interfaces/SelfHostedConfig.md new file mode 100644 index 0000000..2bef9e3 --- /dev/null +++ b/docs/api/managed/interfaces/SelfHostedConfig.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedConfig + +# Interface: SelfHostedConfig + +Configuration for self-hosted environments. + +## Properties + +### type? + +> `optional` **type?**: `"self_hosted"` + +Environment type diff --git a/docs/api/managed/interfaces/SelfHostedConfigParams.md b/docs/api/managed/interfaces/SelfHostedConfigParams.md new file mode 100644 index 0000000..5c39bbd --- /dev/null +++ b/docs/api/managed/interfaces/SelfHostedConfigParams.md @@ -0,0 +1,20 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedConfigParams + +# Interface: SelfHostedConfigParams + +Request params for `self_hosted` environment configuration. + +This struct has a constant value, construct it with +`NewSelfHostedConfigParams`. + +## Properties + +### type? + +> `optional` **type?**: `"self_hosted"` \| `null` + +Environment type diff --git a/docs/api/managed/interfaces/SelfHostedWork.md b/docs/api/managed/interfaces/SelfHostedWork.md new file mode 100644 index 0000000..c93667d --- /dev/null +++ b/docs/api/managed/interfaces/SelfHostedWork.md @@ -0,0 +1,120 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedWork + +# Interface: SelfHostedWork + +Work resource representing a unit of work in a self-hosted environment. + +Work items are queued when sessions are created or when long-dormant sessions +receive new messages. The Environment Manager polls for work items and executes +them on customer-hosted infrastructure. + +## Properties + +### acknowledged\_at + +> **acknowledged\_at**: `string` \| `null` + +RFC 3339 timestamp when work was acknowledged by Environment Manager + +*** + +### created\_at + +> **created\_at**: `string` + +RFC 3339 timestamp when work was created + +*** + +### data + +> **data**: [`SessionWorkData`](SessionWorkData.md) + +The actual work to be performed + +*** + +### environment\_id + +> **environment\_id**: `string` + +Environment identifier this work belongs to (e.g., `env_...`) + +*** + +### id + +> **id**: `string` + +Work identifier (e.g., 'work\_...') + +*** + +### latest\_heartbeat\_at + +> **latest\_heartbeat\_at**: `string` \| `null` + +RFC 3339 timestamp of the most recent heartbeat + +*** + +### metadata + +> **metadata**: `Record`\<`string`, `string`\> + +User-provided metadata key-value pairs associated with this work item + +*** + +### secret + +> **secret**: `string` + +Credential payload used by the environment worker to execute this work item. May +be populated when polling for work; null on all other retrieval paths. + +*** + +### started\_at + +> **started\_at**: `string` \| `null` + +RFC 3339 timestamp when work execution started + +*** + +### state + +> **state**: [`SelfHostedWorkState`](../type-aliases/SelfHostedWorkState.md) + +Current state of the work item + +Any of "queued", "starting", "active", "stopping", "stopped". + +*** + +### stop\_requested\_at + +> **stop\_requested\_at**: `string` \| `null` + +RFC 3339 timestamp when stop was requested + +*** + +### stopped\_at + +> **stopped\_at**: `string` \| `null` + +RFC 3339 timestamp when work execution stopped + +*** + +### type? + +> `optional` **type?**: `"work"` + +The type of object (always 'work') diff --git a/docs/api/managed/interfaces/SelfHostedWorkHeartbeatResponse.md b/docs/api/managed/interfaces/SelfHostedWorkHeartbeatResponse.md new file mode 100644 index 0000000..f03ec1d --- /dev/null +++ b/docs/api/managed/interfaces/SelfHostedWorkHeartbeatResponse.md @@ -0,0 +1,51 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedWorkHeartbeatResponse + +# Interface: SelfHostedWorkHeartbeatResponse + +Response after recording a heartbeat for a work item. + +## Properties + +### last\_heartbeat + +> **last\_heartbeat**: `string` + +RFC 3339 timestamp of the actual heartbeat from DB + +*** + +### lease\_extended + +> **lease\_extended**: `boolean` + +Whether the heartbeat succeeded in extending the lease + +*** + +### state + +> **state**: [`SelfHostedWorkHeartbeatResponseState`](../type-aliases/SelfHostedWorkHeartbeatResponseState.md) + +Current state of the work item (active/stopping/stopped) + +Any of "queued", "starting", "active", "stopping", "stopped". + +*** + +### ttl\_seconds + +> **ttl\_seconds**: `number` + +Effective TTL applied to the lease + +*** + +### type? + +> `optional` **type?**: `"work_heartbeat"` + +The type of response diff --git a/docs/api/managed/interfaces/SelfHostedWorkListResponse.md b/docs/api/managed/interfaces/SelfHostedWorkListResponse.md new file mode 100644 index 0000000..a3ce010 --- /dev/null +++ b/docs/api/managed/interfaces/SelfHostedWorkListResponse.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedWorkListResponse + +# Interface: SelfHostedWorkListResponse + +Response when listing work items with cursor-based pagination. + +## Properties + +### data + +> **data**: [`SelfHostedWork`](SelfHostedWork.md)[] + +List of work items + +*** + +### next\_page + +> **next\_page**: `string` + +Opaque cursor for fetching the next page of results diff --git a/docs/api/managed/interfaces/SelfHostedWorkQueueStats.md b/docs/api/managed/interfaces/SelfHostedWorkQueueStats.md new file mode 100644 index 0000000..5f425f8 --- /dev/null +++ b/docs/api/managed/interfaces/SelfHostedWorkQueueStats.md @@ -0,0 +1,53 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedWorkQueueStats + +# Interface: SelfHostedWorkQueueStats + +Statistics about the work queue for an environment. + +Uses Redis Stream consumer group metrics for O(1) queries. + +## Properties + +### depth + +> **depth**: `number` + +Number of work items waiting to be picked up (lag from consumer group) + +*** + +### oldest\_queued\_at + +> **oldest\_queued\_at**: `string` + +RFC 3339 timestamp of oldest item in the work stream (includes both queued and +pending items), null if stream empty + +*** + +### pending + +> **pending**: `number` + +Number of work items being processed (polled but not acknowledged) + +*** + +### type? + +> `optional` **type?**: `"work_queue_stats"` + +The type of object + +*** + +### workers\_polling + +> **workers\_polling**: `number` + +Number of workers that have polled for work in the last 30 seconds. Requires +worker_id to be sent with poll requests. diff --git a/docs/api/managed/interfaces/SelfHostedWorkStopRequestParam.md b/docs/api/managed/interfaces/SelfHostedWorkStopRequestParam.md new file mode 100644 index 0000000..bd0c731 --- /dev/null +++ b/docs/api/managed/interfaces/SelfHostedWorkStopRequestParam.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedWorkStopRequestParam + +# Interface: SelfHostedWorkStopRequestParam + +Request to stop a work item. + +## Properties + +### force? + +> `optional` **force?**: `boolean` \| `null` + +If true, immediately stop work without graceful shutdown diff --git a/docs/api/managed/interfaces/SelfHostedWorkUpdateRequestParam.md b/docs/api/managed/interfaces/SelfHostedWorkUpdateRequestParam.md new file mode 100644 index 0000000..a7e4887 --- /dev/null +++ b/docs/api/managed/interfaces/SelfHostedWorkUpdateRequestParam.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedWorkUpdateRequestParam + +# Interface: SelfHostedWorkUpdateRequestParam + +Request to update work item metadata. + +## Properties + +### metadata + +> **metadata**: `Record`\<`string`, `unknown`\> + +Metadata patch. Set a key to a string to upsert it, or to null to delete it. +Omit the field to preserve existing metadata. diff --git a/docs/api/managed/interfaces/ServerToolCaller20260120Param.md b/docs/api/managed/interfaces/ServerToolCaller20260120Param.md new file mode 100644 index 0000000..f1f555a --- /dev/null +++ b/docs/api/managed/interfaces/ServerToolCaller20260120Param.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ServerToolCaller20260120Param + +# Interface: ServerToolCaller20260120Param + +The properties ToolID, Type are required. + +## Properties + +### tool\_id + +> **tool\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"code_execution_20260120"` \| `null` + +This field can be elided, and will marshal its zero value as +"code_execution_20260120". diff --git a/docs/api/managed/interfaces/ServerToolCallerParam.md b/docs/api/managed/interfaces/ServerToolCallerParam.md new file mode 100644 index 0000000..4929366 --- /dev/null +++ b/docs/api/managed/interfaces/ServerToolCallerParam.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ServerToolCallerParam + +# Interface: ServerToolCallerParam + +Tool invocation generated by a server-side tool. + +## Properties + +### tool\_id + +> **tool\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"code_execution_20250825"` \| `null` + +This field can be elided, and will marshal its zero value as +"code_execution_20250825". diff --git a/docs/api/managed/interfaces/ServerToolUseBlockParam.md b/docs/api/managed/interfaces/ServerToolUseBlockParam.md new file mode 100644 index 0000000..5d56c17 --- /dev/null +++ b/docs/api/managed/interfaces/ServerToolUseBlockParam.md @@ -0,0 +1,55 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ServerToolUseBlockParam + +# Interface: ServerToolUseBlockParam + +The properties ID, Input, Name, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### caller? + +> `optional` **caller?**: [`ServerToolUseBlockParamCallerUnion`](../type-aliases/ServerToolUseBlockParamCallerUnion.md) \| `null` + +Tool invocation directly from the model. + +*** + +### id + +> **id**: `string` + +*** + +### input + +> **input**: `unknown` + +*** + +### name + +> **name**: `string` + +Any of "advisor", "web_search", "web_fetch", "code_execution", +"bash_code_execution", "text_editor_code_execution", "tool_search_tool_regex", +"tool_search_tool_bm25". + +*** + +### type? + +> `optional` **type?**: `"server_tool_use"` \| `null` + +This field can be elided, and will marshal its zero value as "server_tool_use". diff --git a/docs/api/managed/interfaces/SessionArchiveParams.md b/docs/api/managed/interfaces/SessionArchiveParams.md new file mode 100644 index 0000000..33088ef --- /dev/null +++ b/docs/api/managed/interfaces/SessionArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionArchiveParams + +# Interface: SessionArchiveParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionDeleteParams.md b/docs/api/managed/interfaces/SessionDeleteParams.md new file mode 100644 index 0000000..b3b05da --- /dev/null +++ b/docs/api/managed/interfaces/SessionDeleteParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionDeleteParams + +# Interface: SessionDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionEventListParams.md b/docs/api/managed/interfaces/SessionEventListParams.md new file mode 100644 index 0000000..e1951eb --- /dev/null +++ b/docs/api/managed/interfaces/SessionEventListParams.md @@ -0,0 +1,105 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionEventListParams + +# Interface: SessionEventListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### created\_at\[gt\]? + +> `optional` **created\_at\[gt\]?**: `string` + +Return events created after this time (exclusive). Compared against the event's +`processed_at` value. + +*** + +### created\_at\[gte\]? + +> `optional` **created\_at\[gte\]?**: `string` + +Return events created at or after this time (inclusive). Compared against the +event's `processed_at` value. + +*** + +### created\_at\[lt\]? + +> `optional` **created\_at\[lt\]?**: `string` + +Return events created before this time (exclusive). Compared against the event's +`processed_at` value. + +*** + +### created\_at\[lte\]? + +> `optional` **created\_at\[lte\]?**: `string` + +Return events created at or before this time (inclusive). Compared against the +event's `processed_at` value. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Query parameter for limit + +*** + +### order? + +> `optional` **order?**: [`SessionEventListParamsOrder`](../type-aliases/SessionEventListParamsOrder.md) + +Sort direction for results, ordered by the event's `processed_at`. Defaults to +`asc` (chronological). + +Any of "asc", "desc". + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination cursor from a previous response's `next_page`. + +*** + +### types? + +> `optional` **types?**: `string`[] + +Filter by event type. Values match the `type` field on returned events (for +example, `user.message` or `agent.tool_use`). Omit to return all event types. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionEventSendParams.md b/docs/api/managed/interfaces/SessionEventSendParams.md new file mode 100644 index 0000000..75187c1 --- /dev/null +++ b/docs/api/managed/interfaces/SessionEventSendParams.md @@ -0,0 +1,29 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionEventSendParams + +# Interface: SessionEventSendParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### events + +> **events**: [`ManagedAgentsEventParamsUnion`](../type-aliases/ManagedAgentsEventParamsUnion.md)[] + +Events to send to the `session`. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionEventStreamParams.md b/docs/api/managed/interfaces/SessionEventStreamParams.md new file mode 100644 index 0000000..8534591 --- /dev/null +++ b/docs/api/managed/interfaces/SessionEventStreamParams.md @@ -0,0 +1,46 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionEventStreamParams + +# Interface: SessionEventStreamParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### event\_deltas? + +> `optional` **event\_deltas?**: [`ManagedAgentsDeltaType`](../type-aliases/ManagedAgentsDeltaType.md)[] + +When set, this connection also receives streaming deltas (`event_start`, +`event_delta`) while an event is being produced, before the event itself +arrives. Deltas are best-effort; when the final event is produced it carries the +complete content. A model request that ends early (an error or interrupt) +produces no final event — its terminal `span.model_request_end` closes the +preview. Accepts one or more event types to preview and may be repeated: +`agent.message` streams `content_delta` fragments; `agent.thinking` is +start-only — a signal that the agent has begun extended thinking, concluded by +the `agent.thinking` event itself. Only previews of the requested event types +are sent. + +*** + +### last\_event\_id? + +> `optional` **last\_event\_id?**: `string` \| `null` + +Resume after this event ID. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionGetParams.md b/docs/api/managed/interfaces/SessionGetParams.md new file mode 100644 index 0000000..7388e2e --- /dev/null +++ b/docs/api/managed/interfaces/SessionGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionGetParams + +# Interface: SessionGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionListParams.md b/docs/api/managed/interfaces/SessionListParams.md new file mode 100644 index 0000000..0a17eee --- /dev/null +++ b/docs/api/managed/interfaces/SessionListParams.md @@ -0,0 +1,132 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionListParams + +# Interface: SessionListParams + +## Properties + +### agent\_id? + +> `optional` **agent\_id?**: `string` + +Filter sessions created with this agent ID. + +*** + +### agent\_version? + +> `optional` **agent\_version?**: `number` + +Filter by agent version. Only applies when `agent_id` is also set. + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### created\_at\[gt\]? + +> `optional` **created\_at\[gt\]?**: `string` + +Return sessions created after this time (exclusive). + +*** + +### created\_at\[gte\]? + +> `optional` **created\_at\[gte\]?**: `string` + +Return sessions created at or after this time (inclusive). + +*** + +### created\_at\[lt\]? + +> `optional` **created\_at\[lt\]?**: `string` + +Return sessions created before this time (exclusive). + +*** + +### created\_at\[lte\]? + +> `optional` **created\_at\[lte\]?**: `string` + +Return sessions created at or before this time (inclusive). + +*** + +### deployment\_id? + +> `optional` **deployment\_id?**: `string` + +Filter sessions created by this deployment ID. + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` + +When true, includes archived sessions. Default: false (exclude archived). + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum number of results to return. + +*** + +### memory\_store\_id? + +> `optional` **memory\_store\_id?**: `string` + +Filter sessions whose resources contain a `memory_store` with this memory store +ID. + +*** + +### order? + +> `optional` **order?**: [`SessionListParamsOrder`](../type-aliases/SessionListParamsOrder.md) + +Sort direction for results, ordered by `created_at`. Defaults to `desc` (newest +first). + +Any of "asc", "desc". + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination cursor from a previous response. + +*** + +### statuses? + +> `optional` **statuses?**: `string`[] + +Filter by session status. Repeat the parameter to match any of multiple +statuses. + +Any of "rescheduling", "running", "idle", "terminated". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionNewParams.md b/docs/api/managed/interfaces/SessionNewParams.md new file mode 100644 index 0000000..1c58420 --- /dev/null +++ b/docs/api/managed/interfaces/SessionNewParams.md @@ -0,0 +1,95 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionNewParams + +# Interface: SessionNewParams + +## Properties + +### agent + +> **agent**: [`SessionNewParamsAgentUnion`](../type-aliases/SessionNewParamsAgentUnion.md) + +Agent identifier. Accepts the `agent` ID string, which pins the latest version +for the session, or an `agent` object with both id and version specified. + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### budget? + +> `optional` **budget?**: [`ManagedAgentsBudgetLimitParam`](ManagedAgentsBudgetLimitParam.md) \| `null` + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +*** + +### environment\_id + +> **environment\_id**: `string` + +ID of the `environment` defining the container configuration for this session. + +*** + +### environment\_variables? + +> `optional` **environment\_variables?**: `Record`\<`string`, `string`\> \| `null` + +*** + +### initial\_events? + +> `optional` **initial\_events?**: [`SessionNewParamsInitialEventUnion`](../type-aliases/SessionNewParamsInitialEventUnion.md)[] \| `null` + +Initial events to send to the `session` at creation, processed in order. +Supports `user.message` and `user.define_outcome` events. Maximum 50 events. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up +to 64 chars, values up to 512 chars. + +*** + +### resources? + +> `optional` **resources?**: [`SessionNewParamsResourceUnion`](../type-aliases/SessionNewParamsResourceUnion.md)[] \| `null` + +Resources (e.g. repositories, files) to mount into the session's container. + +*** + +### title? + +> `optional` **title?**: `string` \| `null` + +Human-readable session title. + +*** + +### vault\_ids? + +> `optional` **vault\_ids?**: `string`[] \| `null` + +Vault IDs for stored credentials the agent can use during the session. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionResourceAddParams.md b/docs/api/managed/interfaces/SessionResourceAddParams.md new file mode 100644 index 0000000..d389d80 --- /dev/null +++ b/docs/api/managed/interfaces/SessionResourceAddParams.md @@ -0,0 +1,45 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionResourceAddParams + +# Interface: SessionResourceAddParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### file\_id + +> **file\_id**: `string` + +ID of a previously uploaded file. + +*** + +### mount\_path? + +> `optional` **mount\_path?**: `string` \| `null` + +Mount path in the container. Defaults to `/mnt/session/uploads/`. + +*** + +### type + +> **type**: `"file"` + +Any of "file". + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionResourceDeleteParams.md b/docs/api/managed/interfaces/SessionResourceDeleteParams.md new file mode 100644 index 0000000..4f014e7 --- /dev/null +++ b/docs/api/managed/interfaces/SessionResourceDeleteParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionResourceDeleteParams + +# Interface: SessionResourceDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### session\_id + +> **session\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionResourceGetParams.md b/docs/api/managed/interfaces/SessionResourceGetParams.md new file mode 100644 index 0000000..60dbc4e --- /dev/null +++ b/docs/api/managed/interfaces/SessionResourceGetParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionResourceGetParams + +# Interface: SessionResourceGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### session\_id + +> **session\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionResourceListParams.md b/docs/api/managed/interfaces/SessionResourceListParams.md new file mode 100644 index 0000000..d676330 --- /dev/null +++ b/docs/api/managed/interfaces/SessionResourceListParams.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionResourceListParams + +# Interface: SessionResourceListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum number of resources to return per page (max 1000). If omitted, returns +all resources. + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque cursor from a previous response's `next_page` field. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionResourceUpdateParams.md b/docs/api/managed/interfaces/SessionResourceUpdateParams.md new file mode 100644 index 0000000..0830a6c --- /dev/null +++ b/docs/api/managed/interfaces/SessionResourceUpdateParams.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionResourceUpdateParams + +# Interface: SessionResourceUpdateParams + +## Properties + +### authorization\_token? + +> `optional` **authorization\_token?**: `string` \| `null` + +New authorization token for the resource. Currently only `github_repository` +resources support token rotation. + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### password? + +> `optional` **password?**: `string` \| `null` + +*** + +### session\_id + +> **session\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionThreadArchiveParams.md b/docs/api/managed/interfaces/SessionThreadArchiveParams.md new file mode 100644 index 0000000..edaec54 --- /dev/null +++ b/docs/api/managed/interfaces/SessionThreadArchiveParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionThreadArchiveParams + +# Interface: SessionThreadArchiveParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### session\_id + +> **session\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionThreadEventListParams.md b/docs/api/managed/interfaces/SessionThreadEventListParams.md new file mode 100644 index 0000000..2d72c6a --- /dev/null +++ b/docs/api/managed/interfaces/SessionThreadEventListParams.md @@ -0,0 +1,55 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionThreadEventListParams + +# Interface: SessionThreadEventListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Query parameter for limit + +*** + +### page? + +> `optional` **page?**: `string` + +Query parameter for page + +*** + +### session\_id + +> **session\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionThreadEventStreamParams.md b/docs/api/managed/interfaces/SessionThreadEventStreamParams.md new file mode 100644 index 0000000..cfe47dd --- /dev/null +++ b/docs/api/managed/interfaces/SessionThreadEventStreamParams.md @@ -0,0 +1,44 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionThreadEventStreamParams + +# Interface: SessionThreadEventStreamParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### event\_deltas? + +> `optional` **event\_deltas?**: [`ManagedAgentsDeltaType`](../type-aliases/ManagedAgentsDeltaType.md)[] + +When set, this connection also receives streaming deltas (`event_start`, +`event_delta`) while an event is being produced, before the event itself +arrives. Deltas are best-effort; when the final event is produced it carries the +complete content. A model request that ends early (an error or interrupt) +produces no final event — its terminal `span.model_request_end` closes the +preview. Accepts one or more event types to preview and may be repeated: +`agent.message` streams `content_delta` fragments; `agent.thinking` is +start-only — a signal that the agent has begun extended thinking, concluded by +the `agent.thinking` event itself. Only previews of the requested event types +are sent. + +*** + +### session\_id + +> **session\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionThreadGetParams.md b/docs/api/managed/interfaces/SessionThreadGetParams.md new file mode 100644 index 0000000..eaa1441 --- /dev/null +++ b/docs/api/managed/interfaces/SessionThreadGetParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionThreadGetParams + +# Interface: SessionThreadGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### session\_id + +> **session\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionThreadListParams.md b/docs/api/managed/interfaces/SessionThreadListParams.md new file mode 100644 index 0000000..3893e98 --- /dev/null +++ b/docs/api/managed/interfaces/SessionThreadListParams.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionThreadListParams + +# Interface: SessionThreadListParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum results per page. Defaults to 1000. + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination cursor from a previous response's `next_page`. Forward-only. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionUpdateParams.md b/docs/api/managed/interfaces/SessionUpdateParams.md new file mode 100644 index 0000000..1f9bb16 --- /dev/null +++ b/docs/api/managed/interfaces/SessionUpdateParams.md @@ -0,0 +1,72 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionUpdateParams + +# Interface: SessionUpdateParams + +## Properties + +### agent? + +> `optional` **agent?**: [`ManagedAgentsSessionAgentUpdateParam`](ManagedAgentsSessionAgentUpdateParam.md) \| `null` + +Mid-session agent configuration update. Only `tools` and `mcp_servers` are +updatable. Full replacement: the provided array becomes the new value. To +preserve existing entries, GET the session, modify the array, and POST it back. + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### budget? + +> `optional` **budget?**: [`ManagedAgentsBudgetLimitParam`](ManagedAgentsBudgetLimitParam.md) \| `null` + +A hard spend ceiling. The session stops issuing new model requests once the +tracked list cost reaches `max_list_cost`. + +*** + +### environment\_variables? + +> `optional` **environment\_variables?**: `Record`\<`string`, `string`\> \| `null` + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +Metadata patch. Set a key to a string to upsert it, or to null to delete it. +Omit the field to preserve. + +*** + +### title? + +> `optional` **title?**: `string` \| `null` + +Human-readable session title. + +*** + +### vault\_ids? + +> `optional` **vault\_ids?**: `string`[] \| `null` + +Vault IDs (`vlt_*`) to attach to the session. Not yet supported; requests +setting this field are rejected. Reserved for future use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SessionWorkData.md b/docs/api/managed/interfaces/SessionWorkData.md new file mode 100644 index 0000000..1bc9174 --- /dev/null +++ b/docs/api/managed/interfaces/SessionWorkData.md @@ -0,0 +1,28 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionWorkData + +# Interface: SessionWorkData + +Work data for session work items. + +This resource type is used when work represents a session that needs to be +executed in a self-hosted environment. + +## Properties + +### id + +> **id**: `string` + +Session identifier (e.g., 'session\_...') + +*** + +### type? + +> `optional` **type?**: `"session"` + +Type of work data diff --git a/docs/api/managed/interfaces/Skill.md b/docs/api/managed/interfaces/Skill.md new file mode 100644 index 0000000..0f1e2d6 --- /dev/null +++ b/docs/api/managed/interfaces/Skill.md @@ -0,0 +1,81 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Skill + +# Interface: Skill + +## Properties + +### created\_at + +> **created\_at**: `string` + +ISO 8601 timestamp of when the skill was created. + +*** + +### display\_title + +> **display\_title**: `string` + +Human-readable, single-line label for the Skill. Maximum 255 characters. Always +set: derived from the SKILL.md frontmatter `name` when omitted at creation. Not +unique. + +*** + +### id + +> **id**: `string` + +Unique identifier for the skill. + +The format and length of IDs may change over time. + +*** + +### latest\_version + +> **latest\_version**: `string` + +ID of the newest Skill Version — what `latest` references resolve to. Always +set: a Skill holds at least one version. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> + +*** + +### source + +> **source**: [`SkillSource`](../type-aliases/SkillSource.md) + +Where the Skill comes from. + +Possible values: + +- `"custom"`: authored by the platform user; private to their workspace +- `"qoder"`: published by Qoder; shared and read-only +- `"qoder_example"`: Qoder-published sample Skill +- `"plugin"`: resolved from an installed plugin + +*** + +### type? + +> `optional` **type?**: `"skill"` + +Object type. + +For Skills, this is always `"skill"`. + +*** + +### updated\_at + +> **updated\_at**: `string` diff --git a/docs/api/managed/interfaces/SkillDeleteParams.md b/docs/api/managed/interfaces/SkillDeleteParams.md new file mode 100644 index 0000000..2e3c49f --- /dev/null +++ b/docs/api/managed/interfaces/SkillDeleteParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillDeleteParams + +# Interface: SkillDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SkillGetParams.md b/docs/api/managed/interfaces/SkillGetParams.md new file mode 100644 index 0000000..89210f0 --- /dev/null +++ b/docs/api/managed/interfaces/SkillGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillGetParams + +# Interface: SkillGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SkillListParams.md b/docs/api/managed/interfaces/SkillListParams.md new file mode 100644 index 0000000..0379a72 --- /dev/null +++ b/docs/api/managed/interfaces/SkillListParams.md @@ -0,0 +1,79 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillListParams + +# Interface: SkillListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### display\_title? + +> `optional` **display\_title?**: `string` + +*** + +### limit? + +> `optional` **limit?**: `number` + +Number of results to return per page. + +Ranges from `1` to `1000`. Defaults to `20`. + +*** + +### name? + +> `optional` **name?**: `string` + +*** + +### page? + +> `optional` **page?**: `string` + +Pagination token for fetching a specific page of results. + +Pass the value from a previous response's `next_page` field to get the next page +of results. + +*** + +### source? + +> `optional` **source?**: `string` + +Filter skills by source. + +If provided, only skills from the specified source will be returned: + +- `"custom"`: only return user-created skills +- `"qoder"`: only return Qoder-created skills + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SkillNewParams.md b/docs/api/managed/interfaces/SkillNewParams.md new file mode 100644 index 0000000..03cc125 --- /dev/null +++ b/docs/api/managed/interfaces/SkillNewParams.md @@ -0,0 +1,48 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillNewParams + +# Interface: SkillNewParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### display\_title? + +> `optional` **display\_title?**: `string` \| `null` + +Human-readable, single-line label for the Skill. Maximum 255 characters. Always +set: derived from the SKILL.md frontmatter `name` when omitted at creation. Not +unique. + +*** + +### files + +> **files**: [`Uploadable`](../../index/type-aliases/Uploadable.md)[] + +Files to upload for the skill. + +All files must be in the same top-level directory and must include a SKILL.md +file at the root of that directory. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SkillVersion.md b/docs/api/managed/interfaces/SkillVersion.md new file mode 100644 index 0000000..f871d38 --- /dev/null +++ b/docs/api/managed/interfaces/SkillVersion.md @@ -0,0 +1,77 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillVersion + +# Interface: SkillVersion + +## Properties + +### created\_at + +> **created\_at**: `string` + +ISO 8601 timestamp of when the skill was created. + +*** + +### description + +> **description**: `string` + +Description of the skill version. + +This is extracted from the SKILL.md file in the skill upload. + +*** + +### directory? + +> `optional` **directory?**: `string` + +*** + +### id + +> **id**: `string` + +Unique identifier for this Skill Version. The id addresses the version in paths +and pins it in references. + +*** + +### name + +> **name**: `string` + +The Skill's immutable kebab-case slug, set at creation from the first upload's +SKILL.md frontmatter `name` (or its enclosing directory). Every later upload +must resolve to the same value. Also the top-level directory of the Skill's +mounted files and the base name of a downloaded archive. + +*** + +### skill\_id + +> **skill\_id**: `string` + +Unique identifier for the skill. + +The format and length of IDs may change over time. + +*** + +### type? + +> `optional` **type?**: `"skill_version"` + +Object type. + +For Skill Versions, this is always `"skill_version"`. + +*** + +### version? + +> `optional` **version?**: `string` diff --git a/docs/api/managed/interfaces/SkillVersionDeleteParams.md b/docs/api/managed/interfaces/SkillVersionDeleteParams.md new file mode 100644 index 0000000..cc108e2 --- /dev/null +++ b/docs/api/managed/interfaces/SkillVersionDeleteParams.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillVersionDeleteParams + +# Interface: SkillVersionDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### skill\_id + +> **skill\_id**: `string` + +Unique identifier for the skill. + +The format and length of IDs may change over time. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SkillVersionDownloadParams.md b/docs/api/managed/interfaces/SkillVersionDownloadParams.md new file mode 100644 index 0000000..b7ed298 --- /dev/null +++ b/docs/api/managed/interfaces/SkillVersionDownloadParams.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillVersionDownloadParams + +# Interface: SkillVersionDownloadParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### skill\_id + +> **skill\_id**: `string` + +Unique identifier for the skill. + +The format and length of IDs may change over time. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SkillVersionGetParams.md b/docs/api/managed/interfaces/SkillVersionGetParams.md new file mode 100644 index 0000000..2867225 --- /dev/null +++ b/docs/api/managed/interfaces/SkillVersionGetParams.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillVersionGetParams + +# Interface: SkillVersionGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### skill\_id + +> **skill\_id**: `string` + +Unique identifier for the skill. + +The format and length of IDs may change over time. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SkillVersionListParams.md b/docs/api/managed/interfaces/SkillVersionListParams.md new file mode 100644 index 0000000..e7d3d3d --- /dev/null +++ b/docs/api/managed/interfaces/SkillVersionListParams.md @@ -0,0 +1,39 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillVersionListParams + +# Interface: SkillVersionListParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Number of results to return per page. + +Ranges from `1` to `1000`. Defaults to `20`. + +*** + +### page? + +> `optional` **page?**: `string` + +Optionally set to the `next_page` token from the previous response. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/SkillVersionNewParams.md b/docs/api/managed/interfaces/SkillVersionNewParams.md new file mode 100644 index 0000000..be286a2 --- /dev/null +++ b/docs/api/managed/interfaces/SkillVersionNewParams.md @@ -0,0 +1,32 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillVersionNewParams + +# Interface: SkillVersionNewParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### files + +> **files**: [`Uploadable`](../../index/type-aliases/Uploadable.md)[] + +Files to upload for the skill. + +All files must be in the same top-level directory and must include a SKILL.md +file at the root of that directory. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/TextBlockParam.md b/docs/api/managed/interfaces/TextBlockParam.md new file mode 100644 index 0000000..432fd6b --- /dev/null +++ b/docs/api/managed/interfaces/TextBlockParam.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextBlockParam + +# Interface: TextBlockParam + +The properties Text, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### citations? + +> `optional` **citations?**: [`TextCitationParamUnion`](../type-aliases/TextCitationParamUnion.md)[] \| `null` + +*** + +### text + +> **text**: `string` + +*** + +### type? + +> `optional` **type?**: `"text"` \| `null` + +This field can be elided, and will marshal its zero value as "text". diff --git a/docs/api/managed/interfaces/TextEditorCodeExecutionCreateResultBlockParam.md b/docs/api/managed/interfaces/TextEditorCodeExecutionCreateResultBlockParam.md new file mode 100644 index 0000000..1ec61f5 --- /dev/null +++ b/docs/api/managed/interfaces/TextEditorCodeExecutionCreateResultBlockParam.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextEditorCodeExecutionCreateResultBlockParam + +# Interface: TextEditorCodeExecutionCreateResultBlockParam + +The properties IsFileUpdate, Type are required. + +## Properties + +### is\_file\_update + +> **is\_file\_update**: `boolean` + +*** + +### type? + +> `optional` **type?**: `"text_editor_code_execution_create_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"text_editor_code_execution_create_result". diff --git a/docs/api/managed/interfaces/TextEditorCodeExecutionStrReplaceResultBlockParam.md b/docs/api/managed/interfaces/TextEditorCodeExecutionStrReplaceResultBlockParam.md new file mode 100644 index 0000000..48b8900 --- /dev/null +++ b/docs/api/managed/interfaces/TextEditorCodeExecutionStrReplaceResultBlockParam.md @@ -0,0 +1,48 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextEditorCodeExecutionStrReplaceResultBlockParam + +# Interface: TextEditorCodeExecutionStrReplaceResultBlockParam + +The property Type is required. + +## Properties + +### lines? + +> `optional` **lines?**: `string`[] \| `null` + +*** + +### new\_lines? + +> `optional` **new\_lines?**: `number` \| `null` + +*** + +### new\_start? + +> `optional` **new\_start?**: `number` \| `null` + +*** + +### old\_lines? + +> `optional` **old\_lines?**: `number` \| `null` + +*** + +### old\_start? + +> `optional` **old\_start?**: `number` \| `null` + +*** + +### type? + +> `optional` **type?**: `"text_editor_code_execution_str_replace_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"text_editor_code_execution_str_replace_result". diff --git a/docs/api/managed/interfaces/TextEditorCodeExecutionToolResultBlockParam.md b/docs/api/managed/interfaces/TextEditorCodeExecutionToolResultBlockParam.md new file mode 100644 index 0000000..1707cb9 --- /dev/null +++ b/docs/api/managed/interfaces/TextEditorCodeExecutionToolResultBlockParam.md @@ -0,0 +1,38 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextEditorCodeExecutionToolResultBlockParam + +# Interface: TextEditorCodeExecutionToolResultBlockParam + +The properties Content, ToolUseID, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### content + +> **content**: [`TextEditorCodeExecutionToolResultBlockParamContentUnion`](../type-aliases/TextEditorCodeExecutionToolResultBlockParamContentUnion.md) + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"text_editor_code_execution_tool_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"text_editor_code_execution_tool_result". diff --git a/docs/api/managed/interfaces/TextEditorCodeExecutionToolResultErrorParam.md b/docs/api/managed/interfaces/TextEditorCodeExecutionToolResultErrorParam.md new file mode 100644 index 0000000..b72ff0f --- /dev/null +++ b/docs/api/managed/interfaces/TextEditorCodeExecutionToolResultErrorParam.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextEditorCodeExecutionToolResultErrorParam + +# Interface: TextEditorCodeExecutionToolResultErrorParam + +The properties ErrorCode, Type are required. + +## Properties + +### error\_code + +> **error\_code**: `string` + +Any of "invalid_tool_input", "unavailable", "too_many_requests", +"execution_time_exceeded", "file_not_found". + +*** + +### error\_message? + +> `optional` **error\_message?**: `string` \| `null` + +*** + +### type? + +> `optional` **type?**: `"text_editor_code_execution_tool_result_error"` \| `null` + +This field can be elided, and will marshal its zero value as +"text_editor_code_execution_tool_result_error". diff --git a/docs/api/managed/interfaces/TextEditorCodeExecutionViewResultBlockParam.md b/docs/api/managed/interfaces/TextEditorCodeExecutionViewResultBlockParam.md new file mode 100644 index 0000000..a64ace2 --- /dev/null +++ b/docs/api/managed/interfaces/TextEditorCodeExecutionViewResultBlockParam.md @@ -0,0 +1,50 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextEditorCodeExecutionViewResultBlockParam + +# Interface: TextEditorCodeExecutionViewResultBlockParam + +The properties Content, FileType, Type are required. + +## Properties + +### content + +> **content**: `string` + +*** + +### file\_type + +> **file\_type**: `string` + +Any of "text", "image", "pdf". + +*** + +### num\_lines? + +> `optional` **num\_lines?**: `number` \| `null` + +*** + +### start\_line? + +> `optional` **start\_line?**: `number` \| `null` + +*** + +### total\_lines? + +> `optional` **total\_lines?**: `number` \| `null` + +*** + +### type? + +> `optional` **type?**: `"text_editor_code_execution_view_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"text_editor_code_execution_view_result". diff --git a/docs/api/managed/interfaces/ThinkingBlockParam.md b/docs/api/managed/interfaces/ThinkingBlockParam.md new file mode 100644 index 0000000..7e25dd7 --- /dev/null +++ b/docs/api/managed/interfaces/ThinkingBlockParam.md @@ -0,0 +1,37 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ThinkingBlockParam + +# Interface: ThinkingBlockParam + +The properties Signature, Thinking, Type are required. + +## Properties + +### signature + +> **signature**: `string` + +The `signature` value of this thinking block, exactly as returned by the API in +a previous response. Used to verify that the block was generated by Claude. + +Thinking blocks must be passed back unmodified and in their original order; a +modified block results in a 400 `invalid_request_error`. + +*** + +### thinking + +> **thinking**: `string` + +The `thinking` text of this block as returned by the API. + +*** + +### type? + +> `optional` **type?**: `"thinking"` \| `null` + +This field can be elided, and will marshal its zero value as "thinking". diff --git a/docs/api/managed/interfaces/ThinkingCapability.md b/docs/api/managed/interfaces/ThinkingCapability.md new file mode 100644 index 0000000..911fd08 --- /dev/null +++ b/docs/api/managed/interfaces/ThinkingCapability.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ThinkingCapability + +# Interface: ThinkingCapability + +Thinking capability details. + +## Properties + +### supported + +> **supported**: `boolean` + +Whether this capability is supported by the model. + +*** + +### types + +> **types**: [`ThinkingTypes`](ThinkingTypes.md) + +Supported thinking type configurations. diff --git a/docs/api/managed/interfaces/ThinkingTypes.md b/docs/api/managed/interfaces/ThinkingTypes.md new file mode 100644 index 0000000..15cc586 --- /dev/null +++ b/docs/api/managed/interfaces/ThinkingTypes.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ThinkingTypes + +# Interface: ThinkingTypes + +Supported thinking type configurations. + +## Properties + +### adaptive + +> **adaptive**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports thinking with type 'adaptive' (auto). + +*** + +### enabled + +> **enabled**: [`CapabilitySupport`](CapabilitySupport.md) + +Whether the model supports thinking with type 'enabled'. diff --git a/docs/api/managed/interfaces/ToolChangeMCPToolReferenceParam.md b/docs/api/managed/interfaces/ToolChangeMCPToolReferenceParam.md new file mode 100644 index 0000000..748859f --- /dev/null +++ b/docs/api/managed/interfaces/ToolChangeMCPToolReferenceParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolChangeMCPToolReferenceParam + +# Interface: ToolChangeMCPToolReferenceParam + +Reference to a single MCP tool by its server and remote name — the same +`server_name`/`name` pair `mcp_tool_use` carries. + +## Properties + +### name + +> **name**: `string` + +*** + +### server\_name + +> **server\_name**: `string` + +*** + +### type? + +> `optional` **type?**: `"mcp_tool_reference"` \| `null` + +This field can be elided, and will marshal its zero value as +"mcp_tool_reference". diff --git a/docs/api/managed/interfaces/ToolChangeMCPToolsetReferenceParam.md b/docs/api/managed/interfaces/ToolChangeMCPToolsetReferenceParam.md new file mode 100644 index 0000000..10b9df2 --- /dev/null +++ b/docs/api/managed/interfaces/ToolChangeMCPToolsetReferenceParam.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolChangeMCPToolsetReferenceParam + +# Interface: ToolChangeMCPToolsetReferenceParam + +Reference to every tool in the named MCP server's toolset. + +## Properties + +### server\_name + +> **server\_name**: `string` + +*** + +### type? + +> `optional` **type?**: `"mcp_toolset_reference"` \| `null` + +This field can be elided, and will marshal its zero value as +"mcp_toolset_reference". diff --git a/docs/api/managed/interfaces/ToolChangeToolReferenceParam.md b/docs/api/managed/interfaces/ToolChangeToolReferenceParam.md new file mode 100644 index 0000000..40ba4d6 --- /dev/null +++ b/docs/api/managed/interfaces/ToolChangeToolReferenceParam.md @@ -0,0 +1,25 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolChangeToolReferenceParam + +# Interface: ToolChangeToolReferenceParam + +Reference to a single tool the caller declared directly in `tools[]`. Does not +accept the composed `{server}_{name}` form the server assigns to MCP-resolved +tools — use `mcp_tool_reference` or `mcp_toolset_reference` for those. + +## Properties + +### name + +> **name**: `string` + +*** + +### type? + +> `optional` **type?**: `"tool_reference"` \| `null` + +This field can be elided, and will marshal its zero value as "tool_reference". diff --git a/docs/api/managed/interfaces/ToolReferenceBlockParam.md b/docs/api/managed/interfaces/ToolReferenceBlockParam.md new file mode 100644 index 0000000..6c76c47 --- /dev/null +++ b/docs/api/managed/interfaces/ToolReferenceBlockParam.md @@ -0,0 +1,31 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolReferenceBlockParam + +# Interface: ToolReferenceBlockParam + +Tool reference block that can be included in tool_result content. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### tool\_name + +> **tool\_name**: `string` + +*** + +### type? + +> `optional` **type?**: `"tool_reference"` \| `null` + +This field can be elided, and will marshal its zero value as "tool_reference". diff --git a/docs/api/managed/interfaces/ToolResultBlockParam.md b/docs/api/managed/interfaces/ToolResultBlockParam.md new file mode 100644 index 0000000..d77f649 --- /dev/null +++ b/docs/api/managed/interfaces/ToolResultBlockParam.md @@ -0,0 +1,51 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolResultBlockParam + +# Interface: ToolResultBlockParam + +The properties ToolUseID, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### content? + +> `optional` **content?**: [`ToolResultBlockParamContentUnion`](../type-aliases/ToolResultBlockParamContentUnion.md)[] \| `null` + +*** + +### is\_error? + +> `optional` **is\_error?**: `boolean` \| `null` + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### toolset\_name? + +> `optional` **toolset\_name?**: `string` \| `null` + +For a toolset member tool_result, the toolset family of the paired tool_use. + +*** + +### type? + +> `optional` **type?**: `"tool_result"` \| `null` + +This field can be elided, and will marshal its zero value as "tool_result". diff --git a/docs/api/managed/interfaces/ToolSearchToolResultBlockParam.md b/docs/api/managed/interfaces/ToolSearchToolResultBlockParam.md new file mode 100644 index 0000000..f6f377a --- /dev/null +++ b/docs/api/managed/interfaces/ToolSearchToolResultBlockParam.md @@ -0,0 +1,38 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolSearchToolResultBlockParam + +# Interface: ToolSearchToolResultBlockParam + +The properties Content, ToolUseID, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### content + +> **content**: [`ToolSearchToolResultBlockParamContentUnion`](../type-aliases/ToolSearchToolResultBlockParamContentUnion.md) + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"tool_search_tool_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"tool_search_tool_result". diff --git a/docs/api/managed/interfaces/ToolSearchToolResultErrorParam.md b/docs/api/managed/interfaces/ToolSearchToolResultErrorParam.md new file mode 100644 index 0000000..fd44814 --- /dev/null +++ b/docs/api/managed/interfaces/ToolSearchToolResultErrorParam.md @@ -0,0 +1,33 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolSearchToolResultErrorParam + +# Interface: ToolSearchToolResultErrorParam + +The properties ErrorCode, Type are required. + +## Properties + +### error\_code + +> **error\_code**: `string` + +Any of "invalid_tool_input", "unavailable", "too_many_requests", +"execution_time_exceeded". + +*** + +### error\_message? + +> `optional` **error\_message?**: `string` \| `null` + +*** + +### type? + +> `optional` **type?**: `"tool_search_tool_result_error"` \| `null` + +This field can be elided, and will marshal its zero value as +"tool_search_tool_result_error". diff --git a/docs/api/managed/interfaces/ToolSearchToolSearchResultBlockParam.md b/docs/api/managed/interfaces/ToolSearchToolSearchResultBlockParam.md new file mode 100644 index 0000000..b1dfaa4 --- /dev/null +++ b/docs/api/managed/interfaces/ToolSearchToolSearchResultBlockParam.md @@ -0,0 +1,24 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolSearchToolSearchResultBlockParam + +# Interface: ToolSearchToolSearchResultBlockParam + +The properties ToolReferences, Type are required. + +## Properties + +### tool\_references + +> **tool\_references**: [`ToolReferenceBlockParam`](ToolReferenceBlockParam.md)[] + +*** + +### type? + +> `optional` **type?**: `"tool_search_tool_search_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"tool_search_tool_search_result". diff --git a/docs/api/managed/interfaces/ToolUseBlockParam.md b/docs/api/managed/interfaces/ToolUseBlockParam.md new file mode 100644 index 0000000..4569b68 --- /dev/null +++ b/docs/api/managed/interfaces/ToolUseBlockParam.md @@ -0,0 +1,59 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolUseBlockParam + +# Interface: ToolUseBlockParam + +The properties ID, Input, Name, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### caller? + +> `optional` **caller?**: [`ToolUseBlockParamCallerUnion`](../type-aliases/ToolUseBlockParamCallerUnion.md) \| `null` + +Tool invocation directly from the model. + +*** + +### id + +> **id**: `string` + +*** + +### input + +> **input**: `unknown` + +*** + +### name + +> **name**: `string` + +*** + +### toolset\_name? + +> `optional` **toolset\_name?**: `string` \| `null` + +For a toolset member tool_use, the toolset family this member belongs to. + +*** + +### type? + +> `optional` **type?**: `"tool_use"` \| `null` + +This field can be elided, and will marshal its zero value as "tool_use". diff --git a/docs/api/managed/interfaces/URLImageSourceParam.md b/docs/api/managed/interfaces/URLImageSourceParam.md new file mode 100644 index 0000000..4193571 --- /dev/null +++ b/docs/api/managed/interfaces/URLImageSourceParam.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / URLImageSourceParam + +# Interface: URLImageSourceParam + +The properties Type, URL are required. + +## Properties + +### type? + +> `optional` **type?**: `"url"` \| `null` + +This field can be elided, and will marshal its zero value as "url". + +*** + +### url + +> **url**: `string` diff --git a/docs/api/managed/interfaces/URLPDFSourceParam.md b/docs/api/managed/interfaces/URLPDFSourceParam.md new file mode 100644 index 0000000..652cb88 --- /dev/null +++ b/docs/api/managed/interfaces/URLPDFSourceParam.md @@ -0,0 +1,23 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / URLPDFSourceParam + +# Interface: URLPDFSourceParam + +The properties Type, URL are required. + +## Properties + +### type? + +> `optional` **type?**: `"url"` \| `null` + +This field can be elided, and will marshal its zero value as "url". + +*** + +### url + +> **url**: `string` diff --git a/docs/api/managed/interfaces/UnrestrictedNetwork.md b/docs/api/managed/interfaces/UnrestrictedNetwork.md new file mode 100644 index 0000000..2c3ef22 --- /dev/null +++ b/docs/api/managed/interfaces/UnrestrictedNetwork.md @@ -0,0 +1,17 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / UnrestrictedNetwork + +# Interface: UnrestrictedNetwork + +Unrestricted network access. + +## Properties + +### type? + +> `optional` **type?**: `"unrestricted"` + +Network policy type diff --git a/docs/api/managed/interfaces/UnrestrictedNetworkParam.md b/docs/api/managed/interfaces/UnrestrictedNetworkParam.md new file mode 100644 index 0000000..bca7d9d --- /dev/null +++ b/docs/api/managed/interfaces/UnrestrictedNetworkParam.md @@ -0,0 +1,20 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / UnrestrictedNetworkParam + +# Interface: UnrestrictedNetworkParam + +Unrestricted network access. + +This struct has a constant value, construct it with +`NewUnrestrictedNetworkParam`. + +## Properties + +### type? + +> `optional` **type?**: `"unrestricted"` \| `null` + +Network policy type diff --git a/docs/api/managed/interfaces/VaultArchiveParams.md b/docs/api/managed/interfaces/VaultArchiveParams.md new file mode 100644 index 0000000..debdf23 --- /dev/null +++ b/docs/api/managed/interfaces/VaultArchiveParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultArchiveParams + +# Interface: VaultArchiveParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultCredentialArchiveParams.md b/docs/api/managed/interfaces/VaultCredentialArchiveParams.md new file mode 100644 index 0000000..03bae43 --- /dev/null +++ b/docs/api/managed/interfaces/VaultCredentialArchiveParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialArchiveParams + +# Interface: VaultCredentialArchiveParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### vault\_id + +> **vault\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultCredentialDeleteParams.md b/docs/api/managed/interfaces/VaultCredentialDeleteParams.md new file mode 100644 index 0000000..0354a5f --- /dev/null +++ b/docs/api/managed/interfaces/VaultCredentialDeleteParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialDeleteParams + +# Interface: VaultCredentialDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### vault\_id + +> **vault\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultCredentialGetParams.md b/docs/api/managed/interfaces/VaultCredentialGetParams.md new file mode 100644 index 0000000..aca5e48 --- /dev/null +++ b/docs/api/managed/interfaces/VaultCredentialGetParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialGetParams + +# Interface: VaultCredentialGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### vault\_id + +> **vault\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultCredentialListParams.md b/docs/api/managed/interfaces/VaultCredentialListParams.md new file mode 100644 index 0000000..636b795 --- /dev/null +++ b/docs/api/managed/interfaces/VaultCredentialListParams.md @@ -0,0 +1,63 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialListParams + +# Interface: VaultCredentialListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` + +Whether to include archived credentials in the results. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum number of credentials to return per page. Defaults to 20, maximum 100. + +*** + +### name? + +> `optional` **name?**: `string` + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination token from a previous `list_credentials` response. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultCredentialMCPOAuthValidateParams.md b/docs/api/managed/interfaces/VaultCredentialMCPOAuthValidateParams.md new file mode 100644 index 0000000..0251637 --- /dev/null +++ b/docs/api/managed/interfaces/VaultCredentialMCPOAuthValidateParams.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialMCPOAuthValidateParams + +# Interface: VaultCredentialMCPOAuthValidateParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### vault\_id + +> **vault\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultCredentialNewParams.md b/docs/api/managed/interfaces/VaultCredentialNewParams.md new file mode 100644 index 0000000..53d7ac9 --- /dev/null +++ b/docs/api/managed/interfaces/VaultCredentialNewParams.md @@ -0,0 +1,46 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialNewParams + +# Interface: VaultCredentialNewParams + +## Properties + +### auth + +> **auth**: [`VaultCredentialNewParamsAuthUnion`](../type-aliases/VaultCredentialNewParamsAuthUnion.md) + +Authentication details for creating a credential. + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### display\_name? + +> `optional` **display\_name?**: `string` \| `null` + +Human-readable name for the credential. Up to 255 characters. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +Arbitrary key-value metadata to attach to the credential. Maximum 16 pairs, keys +up to 64 chars, values up to 512 chars. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultCredentialUpdateParams.md b/docs/api/managed/interfaces/VaultCredentialUpdateParams.md new file mode 100644 index 0000000..f707a2e --- /dev/null +++ b/docs/api/managed/interfaces/VaultCredentialUpdateParams.md @@ -0,0 +1,52 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialUpdateParams + +# Interface: VaultCredentialUpdateParams + +## Properties + +### auth? + +> `optional` **auth?**: [`VaultCredentialUpdateParamsAuthUnion`](../type-aliases/VaultCredentialUpdateParamsAuthUnion.md) \| `null` + +Updated authentication details for a credential. + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### display\_name? + +> `optional` **display\_name?**: `string` \| `null` + +Updated human-readable name for the credential. 1-255 characters. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `unknown`\> \| `null` + +Metadata patch. Set a key to a string to upsert it, or to null to delete it. +Omitted keys are preserved. + +*** + +### vault\_id + +> **vault\_id**: `string` + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultDeleteParams.md b/docs/api/managed/interfaces/VaultDeleteParams.md new file mode 100644 index 0000000..43d24ba --- /dev/null +++ b/docs/api/managed/interfaces/VaultDeleteParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultDeleteParams + +# Interface: VaultDeleteParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultGetParams.md b/docs/api/managed/interfaces/VaultGetParams.md new file mode 100644 index 0000000..f357720 --- /dev/null +++ b/docs/api/managed/interfaces/VaultGetParams.md @@ -0,0 +1,21 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultGetParams + +# Interface: VaultGetParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultListParams.md b/docs/api/managed/interfaces/VaultListParams.md new file mode 100644 index 0000000..f10453c --- /dev/null +++ b/docs/api/managed/interfaces/VaultListParams.md @@ -0,0 +1,63 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultListParams + +# Interface: VaultListParams + +## Properties + +### after\_id? + +> `optional` **after\_id?**: `string` + +*** + +### before\_id? + +> `optional` **before\_id?**: `string` + +*** + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### include\_archived? + +> `optional` **include\_archived?**: `boolean` + +Whether to include archived vaults in the results. + +*** + +### limit? + +> `optional` **limit?**: `number` + +Maximum number of vaults to return per page. Defaults to 20, maximum 100. + +*** + +### name? + +> `optional` **name?**: `string` + +*** + +### page? + +> `optional` **page?**: `string` + +Opaque pagination token from a previous `list_vaults` response. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/VaultNewParams.md b/docs/api/managed/interfaces/VaultNewParams.md new file mode 100644 index 0000000..185663d --- /dev/null +++ b/docs/api/managed/interfaces/VaultNewParams.md @@ -0,0 +1,38 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultNewParams + +# Interface: VaultNewParams + +## Properties + +### betas? + +> `optional` **betas?**: `string`[] + +Optional header to specify the beta version(s) you want to use. + +*** + +### display\_name + +> **display\_name**: `string` + +Human-readable name for the vault. 1-255 characters. + +*** + +### metadata? + +> `optional` **metadata?**: `Record`\<`string`, `string`\> \| `null` + +Arbitrary key-value metadata to attach to the vault. Maximum 16 pairs, keys up +to 64 chars, values up to 512 chars. + +*** + +### workspace\_id? + +> `optional` **workspace\_id?**: `string` diff --git a/docs/api/managed/interfaces/WebFetchBlockParam.md b/docs/api/managed/interfaces/WebFetchBlockParam.md new file mode 100644 index 0000000..5772833 --- /dev/null +++ b/docs/api/managed/interfaces/WebFetchBlockParam.md @@ -0,0 +1,39 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebFetchBlockParam + +# Interface: WebFetchBlockParam + +The properties Content, Type, URL are required. + +## Properties + +### content + +> **content**: [`RequestDocumentBlockParam`](RequestDocumentBlockParam.md) + +*** + +### retrieved\_at? + +> `optional` **retrieved\_at?**: `string` \| `null` + +ISO 8601 timestamp when the content was retrieved + +*** + +### type? + +> `optional` **type?**: `"web_fetch_result"` \| `null` + +This field can be elided, and will marshal its zero value as "web_fetch_result". + +*** + +### url + +> **url**: `string` + +Fetched content URL diff --git a/docs/api/managed/interfaces/WebFetchToolResultBlockParam.md b/docs/api/managed/interfaces/WebFetchToolResultBlockParam.md new file mode 100644 index 0000000..dacea98 --- /dev/null +++ b/docs/api/managed/interfaces/WebFetchToolResultBlockParam.md @@ -0,0 +1,46 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebFetchToolResultBlockParam + +# Interface: WebFetchToolResultBlockParam + +The properties Content, ToolUseID, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### caller? + +> `optional` **caller?**: [`WebFetchToolResultBlockParamCallerUnion`](../type-aliases/WebFetchToolResultBlockParamCallerUnion.md) \| `null` + +Tool invocation directly from the model. + +*** + +### content + +> **content**: [`WebFetchToolResultBlockParamContentUnion`](../type-aliases/WebFetchToolResultBlockParamContentUnion.md) + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"web_fetch_tool_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"web_fetch_tool_result". diff --git a/docs/api/managed/interfaces/WebFetchToolResultErrorBlockParam.md b/docs/api/managed/interfaces/WebFetchToolResultErrorBlockParam.md new file mode 100644 index 0000000..c590663 --- /dev/null +++ b/docs/api/managed/interfaces/WebFetchToolResultErrorBlockParam.md @@ -0,0 +1,28 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebFetchToolResultErrorBlockParam + +# Interface: WebFetchToolResultErrorBlockParam + +The properties ErrorCode, Type are required. + +## Properties + +### error\_code + +> **error\_code**: `string` + +Any of "invalid_tool_input", "url_too_long", "url_not_allowed", +"url_not_in_prior_context", "url_not_accessible", "unsupported_content_type", +"too_many_requests", "max_uses_exceeded", "unavailable". + +*** + +### type? + +> `optional` **type?**: `"web_fetch_tool_result_error"` \| `null` + +This field can be elided, and will marshal its zero value as +"web_fetch_tool_result_error". diff --git a/docs/api/managed/interfaces/WebSearchResultBlockParam.md b/docs/api/managed/interfaces/WebSearchResultBlockParam.md new file mode 100644 index 0000000..ba33731 --- /dev/null +++ b/docs/api/managed/interfaces/WebSearchResultBlockParam.md @@ -0,0 +1,42 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebSearchResultBlockParam + +# Interface: WebSearchResultBlockParam + +The properties EncryptedContent, Title, Type, URL are required. + +## Properties + +### encrypted\_content + +> **encrypted\_content**: `string` + +*** + +### page\_age? + +> `optional` **page\_age?**: `string` \| `null` + +*** + +### title + +> **title**: `string` + +*** + +### type? + +> `optional` **type?**: `"web_search_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"web_search_result". + +*** + +### url + +> **url**: `string` diff --git a/docs/api/managed/interfaces/WebSearchToolRequestErrorParam.md b/docs/api/managed/interfaces/WebSearchToolRequestErrorParam.md new file mode 100644 index 0000000..65e3972 --- /dev/null +++ b/docs/api/managed/interfaces/WebSearchToolRequestErrorParam.md @@ -0,0 +1,27 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebSearchToolRequestErrorParam + +# Interface: WebSearchToolRequestErrorParam + +The properties ErrorCode, Type are required. + +## Properties + +### error\_code + +> **error\_code**: `string` + +Any of "invalid_tool_input", "unavailable", "max_uses_exceeded", +"too_many_requests", "query_too_long", "request_too_large". + +*** + +### type? + +> `optional` **type?**: `"web_search_tool_result_error"` \| `null` + +This field can be elided, and will marshal its zero value as +"web_search_tool_result_error". diff --git a/docs/api/managed/interfaces/WebSearchToolResultBlockParam.md b/docs/api/managed/interfaces/WebSearchToolResultBlockParam.md new file mode 100644 index 0000000..4ffb94b --- /dev/null +++ b/docs/api/managed/interfaces/WebSearchToolResultBlockParam.md @@ -0,0 +1,46 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebSearchToolResultBlockParam + +# Interface: WebSearchToolResultBlockParam + +The properties Content, ToolUseID, Type are required. + +## Properties + +### cache\_control? + +> `optional` **cache\_control?**: [`CacheControlEphemeralParam`](CacheControlEphemeralParam.md) \| `null` + +Create a cache control breakpoint at this content block. + +*** + +### caller? + +> `optional` **caller?**: [`WebSearchToolResultBlockParamCallerUnion`](../type-aliases/WebSearchToolResultBlockParamCallerUnion.md) \| `null` + +Tool invocation directly from the model. + +*** + +### content + +> **content**: [`WebSearchToolResultBlockParamContentUnion`](../type-aliases/WebSearchToolResultBlockParamContentUnion.md) + +*** + +### tool\_use\_id + +> **tool\_use\_id**: `string` + +*** + +### type? + +> `optional` **type?**: `"web_search_tool_result"` \| `null` + +This field can be elided, and will marshal its zero value as +"web_search_tool_result". diff --git a/docs/api/managed/type-aliases/AdvisorToolResultBlockParamContentUnion.md b/docs/api/managed/type-aliases/AdvisorToolResultBlockParamContentUnion.md new file mode 100644 index 0000000..9d99684 --- /dev/null +++ b/docs/api/managed/type-aliases/AdvisorToolResultBlockParamContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AdvisorToolResultBlockParamContentUnion + +# Type Alias: AdvisorToolResultBlockParamContentUnion + +> **AdvisorToolResultBlockParamContentUnion** = [`AdvisorToolResultErrorParam`](../interfaces/AdvisorToolResultErrorParam.md) \| [`AdvisorResultBlockParam`](../interfaces/AdvisorResultBlockParam.md) \| [`AdvisorRedactedResultBlockParam`](../interfaces/AdvisorRedactedResultBlockParam.md) diff --git a/docs/api/managed/type-aliases/AdvisorToolResultErrorParamErrorCode.md b/docs/api/managed/type-aliases/AdvisorToolResultErrorParamErrorCode.md new file mode 100644 index 0000000..6729d11 --- /dev/null +++ b/docs/api/managed/type-aliases/AdvisorToolResultErrorParamErrorCode.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AdvisorToolResultErrorParamErrorCode + +# Type Alias: AdvisorToolResultErrorParamErrorCode + +> **AdvisorToolResultErrorParamErrorCode** = `string` diff --git a/docs/api/managed/type-aliases/AgentCreateParams.md b/docs/api/managed/type-aliases/AgentCreateParams.md new file mode 100644 index 0000000..24ca7c3 --- /dev/null +++ b/docs/api/managed/type-aliases/AgentCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentCreateParams + +# Type Alias: AgentCreateParams + +> **AgentCreateParams** = [`AgentNewParams`](../interfaces/AgentNewParams.md) diff --git a/docs/api/managed/type-aliases/AgentNewParamsToolUnion.md b/docs/api/managed/type-aliases/AgentNewParamsToolUnion.md new file mode 100644 index 0000000..e2d611a --- /dev/null +++ b/docs/api/managed/type-aliases/AgentNewParamsToolUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentNewParamsToolUnion + +# Type Alias: AgentNewParamsToolUnion + +> **AgentNewParamsToolUnion** = [`ManagedAgentsAgentToolset20260401Params`](../interfaces/ManagedAgentsAgentToolset20260401Params.md) \| [`ManagedAgentsMCPToolsetParams`](../interfaces/ManagedAgentsMCPToolsetParams.md) \| [`ManagedAgentsCustomToolParams`](../interfaces/ManagedAgentsCustomToolParams.md) diff --git a/docs/api/managed/type-aliases/AgentRetrieveParams.md b/docs/api/managed/type-aliases/AgentRetrieveParams.md new file mode 100644 index 0000000..b877715 --- /dev/null +++ b/docs/api/managed/type-aliases/AgentRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentRetrieveParams + +# Type Alias: AgentRetrieveParams + +> **AgentRetrieveParams** = [`AgentGetParams`](../interfaces/AgentGetParams.md) diff --git a/docs/api/managed/type-aliases/AgentUpdateParamsToolUnion.md b/docs/api/managed/type-aliases/AgentUpdateParamsToolUnion.md new file mode 100644 index 0000000..519076f --- /dev/null +++ b/docs/api/managed/type-aliases/AgentUpdateParamsToolUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / AgentUpdateParamsToolUnion + +# Type Alias: AgentUpdateParamsToolUnion + +> **AgentUpdateParamsToolUnion** = [`ManagedAgentsAgentToolset20260401Params`](../interfaces/ManagedAgentsAgentToolset20260401Params.md) \| [`ManagedAgentsMCPToolsetParams`](../interfaces/ManagedAgentsMCPToolsetParams.md) \| [`ManagedAgentsCustomToolParams`](../interfaces/ManagedAgentsCustomToolParams.md) diff --git a/docs/api/managed/type-aliases/Base64ImageSourceMediaType.md b/docs/api/managed/type-aliases/Base64ImageSourceMediaType.md new file mode 100644 index 0000000..c249a47 --- /dev/null +++ b/docs/api/managed/type-aliases/Base64ImageSourceMediaType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Base64ImageSourceMediaType + +# Type Alias: Base64ImageSourceMediaType + +> **Base64ImageSourceMediaType** = `string` diff --git a/docs/api/managed/type-aliases/BashCodeExecutionToolResultBlockParamContentUnion.md b/docs/api/managed/type-aliases/BashCodeExecutionToolResultBlockParamContentUnion.md new file mode 100644 index 0000000..23248eb --- /dev/null +++ b/docs/api/managed/type-aliases/BashCodeExecutionToolResultBlockParamContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BashCodeExecutionToolResultBlockParamContentUnion + +# Type Alias: BashCodeExecutionToolResultBlockParamContentUnion + +> **BashCodeExecutionToolResultBlockParamContentUnion** = [`BashCodeExecutionToolResultErrorParam`](../interfaces/BashCodeExecutionToolResultErrorParam.md) \| [`BashCodeExecutionResultBlockParam`](../interfaces/BashCodeExecutionResultBlockParam.md) diff --git a/docs/api/managed/type-aliases/BashCodeExecutionToolResultErrorParamErrorCode.md b/docs/api/managed/type-aliases/BashCodeExecutionToolResultErrorParamErrorCode.md new file mode 100644 index 0000000..e1d7c44 --- /dev/null +++ b/docs/api/managed/type-aliases/BashCodeExecutionToolResultErrorParamErrorCode.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BashCodeExecutionToolResultErrorParamErrorCode + +# Type Alias: BashCodeExecutionToolResultErrorParamErrorCode + +> **BashCodeExecutionToolResultErrorParamErrorCode** = `string` diff --git a/docs/api/managed/type-aliases/BrowserStateChangeUnionParam.md b/docs/api/managed/type-aliases/BrowserStateChangeUnionParam.md new file mode 100644 index 0000000..732094a --- /dev/null +++ b/docs/api/managed/type-aliases/BrowserStateChangeUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / BrowserStateChangeUnionParam + +# Type Alias: BrowserStateChangeUnionParam + +> **BrowserStateChangeUnionParam** = [`BrowserStateChangeTabOpenedParam`](../interfaces/BrowserStateChangeTabOpenedParam.md) \| [`BrowserStateChangeDownloadStartedParam`](../interfaces/BrowserStateChangeDownloadStartedParam.md) \| [`BrowserStateChangeDownloadCompletedParam`](../interfaces/BrowserStateChangeDownloadCompletedParam.md) \| [`BrowserStateChangeDownloadFailedParam`](../interfaces/BrowserStateChangeDownloadFailedParam.md) diff --git a/docs/api/managed/type-aliases/CacheControlEphemeralTTL.md b/docs/api/managed/type-aliases/CacheControlEphemeralTTL.md new file mode 100644 index 0000000..b9f388a --- /dev/null +++ b/docs/api/managed/type-aliases/CacheControlEphemeralTTL.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CacheControlEphemeralTTL + +# Type Alias: CacheControlEphemeralTTL + +> **CacheControlEphemeralTTL** = `string` + +The time-to-live for the cache control breakpoint. + +This may be one the following values: + +- `5m`: 5 minutes +- `1h`: 1 hour + +Defaults to `5m`. diff --git a/docs/api/managed/type-aliases/CloudConfigNetworkingUnion.md b/docs/api/managed/type-aliases/CloudConfigNetworkingUnion.md new file mode 100644 index 0000000..e9c16cf --- /dev/null +++ b/docs/api/managed/type-aliases/CloudConfigNetworkingUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CloudConfigNetworkingUnion + +# Type Alias: CloudConfigNetworkingUnion + +> **CloudConfigNetworkingUnion** = [`UnrestrictedNetwork`](../interfaces/UnrestrictedNetwork.md) \| [`LimitedNetwork`](../interfaces/LimitedNetwork.md) diff --git a/docs/api/managed/type-aliases/CloudConfigParamsNetworkingUnion.md b/docs/api/managed/type-aliases/CloudConfigParamsNetworkingUnion.md new file mode 100644 index 0000000..1268fb3 --- /dev/null +++ b/docs/api/managed/type-aliases/CloudConfigParamsNetworkingUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CloudConfigParamsNetworkingUnion + +# Type Alias: CloudConfigParamsNetworkingUnion + +> **CloudConfigParamsNetworkingUnion** = [`UnrestrictedNetworkParam`](../interfaces/UnrestrictedNetworkParam.md) \| [`LimitedNetworkParams`](../interfaces/LimitedNetworkParams.md) diff --git a/docs/api/managed/type-aliases/CodeExecutionToolResultBlockParamContentUnion.md b/docs/api/managed/type-aliases/CodeExecutionToolResultBlockParamContentUnion.md new file mode 100644 index 0000000..e2ad642 --- /dev/null +++ b/docs/api/managed/type-aliases/CodeExecutionToolResultBlockParamContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CodeExecutionToolResultBlockParamContentUnion + +# Type Alias: CodeExecutionToolResultBlockParamContentUnion + +> **CodeExecutionToolResultBlockParamContentUnion** = [`CodeExecutionToolResultErrorParam`](../interfaces/CodeExecutionToolResultErrorParam.md) \| [`CodeExecutionResultBlockParam`](../interfaces/CodeExecutionResultBlockParam.md) \| [`EncryptedCodeExecutionResultBlockParam`](../interfaces/EncryptedCodeExecutionResultBlockParam.md) diff --git a/docs/api/managed/type-aliases/CodeExecutionToolResultErrorCode.md b/docs/api/managed/type-aliases/CodeExecutionToolResultErrorCode.md new file mode 100644 index 0000000..7308bf5 --- /dev/null +++ b/docs/api/managed/type-aliases/CodeExecutionToolResultErrorCode.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / CodeExecutionToolResultErrorCode + +# Type Alias: CodeExecutionToolResultErrorCode + +> **CodeExecutionToolResultErrorCode** = `string` diff --git a/docs/api/managed/type-aliases/ContentBlockParamUnion.md b/docs/api/managed/type-aliases/ContentBlockParamUnion.md new file mode 100644 index 0000000..923b66b --- /dev/null +++ b/docs/api/managed/type-aliases/ContentBlockParamUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ContentBlockParamUnion + +# Type Alias: ContentBlockParamUnion + +> **ContentBlockParamUnion** = [`TextBlockParam`](../interfaces/TextBlockParam.md) \| [`ImageBlockParam`](../interfaces/ImageBlockParam.md) \| [`RequestDocumentBlockParam`](../interfaces/RequestDocumentBlockParam.md) \| [`SearchResultBlockParam`](../interfaces/SearchResultBlockParam.md) \| [`ThinkingBlockParam`](../interfaces/ThinkingBlockParam.md) \| [`RedactedThinkingBlockParam`](../interfaces/RedactedThinkingBlockParam.md) \| [`ToolUseBlockParam`](../interfaces/ToolUseBlockParam.md) \| [`ToolResultBlockParam`](../interfaces/ToolResultBlockParam.md) \| [`ServerToolUseBlockParam`](../interfaces/ServerToolUseBlockParam.md) \| [`WebSearchToolResultBlockParam`](../interfaces/WebSearchToolResultBlockParam.md) \| [`WebFetchToolResultBlockParam`](../interfaces/WebFetchToolResultBlockParam.md) \| [`AdvisorToolResultBlockParam`](../interfaces/AdvisorToolResultBlockParam.md) \| [`CodeExecutionToolResultBlockParam`](../interfaces/CodeExecutionToolResultBlockParam.md) \| [`BashCodeExecutionToolResultBlockParam`](../interfaces/BashCodeExecutionToolResultBlockParam.md) \| [`TextEditorCodeExecutionToolResultBlockParam`](../interfaces/TextEditorCodeExecutionToolResultBlockParam.md) \| [`ToolSearchToolResultBlockParam`](../interfaces/ToolSearchToolResultBlockParam.md) \| [`MCPToolUseBlockParam`](../interfaces/MCPToolUseBlockParam.md) \| [`RequestMCPToolResultBlockParam`](../interfaces/RequestMCPToolResultBlockParam.md) \| [`ContainerUploadBlockParam`](../interfaces/ContainerUploadBlockParam.md) \| [`CompactionBlockParam`](../interfaces/CompactionBlockParam.md) \| [`RequestToolAdditionBlockParam`](../interfaces/RequestToolAdditionBlockParam.md) \| [`RequestToolRemovalBlockParam`](../interfaces/RequestToolRemovalBlockParam.md) \| [`FallbackBlockParam`](../interfaces/FallbackBlockParam.md) diff --git a/docs/api/managed/type-aliases/ContentBlockSourceContentUnionParam.md b/docs/api/managed/type-aliases/ContentBlockSourceContentUnionParam.md new file mode 100644 index 0000000..871a89c --- /dev/null +++ b/docs/api/managed/type-aliases/ContentBlockSourceContentUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ContentBlockSourceContentUnionParam + +# Type Alias: ContentBlockSourceContentUnionParam + +> **ContentBlockSourceContentUnionParam** = `string` \| `ContentBlockSourceContentUnionParam`[] diff --git a/docs/api/managed/type-aliases/Currency.md b/docs/api/managed/type-aliases/Currency.md new file mode 100644 index 0000000..e393c0e --- /dev/null +++ b/docs/api/managed/type-aliases/Currency.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Currency + +# Type Alias: Currency + +> **Currency** = `"USD"` diff --git a/docs/api/managed/type-aliases/DeletedFileType.md b/docs/api/managed/type-aliases/DeletedFileType.md new file mode 100644 index 0000000..6b77c01 --- /dev/null +++ b/docs/api/managed/type-aliases/DeletedFileType.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeletedFileType + +# Type Alias: DeletedFileType + +> **DeletedFileType** = `"file_deleted"` + +Deleted object type. + +For file deletion, this is always `"file_deleted"`. diff --git a/docs/api/managed/type-aliases/DeploymentCreateParams.md b/docs/api/managed/type-aliases/DeploymentCreateParams.md new file mode 100644 index 0000000..c19a2fe --- /dev/null +++ b/docs/api/managed/type-aliases/DeploymentCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentCreateParams + +# Type Alias: DeploymentCreateParams + +> **DeploymentCreateParams** = [`DeploymentNewParams`](../interfaces/DeploymentNewParams.md) diff --git a/docs/api/managed/type-aliases/DeploymentNewParamsAgentUnion.md b/docs/api/managed/type-aliases/DeploymentNewParamsAgentUnion.md new file mode 100644 index 0000000..6b48c8c --- /dev/null +++ b/docs/api/managed/type-aliases/DeploymentNewParamsAgentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentNewParamsAgentUnion + +# Type Alias: DeploymentNewParamsAgentUnion + +> **DeploymentNewParamsAgentUnion** = `string` \| [`ManagedAgentsAgentParams`](../interfaces/ManagedAgentsAgentParams.md) diff --git a/docs/api/managed/type-aliases/DeploymentNewParamsResourceUnion.md b/docs/api/managed/type-aliases/DeploymentNewParamsResourceUnion.md new file mode 100644 index 0000000..19485d3 --- /dev/null +++ b/docs/api/managed/type-aliases/DeploymentNewParamsResourceUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentNewParamsResourceUnion + +# Type Alias: DeploymentNewParamsResourceUnion + +> **DeploymentNewParamsResourceUnion** = [`ManagedAgentsGitHubRepositoryResourceParams`](../interfaces/ManagedAgentsGitHubRepositoryResourceParams.md) \| [`ManagedAgentsFileResourceParams`](../interfaces/ManagedAgentsFileResourceParams.md) \| [`ManagedAgentsMemoryStoreResourceParam`](../interfaces/ManagedAgentsMemoryStoreResourceParam.md) diff --git a/docs/api/managed/type-aliases/DeploymentRetrieveParams.md b/docs/api/managed/type-aliases/DeploymentRetrieveParams.md new file mode 100644 index 0000000..6dd757b --- /dev/null +++ b/docs/api/managed/type-aliases/DeploymentRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentRetrieveParams + +# Type Alias: DeploymentRetrieveParams + +> **DeploymentRetrieveParams** = [`DeploymentGetParams`](../interfaces/DeploymentGetParams.md) diff --git a/docs/api/managed/type-aliases/DeploymentRunRetrieveParams.md b/docs/api/managed/type-aliases/DeploymentRunRetrieveParams.md new file mode 100644 index 0000000..1df8f8a --- /dev/null +++ b/docs/api/managed/type-aliases/DeploymentRunRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentRunRetrieveParams + +# Type Alias: DeploymentRunRetrieveParams + +> **DeploymentRunRetrieveParams** = [`DeploymentRunGetParams`](../interfaces/DeploymentRunGetParams.md) diff --git a/docs/api/managed/type-aliases/DeploymentUpdateParamsAgentUnion.md b/docs/api/managed/type-aliases/DeploymentUpdateParamsAgentUnion.md new file mode 100644 index 0000000..473208f --- /dev/null +++ b/docs/api/managed/type-aliases/DeploymentUpdateParamsAgentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentUpdateParamsAgentUnion + +# Type Alias: DeploymentUpdateParamsAgentUnion + +> **DeploymentUpdateParamsAgentUnion** = `string` \| [`ManagedAgentsAgentParams`](../interfaces/ManagedAgentsAgentParams.md) diff --git a/docs/api/managed/type-aliases/DeploymentUpdateParamsResourceUnion.md b/docs/api/managed/type-aliases/DeploymentUpdateParamsResourceUnion.md new file mode 100644 index 0000000..9e5b4f2 --- /dev/null +++ b/docs/api/managed/type-aliases/DeploymentUpdateParamsResourceUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DeploymentUpdateParamsResourceUnion + +# Type Alias: DeploymentUpdateParamsResourceUnion + +> **DeploymentUpdateParamsResourceUnion** = [`ManagedAgentsGitHubRepositoryResourceParams`](../interfaces/ManagedAgentsGitHubRepositoryResourceParams.md) \| [`ManagedAgentsFileResourceParams`](../interfaces/ManagedAgentsFileResourceParams.md) \| [`ManagedAgentsMemoryStoreResourceParam`](../interfaces/ManagedAgentsMemoryStoreResourceParam.md) diff --git a/docs/api/managed/type-aliases/DreamCreateParams.md b/docs/api/managed/type-aliases/DreamCreateParams.md new file mode 100644 index 0000000..babc79b --- /dev/null +++ b/docs/api/managed/type-aliases/DreamCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamCreateParams + +# Type Alias: DreamCreateParams + +> **DreamCreateParams** = [`DreamNewParams`](../interfaces/DreamNewParams.md) diff --git a/docs/api/managed/type-aliases/DreamInputUnion.md b/docs/api/managed/type-aliases/DreamInputUnion.md new file mode 100644 index 0000000..51e3a06 --- /dev/null +++ b/docs/api/managed/type-aliases/DreamInputUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamInputUnion + +# Type Alias: DreamInputUnion + +> **DreamInputUnion** = [`DreamMemoryStoreInput`](../interfaces/DreamMemoryStoreInput.md) \| [`DreamSessionsInput`](../interfaces/DreamSessionsInput.md) diff --git a/docs/api/managed/type-aliases/DreamInputUnionParam.md b/docs/api/managed/type-aliases/DreamInputUnionParam.md new file mode 100644 index 0000000..cd650fd --- /dev/null +++ b/docs/api/managed/type-aliases/DreamInputUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamInputUnionParam + +# Type Alias: DreamInputUnionParam + +> **DreamInputUnionParam** = [`DreamMemoryStoreInputParam`](../interfaces/DreamMemoryStoreInputParam.md) \| [`DreamSessionsInputParam`](../interfaces/DreamSessionsInputParam.md) diff --git a/docs/api/managed/type-aliases/DreamMemoryStoreInputType.md b/docs/api/managed/type-aliases/DreamMemoryStoreInputType.md new file mode 100644 index 0000000..c9b1ba2 --- /dev/null +++ b/docs/api/managed/type-aliases/DreamMemoryStoreInputType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamMemoryStoreInputType + +# Type Alias: DreamMemoryStoreInputType + +> **DreamMemoryStoreInputType** = `"memory_store"` diff --git a/docs/api/managed/type-aliases/DreamModelConfigParamSpeed.md b/docs/api/managed/type-aliases/DreamModelConfigParamSpeed.md new file mode 100644 index 0000000..2f2f4f7 --- /dev/null +++ b/docs/api/managed/type-aliases/DreamModelConfigParamSpeed.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamModelConfigParamSpeed + +# Type Alias: DreamModelConfigParamSpeed + +> **DreamModelConfigParamSpeed** = `"standard"` \| `"fast"` + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. diff --git a/docs/api/managed/type-aliases/DreamModelConfigSpeed.md b/docs/api/managed/type-aliases/DreamModelConfigSpeed.md new file mode 100644 index 0000000..bcb21ae --- /dev/null +++ b/docs/api/managed/type-aliases/DreamModelConfigSpeed.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamModelConfigSpeed + +# Type Alias: DreamModelConfigSpeed + +> **DreamModelConfigSpeed** = `"standard"` \| `"fast"` + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. diff --git a/docs/api/managed/type-aliases/DreamNewParamsModelUnion.md b/docs/api/managed/type-aliases/DreamNewParamsModelUnion.md new file mode 100644 index 0000000..e6c07d9 --- /dev/null +++ b/docs/api/managed/type-aliases/DreamNewParamsModelUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamNewParamsModelUnion + +# Type Alias: DreamNewParamsModelUnion + +> **DreamNewParamsModelUnion** = `string` \| [`DreamModelConfigParam`](../interfaces/DreamModelConfigParam.md) diff --git a/docs/api/managed/type-aliases/DreamOutputType.md b/docs/api/managed/type-aliases/DreamOutputType.md new file mode 100644 index 0000000..6531a39 --- /dev/null +++ b/docs/api/managed/type-aliases/DreamOutputType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamOutputType + +# Type Alias: DreamOutputType + +> **DreamOutputType** = `"memory_store"` diff --git a/docs/api/managed/type-aliases/DreamRetrieveParams.md b/docs/api/managed/type-aliases/DreamRetrieveParams.md new file mode 100644 index 0000000..03c266c --- /dev/null +++ b/docs/api/managed/type-aliases/DreamRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamRetrieveParams + +# Type Alias: DreamRetrieveParams + +> **DreamRetrieveParams** = [`DreamGetParams`](../interfaces/DreamGetParams.md) diff --git a/docs/api/managed/type-aliases/DreamSessionsInputType.md b/docs/api/managed/type-aliases/DreamSessionsInputType.md new file mode 100644 index 0000000..48c4a46 --- /dev/null +++ b/docs/api/managed/type-aliases/DreamSessionsInputType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamSessionsInputType + +# Type Alias: DreamSessionsInputType + +> **DreamSessionsInputType** = `"sessions"` diff --git a/docs/api/managed/type-aliases/DreamStatus.md b/docs/api/managed/type-aliases/DreamStatus.md new file mode 100644 index 0000000..d6de47d --- /dev/null +++ b/docs/api/managed/type-aliases/DreamStatus.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamStatus + +# Type Alias: DreamStatus + +> **DreamStatus** = `"pending"` \| `"running"` \| `"completed"` \| `"failed"` \| `"canceled"` + +Lifecycle status of a Dream. diff --git a/docs/api/managed/type-aliases/DreamType.md b/docs/api/managed/type-aliases/DreamType.md new file mode 100644 index 0000000..5f35500 --- /dev/null +++ b/docs/api/managed/type-aliases/DreamType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / DreamType + +# Type Alias: DreamType + +> **DreamType** = `"dream"` diff --git a/docs/api/managed/type-aliases/EnvironmentConfigUnion.md b/docs/api/managed/type-aliases/EnvironmentConfigUnion.md new file mode 100644 index 0000000..fd91caa --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentConfigUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentConfigUnion + +# Type Alias: EnvironmentConfigUnion + +> **EnvironmentConfigUnion** = [`CloudConfig`](../interfaces/CloudConfig.md) \| [`SelfHostedConfig`](../interfaces/SelfHostedConfig.md) diff --git a/docs/api/managed/type-aliases/EnvironmentCreateParams.md b/docs/api/managed/type-aliases/EnvironmentCreateParams.md new file mode 100644 index 0000000..dc291ef --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentCreateParams + +# Type Alias: EnvironmentCreateParams + +> **EnvironmentCreateParams** = [`EnvironmentNewParams`](../interfaces/EnvironmentNewParams.md) diff --git a/docs/api/managed/type-aliases/EnvironmentDeleteResponseType.md b/docs/api/managed/type-aliases/EnvironmentDeleteResponseType.md new file mode 100644 index 0000000..aa22b7f --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentDeleteResponseType.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentDeleteResponseType + +# Type Alias: EnvironmentDeleteResponseType + +> **EnvironmentDeleteResponseType** = `"environment_deleted"` + +The type of response diff --git a/docs/api/managed/type-aliases/EnvironmentNewParamsConfigUnion.md b/docs/api/managed/type-aliases/EnvironmentNewParamsConfigUnion.md new file mode 100644 index 0000000..79bb4e6 --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentNewParamsConfigUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentNewParamsConfigUnion + +# Type Alias: EnvironmentNewParamsConfigUnion + +> **EnvironmentNewParamsConfigUnion** = [`CloudConfigParams`](../interfaces/CloudConfigParams.md) \| [`SelfHostedConfigParams`](../interfaces/SelfHostedConfigParams.md) diff --git a/docs/api/managed/type-aliases/EnvironmentNewParamsScope.md b/docs/api/managed/type-aliases/EnvironmentNewParamsScope.md new file mode 100644 index 0000000..1a6d457 --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentNewParamsScope.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentNewParamsScope + +# Type Alias: EnvironmentNewParamsScope + +> **EnvironmentNewParamsScope** = `"organization"` \| `"account"` + +The visibility scope for this environment. 'organization' makes the environment +visible to all accounts. 'account' restricts visibility to the owning account +only. Only applicable for self-hosted environments. If not specified, defaults +based on organization type. diff --git a/docs/api/managed/type-aliases/EnvironmentRetrieveParams.md b/docs/api/managed/type-aliases/EnvironmentRetrieveParams.md new file mode 100644 index 0000000..65f0562 --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentRetrieveParams + +# Type Alias: EnvironmentRetrieveParams + +> **EnvironmentRetrieveParams** = [`EnvironmentGetParams`](../interfaces/EnvironmentGetParams.md) diff --git a/docs/api/managed/type-aliases/EnvironmentScope.md b/docs/api/managed/type-aliases/EnvironmentScope.md new file mode 100644 index 0000000..9781e0c --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentScope.md @@ -0,0 +1,12 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentScope + +# Type Alias: EnvironmentScope + +> **EnvironmentScope** = `"organization"` \| `"account"` + +The visibility scope for this environment. 'organization' means visible to all +accounts. 'account' means visible only to the owning account. diff --git a/docs/api/managed/type-aliases/EnvironmentUpdateParamsConfigUnion.md b/docs/api/managed/type-aliases/EnvironmentUpdateParamsConfigUnion.md new file mode 100644 index 0000000..e444db1 --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentUpdateParamsConfigUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentUpdateParamsConfigUnion + +# Type Alias: EnvironmentUpdateParamsConfigUnion + +> **EnvironmentUpdateParamsConfigUnion** = [`CloudConfigParams`](../interfaces/CloudConfigParams.md) \| [`SelfHostedConfigParams`](../interfaces/SelfHostedConfigParams.md) diff --git a/docs/api/managed/type-aliases/EnvironmentUpdateParamsScope.md b/docs/api/managed/type-aliases/EnvironmentUpdateParamsScope.md new file mode 100644 index 0000000..429c77a --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentUpdateParamsScope.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentUpdateParamsScope + +# Type Alias: EnvironmentUpdateParamsScope + +> **EnvironmentUpdateParamsScope** = `"organization"` \| `"account"` + +The visibility scope for this environment. 'organization' makes the environment +visible to all accounts. 'account' restricts visibility to the owning account +only. diff --git a/docs/api/managed/type-aliases/EnvironmentWorkRetrieveParams.md b/docs/api/managed/type-aliases/EnvironmentWorkRetrieveParams.md new file mode 100644 index 0000000..96a6352 --- /dev/null +++ b/docs/api/managed/type-aliases/EnvironmentWorkRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / EnvironmentWorkRetrieveParams + +# Type Alias: EnvironmentWorkRetrieveParams + +> **EnvironmentWorkRetrieveParams** = [`EnvironmentWorkGetParams`](../interfaces/EnvironmentWorkGetParams.md) diff --git a/docs/api/managed/type-aliases/HealthCheckWorkDataType.md b/docs/api/managed/type-aliases/HealthCheckWorkDataType.md new file mode 100644 index 0000000..804298c --- /dev/null +++ b/docs/api/managed/type-aliases/HealthCheckWorkDataType.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / HealthCheckWorkDataType + +# Type Alias: HealthCheckWorkDataType + +> **HealthCheckWorkDataType** = `"healthcheck"` + +Type of work data diff --git a/docs/api/managed/type-aliases/ImageBlockParamSourceUnion.md b/docs/api/managed/type-aliases/ImageBlockParamSourceUnion.md new file mode 100644 index 0000000..9221210 --- /dev/null +++ b/docs/api/managed/type-aliases/ImageBlockParamSourceUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ImageBlockParamSourceUnion + +# Type Alias: ImageBlockParamSourceUnion + +> **ImageBlockParamSourceUnion** = [`Base64ImageSourceParam`](../interfaces/Base64ImageSourceParam.md) \| [`URLImageSourceParam`](../interfaces/URLImageSourceParam.md) \| [`FileImageSourceParam`](../interfaces/FileImageSourceParam.md) diff --git a/docs/api/managed/type-aliases/ImageTransformationsParamOversizedImage.md b/docs/api/managed/type-aliases/ImageTransformationsParamOversizedImage.md new file mode 100644 index 0000000..22e8511 --- /dev/null +++ b/docs/api/managed/type-aliases/ImageTransformationsParamOversizedImage.md @@ -0,0 +1,16 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ImageTransformationsParamOversizedImage + +# Type Alias: ImageTransformationsParamOversizedImage + +> **ImageTransformationsParamOversizedImage** = `string` + +What the server does when this image exceeds the model's maximum image size. +`"downsize"` (the default) scales the image down to fit, which changes the +dimensions the model observes without telling you. `"error"` instead rejects the +request with a 400 error naming the image's dimensions and the largest +dimensions that fit, so you can scale the image deliberately — your image is +never silently scaled down. diff --git a/docs/api/managed/type-aliases/ManagedAgentsAPIActorType.md b/docs/api/managed/type-aliases/ManagedAgentsAPIActorType.md new file mode 100644 index 0000000..9748aa3 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAPIActorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAPIActorType + +# Type Alias: ManagedAgentsAPIActorType + +> **ManagedAgentsAPIActorType** = `"api_actor"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsActorUnion.md b/docs/api/managed/type-aliases/ManagedAgentsActorUnion.md new file mode 100644 index 0000000..dc3f31a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsActorUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsActorUnion + +# Type Alias: ManagedAgentsActorUnion + +> **ManagedAgentsActorUnion** = [`ManagedAgentsSessionActor`](../interfaces/ManagedAgentsSessionActor.md) \| [`ManagedAgentsAPIActor`](../interfaces/ManagedAgentsAPIActor.md) \| [`ManagedAgentsUserActor`](../interfaces/ManagedAgentsUserActor.md) \| [`ManagedAgentsServiceAccountActor`](../interfaces/ManagedAgentsServiceAccountActor.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsAdvisorParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsAdvisorParamsType.md new file mode 100644 index 0000000..24bf37f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAdvisorParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAdvisorParamsType + +# Type Alias: ManagedAgentsAdvisorParamsType + +> **ManagedAgentsAdvisorParamsType** = `"advisor"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAdvisorType.md b/docs/api/managed/type-aliases/ManagedAgentsAdvisorType.md new file mode 100644 index 0000000..0d0aa8f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAdvisorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAdvisorType + +# Type Alias: ManagedAgentsAdvisorType + +> **ManagedAgentsAdvisorType** = `"advisor"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentArchivedDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentArchivedDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..b8cdeea --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentArchivedDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentArchivedDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsAgentArchivedDeploymentPausedReasonErrorType + +> **ManagedAgentsAgentArchivedDeploymentPausedReasonErrorType** = `"agent_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentArchivedRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentArchivedRunErrorType.md new file mode 100644 index 0000000..b0a5cff --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentArchivedRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentArchivedRunErrorType + +# Type Alias: ManagedAgentsAgentArchivedRunErrorType + +> **ManagedAgentsAgentArchivedRunErrorType** = `"agent_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentCustomToolUseEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentCustomToolUseEventType.md new file mode 100644 index 0000000..c326834 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentCustomToolUseEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentCustomToolUseEventType + +# Type Alias: ManagedAgentsAgentCustomToolUseEventType + +> **ManagedAgentsAgentCustomToolUseEventType** = `"agent.custom_tool_use"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnion.md new file mode 100644 index 0000000..1cf59cb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnion.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMCPToolResultEventContentUnion + +# Type Alias: ManagedAgentsAgentMCPToolResultEventContentUnion + +> **ManagedAgentsAgentMCPToolResultEventContentUnion** = [`ManagedAgentsTextBlock`](../interfaces/ManagedAgentsTextBlock.md) \| [`ManagedAgentsImageBlock`](../interfaces/ManagedAgentsImageBlock.md) \| [`ManagedAgentsDocumentBlock`](../interfaces/ManagedAgentsDocumentBlock.md) \| [`ManagedAgentsSearchResultBlock`](../interfaces/ManagedAgentsSearchResultBlock.md) + +ManagedAgentsAgentMCPToolResultEventContentUnion contains all possible +properties and values from `ManagedAgentsTextBlock`, +`ManagedAgentsImageBlock`, `ManagedAgentsDocumentBlock`, +`ManagedAgentsSearchResultBlock`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnionSource.md b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnionSource.md new file mode 100644 index 0000000..15f95ee --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventContentUnionSource.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMCPToolResultEventContentUnionSource + +# Type Alias: ManagedAgentsAgentMCPToolResultEventContentUnionSource + +> **ManagedAgentsAgentMCPToolResultEventContentUnionSource** = `string` \| \{ `data?`: `string`; `file_id?`: `string`; `media_type?`: `string`; `type?`: `string`; `url?`: `string`; \} + +ManagedAgentsAgentMCPToolResultEventContentUnionSource is an implicit +subunion of `ManagedAgentsAgentMCPToolResultEventContentUnion`. +ManagedAgentsAgentMCPToolResultEventContentUnionSource provides convenient +access to the sub-properties of the union. diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventType.md new file mode 100644 index 0000000..f0ab0ad --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolResultEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMCPToolResultEventType + +# Type Alias: ManagedAgentsAgentMCPToolResultEventType + +> **ManagedAgentsAgentMCPToolResultEventType** = `"agent.mcp_tool_result"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolUseEventEvaluatedPermission.md b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolUseEventEvaluatedPermission.md new file mode 100644 index 0000000..aa0291b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolUseEventEvaluatedPermission.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMCPToolUseEventEvaluatedPermission + +# Type Alias: ManagedAgentsAgentMCPToolUseEventEvaluatedPermission + +> **ManagedAgentsAgentMCPToolUseEventEvaluatedPermission** = `"allow"` \| `"ask"` \| `"deny"` + +AgentEvaluatedPermission enum diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolUseEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolUseEventType.md new file mode 100644 index 0000000..e82b508 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentMCPToolUseEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMCPToolUseEventType + +# Type Alias: ManagedAgentsAgentMCPToolUseEventType + +> **ManagedAgentsAgentMCPToolUseEventType** = `"agent.mcp_tool_use"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentMessageEventContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentMessageEventContentUnion.md new file mode 100644 index 0000000..9b2d57f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentMessageEventContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMessageEventContentUnion + +# Type Alias: ManagedAgentsAgentMessageEventContentUnion + +> **ManagedAgentsAgentMessageEventContentUnion** = [`ManagedAgentsTextBlock`](../interfaces/ManagedAgentsTextBlock.md) \| [`ManagedAgentsRedactedBlock`](../interfaces/ManagedAgentsRedactedBlock.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentMessageEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentMessageEventType.md new file mode 100644 index 0000000..b08b595 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentMessageEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMessageEventType + +# Type Alias: ManagedAgentsAgentMessageEventType + +> **ManagedAgentsAgentMessageEventType** = `"agent.message"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentMessagePreviewType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentMessagePreviewType.md new file mode 100644 index 0000000..5217585 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentMessagePreviewType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentMessagePreviewType + +# Type Alias: ManagedAgentsAgentMessagePreviewType + +> **ManagedAgentsAgentMessagePreviewType** = `"agent.message"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentParamsType.md new file mode 100644 index 0000000..f56d9ec --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentParamsType + +# Type Alias: ManagedAgentsAgentParamsType + +> **ManagedAgentsAgentParamsType** = `"agent"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentReferenceType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentReferenceType.md new file mode 100644 index 0000000..2bb30cb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentReferenceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentReferenceType + +# Type Alias: ManagedAgentsAgentReferenceType + +> **ManagedAgentsAgentReferenceType** = `"agent"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentSkillUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentSkillUnion.md new file mode 100644 index 0000000..30ea9a0 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentSkillUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentSkillUnion + +# Type Alias: ManagedAgentsAgentSkillUnion + +> **ManagedAgentsAgentSkillUnion** = [`ManagedAgentsQoderSkill`](../interfaces/ManagedAgentsQoderSkill.md) \| [`ManagedAgentsCustomSkill`](../interfaces/ManagedAgentsCustomSkill.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentThinkingEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentThinkingEventType.md new file mode 100644 index 0000000..cd9d0d6 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentThinkingEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThinkingEventType + +# Type Alias: ManagedAgentsAgentThinkingEventType + +> **ManagedAgentsAgentThinkingEventType** = `"agent.thinking"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentThinkingPreviewType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentThinkingPreviewType.md new file mode 100644 index 0000000..f55eca7 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentThinkingPreviewType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThinkingPreviewType + +# Type Alias: ManagedAgentsAgentThinkingPreviewType + +> **ManagedAgentsAgentThinkingPreviewType** = `"agent.thinking"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentThreadContextCompactedEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadContextCompactedEventType.md new file mode 100644 index 0000000..da46402 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadContextCompactedEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadContextCompactedEventType + +# Type Alias: ManagedAgentsAgentThreadContextCompactedEventType + +> **ManagedAgentsAgentThreadContextCompactedEventType** = `"agent.thread_context_compacted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageReceivedEventContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageReceivedEventContentUnion.md new file mode 100644 index 0000000..783e046 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageReceivedEventContentUnion.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadMessageReceivedEventContentUnion + +# Type Alias: ManagedAgentsAgentThreadMessageReceivedEventContentUnion + +> **ManagedAgentsAgentThreadMessageReceivedEventContentUnion** = [`ManagedAgentsTextBlock`](../interfaces/ManagedAgentsTextBlock.md) \| [`ManagedAgentsImageBlock`](../interfaces/ManagedAgentsImageBlock.md) \| [`ManagedAgentsDocumentBlock`](../interfaces/ManagedAgentsDocumentBlock.md) \| [`ManagedAgentsRedactedBlock`](../interfaces/ManagedAgentsRedactedBlock.md) + +ManagedAgentsAgentThreadMessageReceivedEventContentUnion contains all +possible properties and values from `ManagedAgentsTextBlock`, +`ManagedAgentsImageBlock`, `ManagedAgentsDocumentBlock`, +`ManagedAgentsRedactedBlock`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageReceivedEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageReceivedEventType.md new file mode 100644 index 0000000..d751828 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageReceivedEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadMessageReceivedEventType + +# Type Alias: ManagedAgentsAgentThreadMessageReceivedEventType + +> **ManagedAgentsAgentThreadMessageReceivedEventType** = `"agent.thread_message_received"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageSentEventContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageSentEventContentUnion.md new file mode 100644 index 0000000..909322b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageSentEventContentUnion.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadMessageSentEventContentUnion + +# Type Alias: ManagedAgentsAgentThreadMessageSentEventContentUnion + +> **ManagedAgentsAgentThreadMessageSentEventContentUnion** = [`ManagedAgentsTextBlock`](../interfaces/ManagedAgentsTextBlock.md) \| [`ManagedAgentsImageBlock`](../interfaces/ManagedAgentsImageBlock.md) \| [`ManagedAgentsDocumentBlock`](../interfaces/ManagedAgentsDocumentBlock.md) \| [`ManagedAgentsRedactedBlock`](../interfaces/ManagedAgentsRedactedBlock.md) + +ManagedAgentsAgentThreadMessageSentEventContentUnion contains all possible +properties and values from `ManagedAgentsTextBlock`, +`ManagedAgentsImageBlock`, `ManagedAgentsDocumentBlock`, +`ManagedAgentsRedactedBlock`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageSentEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageSentEventType.md new file mode 100644 index 0000000..c6da857 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentThreadMessageSentEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentThreadMessageSentEventType + +# Type Alias: ManagedAgentsAgentThreadMessageSentEventType + +> **ManagedAgentsAgentThreadMessageSentEventType** = `"agent.thread_message_sent"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolConfigParamsUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolConfigParamsUnion.md new file mode 100644 index 0000000..9697afc --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolConfigParamsUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolConfigParamsUnion + +# Type Alias: ManagedAgentsAgentToolConfigParamsUnion + +> **ManagedAgentsAgentToolConfigParamsUnion** = [`ManagedAgentsBashToolConfigParams`](../interfaces/ManagedAgentsBashToolConfigParams.md) \| [`ManagedAgentsEditToolConfigParams`](../interfaces/ManagedAgentsEditToolConfigParams.md) \| [`ManagedAgentsReadToolConfigParams`](../interfaces/ManagedAgentsReadToolConfigParams.md) \| [`ManagedAgentsWriteToolConfigParams`](../interfaces/ManagedAgentsWriteToolConfigParams.md) \| [`ManagedAgentsGlobToolConfigParams`](../interfaces/ManagedAgentsGlobToolConfigParams.md) \| [`ManagedAgentsGrepToolConfigParams`](../interfaces/ManagedAgentsGrepToolConfigParams.md) \| [`ManagedAgentsWebFetchToolConfigParams`](../interfaces/ManagedAgentsWebFetchToolConfigParams.md) \| [`ManagedAgentsWebSearchToolConfigParams`](../interfaces/ManagedAgentsWebSearchToolConfigParams.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolConfigUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolConfigUnion.md new file mode 100644 index 0000000..a8a3525 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolConfigUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolConfigUnion + +# Type Alias: ManagedAgentsAgentToolConfigUnion + +> **ManagedAgentsAgentToolConfigUnion** = [`ManagedAgentsBashToolConfig`](../interfaces/ManagedAgentsBashToolConfig.md) \| [`ManagedAgentsEditToolConfig`](../interfaces/ManagedAgentsEditToolConfig.md) \| [`ManagedAgentsReadToolConfig`](../interfaces/ManagedAgentsReadToolConfig.md) \| [`ManagedAgentsWriteToolConfig`](../interfaces/ManagedAgentsWriteToolConfig.md) \| [`ManagedAgentsGlobToolConfig`](../interfaces/ManagedAgentsGlobToolConfig.md) \| [`ManagedAgentsGrepToolConfig`](../interfaces/ManagedAgentsGrepToolConfig.md) \| [`ManagedAgentsWebFetchToolConfig`](../interfaces/ManagedAgentsWebFetchToolConfig.md) \| [`ManagedAgentsWebSearchToolConfig`](../interfaces/ManagedAgentsWebSearchToolConfig.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventContentUnion.md new file mode 100644 index 0000000..7613594 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventContentUnion.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolResultEventContentUnion + +# Type Alias: ManagedAgentsAgentToolResultEventContentUnion + +> **ManagedAgentsAgentToolResultEventContentUnion** = [`ManagedAgentsTextBlock`](../interfaces/ManagedAgentsTextBlock.md) \| [`ManagedAgentsImageBlock`](../interfaces/ManagedAgentsImageBlock.md) \| [`ManagedAgentsDocumentBlock`](../interfaces/ManagedAgentsDocumentBlock.md) \| [`ManagedAgentsSearchResultBlock`](../interfaces/ManagedAgentsSearchResultBlock.md) + +ManagedAgentsAgentToolResultEventContentUnion contains all possible +properties and values from `ManagedAgentsTextBlock`, +`ManagedAgentsImageBlock`, `ManagedAgentsDocumentBlock`, +`ManagedAgentsSearchResultBlock`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventContentUnionSource.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventContentUnionSource.md new file mode 100644 index 0000000..2812b2c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventContentUnionSource.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolResultEventContentUnionSource + +# Type Alias: ManagedAgentsAgentToolResultEventContentUnionSource + +> **ManagedAgentsAgentToolResultEventContentUnionSource** = `string` \| \{ `data?`: `string`; `file_id?`: `string`; `media_type?`: `string`; `type?`: `string`; `url?`: `string`; \} diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventType.md new file mode 100644 index 0000000..8af9d02 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolResultEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolResultEventType + +# Type Alias: ManagedAgentsAgentToolResultEventType + +> **ManagedAgentsAgentToolResultEventType** = `"agent.tool_result"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolUnion.md new file mode 100644 index 0000000..7972e07 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolUnion + +# Type Alias: ManagedAgentsAgentToolUnion + +> **ManagedAgentsAgentToolUnion** = [`ManagedAgentsAgentToolset20260401`](../interfaces/ManagedAgentsAgentToolset20260401.md) \| [`ManagedAgentsMCPToolset`](../interfaces/ManagedAgentsMCPToolset.md) \| [`ManagedAgentsCustomTool`](../interfaces/ManagedAgentsCustomTool.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolUnionConfigs.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolUnionConfigs.md new file mode 100644 index 0000000..89d6bcf --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolUnionConfigs.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolUnionConfigs + +# Type Alias: ManagedAgentsAgentToolUnionConfigs + +> **ManagedAgentsAgentToolUnionConfigs** = [`ManagedAgentsAgentToolConfigUnion`](ManagedAgentsAgentToolConfigUnion.md)[] \| [`ManagedAgentsMCPToolConfig`](../interfaces/ManagedAgentsMCPToolConfig.md)[] diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolUseEventEvaluatedPermission.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolUseEventEvaluatedPermission.md new file mode 100644 index 0000000..f79279b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolUseEventEvaluatedPermission.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolUseEventEvaluatedPermission + +# Type Alias: ManagedAgentsAgentToolUseEventEvaluatedPermission + +> **ManagedAgentsAgentToolUseEventEvaluatedPermission** = `"allow"` \| `"ask"` \| `"deny"` + +AgentEvaluatedPermission enum diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolUseEventType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolUseEventType.md new file mode 100644 index 0000000..9c1d080 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolUseEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolUseEventType + +# Type Alias: ManagedAgentsAgentToolUseEventType + +> **ManagedAgentsAgentToolUseEventType** = `"agent.tool_use"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolset20260401ParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolset20260401ParamsType.md new file mode 100644 index 0000000..bea51ef --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolset20260401ParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401ParamsType + +# Type Alias: ManagedAgentsAgentToolset20260401ParamsType + +> **ManagedAgentsAgentToolset20260401ParamsType** = `"agent_toolset_20260401"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolset20260401Type.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolset20260401Type.md new file mode 100644 index 0000000..e4bdf2b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolset20260401Type.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolset20260401Type + +# Type Alias: ManagedAgentsAgentToolset20260401Type + +> **ManagedAgentsAgentToolset20260401Type** = `"agent_toolset_20260401"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..9aafa2c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion + +> **ManagedAgentsAgentToolsetDefaultConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..fc3145b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion + +> **ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsAgentToolsetDefaultConfigPermissionPolicyUnion contains all +possible properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentType.md new file mode 100644 index 0000000..3e73c37 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentType + +# Type Alias: ManagedAgentsAgentType + +> **ManagedAgentsAgentType** = `"agent"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentWithOverridesParamsToolUnion.md b/docs/api/managed/type-aliases/ManagedAgentsAgentWithOverridesParamsToolUnion.md new file mode 100644 index 0000000..f6ef9fc --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentWithOverridesParamsToolUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentWithOverridesParamsToolUnion + +# Type Alias: ManagedAgentsAgentWithOverridesParamsToolUnion + +> **ManagedAgentsAgentWithOverridesParamsToolUnion** = [`ManagedAgentsAgentToolset20260401Params`](../interfaces/ManagedAgentsAgentToolset20260401Params.md) \| [`ManagedAgentsMCPToolsetParams`](../interfaces/ManagedAgentsMCPToolsetParams.md) \| [`ManagedAgentsCustomToolParams`](../interfaces/ManagedAgentsCustomToolParams.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsAgentWithOverridesParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsAgentWithOverridesParamsType.md new file mode 100644 index 0000000..c978e97 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAgentWithOverridesParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAgentWithOverridesParamsType + +# Type Alias: ManagedAgentsAgentWithOverridesParamsType + +> **ManagedAgentsAgentWithOverridesParamsType** = `"agent_with_overrides"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAlwaysAllowPolicyType.md b/docs/api/managed/type-aliases/ManagedAgentsAlwaysAllowPolicyType.md new file mode 100644 index 0000000..c473d6d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAlwaysAllowPolicyType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAlwaysAllowPolicyType + +# Type Alias: ManagedAgentsAlwaysAllowPolicyType + +> **ManagedAgentsAlwaysAllowPolicyType** = `"always_allow"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsAlwaysAskPolicyType.md b/docs/api/managed/type-aliases/ManagedAgentsAlwaysAskPolicyType.md new file mode 100644 index 0000000..6df4cff --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsAlwaysAskPolicyType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsAlwaysAskPolicyType + +# Type Alias: ManagedAgentsAlwaysAskPolicyType + +> **ManagedAgentsAlwaysAskPolicyType** = `"always_ask"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsBase64DocumentSourceType.md b/docs/api/managed/type-aliases/ManagedAgentsBase64DocumentSourceType.md new file mode 100644 index 0000000..0f24341 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsBase64DocumentSourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBase64DocumentSourceType + +# Type Alias: ManagedAgentsBase64DocumentSourceType + +> **ManagedAgentsBase64DocumentSourceType** = `"base64"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsBase64ImageSourceType.md b/docs/api/managed/type-aliases/ManagedAgentsBase64ImageSourceType.md new file mode 100644 index 0000000..4ac149f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsBase64ImageSourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBase64ImageSourceType + +# Type Alias: ManagedAgentsBase64ImageSourceType + +> **ManagedAgentsBase64ImageSourceType** = `"base64"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsBashToolConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsBashToolConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..d201cff --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsBashToolConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBashToolConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsBashToolConfigParamsPermissionPolicyUnion + +> **ManagedAgentsBashToolConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsBashToolConfigParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsBashToolConfigParamsType.md new file mode 100644 index 0000000..e1e345c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsBashToolConfigParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBashToolConfigParamsType + +# Type Alias: ManagedAgentsBashToolConfigParamsType + +> **ManagedAgentsBashToolConfigParamsType** = `"bash"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsBashToolConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsBashToolConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..4f523e5 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsBashToolConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBashToolConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsBashToolConfigPermissionPolicyUnion + +> **ManagedAgentsBashToolConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsBashToolConfigPermissionPolicyUnion contains all possible +properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsBillingErrorRetryStatusUnion.md b/docs/api/managed/type-aliases/ManagedAgentsBillingErrorRetryStatusUnion.md new file mode 100644 index 0000000..3d53ceb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsBillingErrorRetryStatusUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBillingErrorRetryStatusUnion + +# Type Alias: ManagedAgentsBillingErrorRetryStatusUnion + +> **ManagedAgentsBillingErrorRetryStatusUnion** = [`ManagedAgentsRetryStatusRetrying`](../interfaces/ManagedAgentsRetryStatusRetrying.md) \| [`ManagedAgentsRetryStatusExhausted`](../interfaces/ManagedAgentsRetryStatusExhausted.md) \| [`ManagedAgentsRetryStatusTerminal`](../interfaces/ManagedAgentsRetryStatusTerminal.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsBillingErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsBillingErrorType.md new file mode 100644 index 0000000..62a3ddd --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsBillingErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBillingErrorType + +# Type Alias: ManagedAgentsBillingErrorType + +> **ManagedAgentsBillingErrorType** = `"billing_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsBranchCheckoutType.md b/docs/api/managed/type-aliases/ManagedAgentsBranchCheckoutType.md new file mode 100644 index 0000000..50d753b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsBranchCheckoutType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBranchCheckoutType + +# Type Alias: ManagedAgentsBranchCheckoutType + +> **ManagedAgentsBranchCheckoutType** = `"branch"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsBudgetLimitType.md b/docs/api/managed/type-aliases/ManagedAgentsBudgetLimitType.md new file mode 100644 index 0000000..55f91e1 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsBudgetLimitType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsBudgetLimitType + +# Type Alias: ManagedAgentsBudgetLimitType + +> **ManagedAgentsBudgetLimitType** = `"limit"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsCommitCheckoutType.md b/docs/api/managed/type-aliases/ManagedAgentsCommitCheckoutType.md new file mode 100644 index 0000000..f3451d9 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCommitCheckoutType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCommitCheckoutType + +# Type Alias: ManagedAgentsCommitCheckoutType + +> **ManagedAgentsCommitCheckoutType** = `"commit"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsCredentialAuthUnion.md b/docs/api/managed/type-aliases/ManagedAgentsCredentialAuthUnion.md new file mode 100644 index 0000000..8a14bb8 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCredentialAuthUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredentialAuthUnion + +# Type Alias: ManagedAgentsCredentialAuthUnion + +> **ManagedAgentsCredentialAuthUnion** = [`ManagedAgentsMCPOAuthAuthResponse`](../interfaces/ManagedAgentsMCPOAuthAuthResponse.md) \| [`ManagedAgentsStaticBearerAuthResponse`](../interfaces/ManagedAgentsStaticBearerAuthResponse.md) \| [`ManagedAgentsEnvironmentVariableAuthResponse`](../interfaces/ManagedAgentsEnvironmentVariableAuthResponse.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion.md b/docs/api/managed/type-aliases/ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion.md new file mode 100644 index 0000000..20dbc5e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion + +# Type Alias: ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion + +> **ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion** = [`ManagedAgentsRetryStatusRetrying`](../interfaces/ManagedAgentsRetryStatusRetrying.md) \| [`ManagedAgentsRetryStatusExhausted`](../interfaces/ManagedAgentsRetryStatusExhausted.md) \| [`ManagedAgentsRetryStatusTerminal`](../interfaces/ManagedAgentsRetryStatusTerminal.md) + +ManagedAgentsCredentialHostUnreachableErrorRetryStatusUnion contains all +possible properties and values from `ManagedAgentsRetryStatusRetrying`, +`ManagedAgentsRetryStatusExhausted`, `ManagedAgentsRetryStatusTerminal`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsCredentialHostUnreachableErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsCredentialHostUnreachableErrorType.md new file mode 100644 index 0000000..4edab0a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCredentialHostUnreachableErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredentialHostUnreachableErrorType + +# Type Alias: ManagedAgentsCredentialHostUnreachableErrorType + +> **ManagedAgentsCredentialHostUnreachableErrorType** = `"credential_host_unreachable_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsCredentialNetworkingParamsUnion.md b/docs/api/managed/type-aliases/ManagedAgentsCredentialNetworkingParamsUnion.md new file mode 100644 index 0000000..e8fec5f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCredentialNetworkingParamsUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredentialNetworkingParamsUnion + +# Type Alias: ManagedAgentsCredentialNetworkingParamsUnion + +> **ManagedAgentsCredentialNetworkingParamsUnion** = [`ManagedAgentsUnrestrictedCredentialNetworkingParams`](../interfaces/ManagedAgentsUnrestrictedCredentialNetworkingParams.md) \| [`ManagedAgentsLimitedCredentialNetworkingParams`](../interfaces/ManagedAgentsLimitedCredentialNetworkingParams.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsCredentialType.md b/docs/api/managed/type-aliases/ManagedAgentsCredentialType.md new file mode 100644 index 0000000..e4636df --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCredentialType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredentialType + +# Type Alias: ManagedAgentsCredentialType + +> **ManagedAgentsCredentialType** = `"vault_credential"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsCredentialValidationStatus.md b/docs/api/managed/type-aliases/ManagedAgentsCredentialValidationStatus.md new file mode 100644 index 0000000..41c9c3c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCredentialValidationStatus.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredentialValidationStatus + +# Type Alias: ManagedAgentsCredentialValidationStatus + +> **ManagedAgentsCredentialValidationStatus** = `"valid"` \| `"invalid"` \| `"unknown"` + +Overall verdict of a credential validation probe. diff --git a/docs/api/managed/type-aliases/ManagedAgentsCredentialValidationType.md b/docs/api/managed/type-aliases/ManagedAgentsCredentialValidationType.md new file mode 100644 index 0000000..dbc0c1e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCredentialValidationType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCredentialValidationType + +# Type Alias: ManagedAgentsCredentialValidationType + +> **ManagedAgentsCredentialValidationType** = `"vault_credential_validation"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsCustomSkillParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsCustomSkillParamsType.md new file mode 100644 index 0000000..56538cd --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCustomSkillParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomSkillParamsType + +# Type Alias: ManagedAgentsCustomSkillParamsType + +> **ManagedAgentsCustomSkillParamsType** = `"custom"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsCustomSkillType.md b/docs/api/managed/type-aliases/ManagedAgentsCustomSkillType.md new file mode 100644 index 0000000..9340187 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCustomSkillType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomSkillType + +# Type Alias: ManagedAgentsCustomSkillType + +> **ManagedAgentsCustomSkillType** = `"custom"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsCustomToolParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsCustomToolParamsType.md new file mode 100644 index 0000000..35c8179 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCustomToolParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomToolParamsType + +# Type Alias: ManagedAgentsCustomToolParamsType + +> **ManagedAgentsCustomToolParamsType** = `"custom"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsCustomToolType.md b/docs/api/managed/type-aliases/ManagedAgentsCustomToolType.md new file mode 100644 index 0000000..f3b1680 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsCustomToolType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsCustomToolType + +# Type Alias: ManagedAgentsCustomToolType + +> **ManagedAgentsCustomToolType** = `"custom"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeleteSessionResourceType.md b/docs/api/managed/type-aliases/ManagedAgentsDeleteSessionResourceType.md new file mode 100644 index 0000000..eb8f442 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeleteSessionResourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeleteSessionResourceType + +# Type Alias: ManagedAgentsDeleteSessionResourceType + +> **ManagedAgentsDeleteSessionResourceType** = `"session_resource_deleted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeletedCredentialType.md b/docs/api/managed/type-aliases/ManagedAgentsDeletedCredentialType.md new file mode 100644 index 0000000..d631b2c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeletedCredentialType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedCredentialType + +# Type Alias: ManagedAgentsDeletedCredentialType + +> **ManagedAgentsDeletedCredentialType** = `"vault_credential_deleted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeletedMemoryStoreType.md b/docs/api/managed/type-aliases/ManagedAgentsDeletedMemoryStoreType.md new file mode 100644 index 0000000..d488602 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeletedMemoryStoreType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedMemoryStoreType + +# Type Alias: ManagedAgentsDeletedMemoryStoreType + +> **ManagedAgentsDeletedMemoryStoreType** = `"memory_store_deleted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeletedMemoryType.md b/docs/api/managed/type-aliases/ManagedAgentsDeletedMemoryType.md new file mode 100644 index 0000000..c26d122 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeletedMemoryType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedMemoryType + +# Type Alias: ManagedAgentsDeletedMemoryType + +> **ManagedAgentsDeletedMemoryType** = `"memory_deleted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeletedSessionType.md b/docs/api/managed/type-aliases/ManagedAgentsDeletedSessionType.md new file mode 100644 index 0000000..cdabf7d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeletedSessionType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedSessionType + +# Type Alias: ManagedAgentsDeletedSessionType + +> **ManagedAgentsDeletedSessionType** = `"session_deleted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeletedVaultType.md b/docs/api/managed/type-aliases/ManagedAgentsDeletedVaultType.md new file mode 100644 index 0000000..5491f72 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeletedVaultType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeletedVaultType + +# Type Alias: ManagedAgentsDeletedVaultType + +> **ManagedAgentsDeletedVaultType** = `"vault_deleted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeltaContentType.md b/docs/api/managed/type-aliases/ManagedAgentsDeltaContentType.md new file mode 100644 index 0000000..b8ce102 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeltaContentType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeltaContentType + +# Type Alias: ManagedAgentsDeltaContentType + +> **ManagedAgentsDeltaContentType** = `"content_delta"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeltaEventType.md b/docs/api/managed/type-aliases/ManagedAgentsDeltaEventType.md new file mode 100644 index 0000000..599f242 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeltaEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeltaEventType + +# Type Alias: ManagedAgentsDeltaEventType + +> **ManagedAgentsDeltaEventType** = `"event_delta"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeltaType.md b/docs/api/managed/type-aliases/ManagedAgentsDeltaType.md new file mode 100644 index 0000000..8560a6c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeltaType.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeltaType + +# Type Alias: ManagedAgentsDeltaType + +> **ManagedAgentsDeltaType** = `"agent.message"` \| `"agent.thinking"` + +EventDeltaType enum diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventParamsUnion.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventParamsUnion.md new file mode 100644 index 0000000..bde8e52 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventParamsUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentInitialEventParamsUnion + +# Type Alias: ManagedAgentsDeploymentInitialEventParamsUnion + +> **ManagedAgentsDeploymentInitialEventParamsUnion** = [`ManagedAgentsUserMessageEventParams`](../interfaces/ManagedAgentsUserMessageEventParams.md) \| [`ManagedAgentsUserDefineOutcomeEventParams`](../interfaces/ManagedAgentsUserDefineOutcomeEventParams.md) \| [`ManagedAgentsSystemMessageEventParams`](../interfaces/ManagedAgentsSystemMessageEventParams.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventUnion.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventUnion.md new file mode 100644 index 0000000..42cd762 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentInitialEventUnion + +# Type Alias: ManagedAgentsDeploymentInitialEventUnion + +> **ManagedAgentsDeploymentInitialEventUnion** = [`ManagedAgentsDeploymentUserMessageEvent`](../interfaces/ManagedAgentsDeploymentUserMessageEvent.md) \| [`ManagedAgentsDeploymentUserDefineOutcomeEvent`](../interfaces/ManagedAgentsDeploymentUserDefineOutcomeEvent.md) \| [`ManagedAgentsDeploymentSystemMessageEvent`](../interfaces/ManagedAgentsDeploymentSystemMessageEvent.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventUnionContent.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventUnionContent.md new file mode 100644 index 0000000..0d1af2c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentInitialEventUnionContent.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentInitialEventUnionContent + +# Type Alias: ManagedAgentsDeploymentInitialEventUnionContent + +> **ManagedAgentsDeploymentInitialEventUnionContent** = [`ManagedAgentsDeploymentUserMessageEventContentUnion`](ManagedAgentsDeploymentUserMessageEventContentUnion.md)[] \| [`ManagedAgentsSystemContentBlock`](../interfaces/ManagedAgentsSystemContentBlock.md)[] diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentPausedReasonErrorUnion.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentPausedReasonErrorUnion.md new file mode 100644 index 0000000..d5a334a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentPausedReasonErrorUnion.md @@ -0,0 +1,26 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentPausedReasonErrorUnion + +# Type Alias: ManagedAgentsDeploymentPausedReasonErrorUnion + +> **ManagedAgentsDeploymentPausedReasonErrorUnion** = [`ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError`](../interfaces/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError.md) \| [`ManagedAgentsAgentArchivedDeploymentPausedReasonError`](../interfaces/ManagedAgentsAgentArchivedDeploymentPausedReasonError.md) \| [`ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError`](../interfaces/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError.md) \| [`ManagedAgentsVaultNotFoundDeploymentPausedReasonError`](../interfaces/ManagedAgentsVaultNotFoundDeploymentPausedReasonError.md) \| [`ManagedAgentsFileNotFoundDeploymentPausedReasonError`](../interfaces/ManagedAgentsFileNotFoundDeploymentPausedReasonError.md) \| [`ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError`](../interfaces/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError.md) \| [`ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError`](../interfaces/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError.md) \| [`ManagedAgentsOrganizationDisabledDeploymentPausedReasonError`](../interfaces/ManagedAgentsOrganizationDisabledDeploymentPausedReasonError.md) \| [`ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError`](../interfaces/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError.md) \| [`ManagedAgentsSkillNotFoundDeploymentPausedReasonError`](../interfaces/ManagedAgentsSkillNotFoundDeploymentPausedReasonError.md) \| [`ManagedAgentsVaultArchivedDeploymentPausedReasonError`](../interfaces/ManagedAgentsVaultArchivedDeploymentPausedReasonError.md) \| [`ManagedAgentsUnknownDeploymentPausedReasonError`](../interfaces/ManagedAgentsUnknownDeploymentPausedReasonError.md) \| [`ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError`](../interfaces/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError.md) \| [`ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError`](../interfaces/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError.md) + +ManagedAgentsDeploymentPausedReasonErrorUnion contains all possible +properties and values from +`ManagedAgentsEnvironmentArchivedDeploymentPausedReasonError`, +`ManagedAgentsAgentArchivedDeploymentPausedReasonError`, +`ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError`, +`ManagedAgentsVaultNotFoundDeploymentPausedReasonError`, +`ManagedAgentsFileNotFoundDeploymentPausedReasonError`, +`ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError`, +`ManagedAgentsWorkspaceArchivedDeploymentPausedReasonError`, +`ManagedAgentsOrganizationDisabledDeploymentPausedReasonError`, +`ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError`, +`ManagedAgentsSkillNotFoundDeploymentPausedReasonError`, +`ManagedAgentsVaultArchivedDeploymentPausedReasonError`, +`ManagedAgentsUnknownDeploymentPausedReasonError`, +`ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError`, +`ManagedAgentsMCPEgressBlockedDeploymentPausedReasonError`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentPausedReasonUnion.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentPausedReasonUnion.md new file mode 100644 index 0000000..9df1401 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentPausedReasonUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentPausedReasonUnion + +# Type Alias: ManagedAgentsDeploymentPausedReasonUnion + +> **ManagedAgentsDeploymentPausedReasonUnion** = [`ManagedAgentsManualDeploymentPausedReason`](../interfaces/ManagedAgentsManualDeploymentPausedReason.md) \| [`ManagedAgentsErrorDeploymentPausedReason`](../interfaces/ManagedAgentsErrorDeploymentPausedReason.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentRunErrorUnion.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentRunErrorUnion.md new file mode 100644 index 0000000..c956c93 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentRunErrorUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentRunErrorUnion + +# Type Alias: ManagedAgentsDeploymentRunErrorUnion + +> **ManagedAgentsDeploymentRunErrorUnion** = [`ManagedAgentsEnvironmentArchivedRunError`](../interfaces/ManagedAgentsEnvironmentArchivedRunError.md) \| [`ManagedAgentsAgentArchivedRunError`](../interfaces/ManagedAgentsAgentArchivedRunError.md) \| [`ManagedAgentsEnvironmentNotFoundRunError`](../interfaces/ManagedAgentsEnvironmentNotFoundRunError.md) \| [`ManagedAgentsVaultNotFoundRunError`](../interfaces/ManagedAgentsVaultNotFoundRunError.md) \| [`ManagedAgentsVaultArchivedRunError`](../interfaces/ManagedAgentsVaultArchivedRunError.md) \| [`ManagedAgentsFileNotFoundRunError`](../interfaces/ManagedAgentsFileNotFoundRunError.md) \| [`ManagedAgentsMemoryStoreArchivedRunError`](../interfaces/ManagedAgentsMemoryStoreArchivedRunError.md) \| [`ManagedAgentsSkillNotFoundRunError`](../interfaces/ManagedAgentsSkillNotFoundRunError.md) \| [`ManagedAgentsSessionResourceNotFoundRunError`](../interfaces/ManagedAgentsSessionResourceNotFoundRunError.md) \| [`ManagedAgentsWorkspaceArchivedRunError`](../interfaces/ManagedAgentsWorkspaceArchivedRunError.md) \| [`ManagedAgentsOrganizationDisabledRunError`](../interfaces/ManagedAgentsOrganizationDisabledRunError.md) \| [`ManagedAgentsSessionRateLimitedRunError`](../interfaces/ManagedAgentsSessionRateLimitedRunError.md) \| [`ManagedAgentsSessionCreationRejectedRunError`](../interfaces/ManagedAgentsSessionCreationRejectedRunError.md) \| [`ManagedAgentsUnknownRunError`](../interfaces/ManagedAgentsUnknownRunError.md) \| [`ManagedAgentsSelfHostedResourcesUnsupportedRunError`](../interfaces/ManagedAgentsSelfHostedResourcesUnsupportedRunError.md) \| [`ManagedAgentsMCPEgressBlockedRunError`](../interfaces/ManagedAgentsMCPEgressBlockedRunError.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentRunType.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentRunType.md new file mode 100644 index 0000000..88abcc6 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentRunType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentRunType + +# Type Alias: ManagedAgentsDeploymentRunType + +> **ManagedAgentsDeploymentRunType** = `"deployment_run"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentStatus.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentStatus.md new file mode 100644 index 0000000..3e01218 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentStatus.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentStatus + +# Type Alias: ManagedAgentsDeploymentStatus + +> **ManagedAgentsDeploymentStatus** = `"active"` \| `"paused"` + +Lifecycle status of a deployment. diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentSystemMessageEventType.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentSystemMessageEventType.md new file mode 100644 index 0000000..c8df49e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentSystemMessageEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentSystemMessageEventType + +# Type Alias: ManagedAgentsDeploymentSystemMessageEventType + +> **ManagedAgentsDeploymentSystemMessageEventType** = `"system.message"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentType.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentType.md new file mode 100644 index 0000000..a264b07 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentType + +# Type Alias: ManagedAgentsDeploymentType + +> **ManagedAgentsDeploymentType** = `"deployment"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion.md new file mode 100644 index 0000000..8927dd9 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion + +# Type Alias: ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion + +> **ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion** = [`ManagedAgentsFileRubric`](../interfaces/ManagedAgentsFileRubric.md) \| [`ManagedAgentsTextRubric`](../interfaces/ManagedAgentsTextRubric.md) + +ManagedAgentsDeploymentUserDefineOutcomeEventRubricUnion contains all +possible properties and values from `ManagedAgentsFileRubric`, +`ManagedAgentsTextRubric`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventType.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventType.md new file mode 100644 index 0000000..e199f0b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserDefineOutcomeEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentUserDefineOutcomeEventType + +# Type Alias: ManagedAgentsDeploymentUserDefineOutcomeEventType + +> **ManagedAgentsDeploymentUserDefineOutcomeEventType** = `"user.define_outcome"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserMessageEventContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserMessageEventContentUnion.md new file mode 100644 index 0000000..8730929 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserMessageEventContentUnion.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentUserMessageEventContentUnion + +# Type Alias: ManagedAgentsDeploymentUserMessageEventContentUnion + +> **ManagedAgentsDeploymentUserMessageEventContentUnion** = [`ManagedAgentsTextBlock`](../interfaces/ManagedAgentsTextBlock.md) \| [`ManagedAgentsImageBlock`](../interfaces/ManagedAgentsImageBlock.md) \| [`ManagedAgentsDocumentBlock`](../interfaces/ManagedAgentsDocumentBlock.md) \| [`ManagedAgentsRedactedBlock`](../interfaces/ManagedAgentsRedactedBlock.md) + +ManagedAgentsDeploymentUserMessageEventContentUnion contains all possible +properties and values from `ManagedAgentsTextBlock`, +`ManagedAgentsImageBlock`, `ManagedAgentsDocumentBlock`, +`ManagedAgentsRedactedBlock`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserMessageEventType.md b/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserMessageEventType.md new file mode 100644 index 0000000..86888b4 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDeploymentUserMessageEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDeploymentUserMessageEventType + +# Type Alias: ManagedAgentsDeploymentUserMessageEventType + +> **ManagedAgentsDeploymentUserMessageEventType** = `"user.message"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsDocumentBlockSourceUnion.md b/docs/api/managed/type-aliases/ManagedAgentsDocumentBlockSourceUnion.md new file mode 100644 index 0000000..69a538a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDocumentBlockSourceUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDocumentBlockSourceUnion + +# Type Alias: ManagedAgentsDocumentBlockSourceUnion + +> **ManagedAgentsDocumentBlockSourceUnion** = [`ManagedAgentsBase64DocumentSource`](../interfaces/ManagedAgentsBase64DocumentSource.md) \| [`ManagedAgentsPlainTextDocumentSource`](../interfaces/ManagedAgentsPlainTextDocumentSource.md) \| [`ManagedAgentsURLDocumentSource`](../interfaces/ManagedAgentsURLDocumentSource.md) \| [`ManagedAgentsFileDocumentSource`](../interfaces/ManagedAgentsFileDocumentSource.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsDocumentBlockSourceUnionParam.md b/docs/api/managed/type-aliases/ManagedAgentsDocumentBlockSourceUnionParam.md new file mode 100644 index 0000000..4334d76 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDocumentBlockSourceUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDocumentBlockSourceUnionParam + +# Type Alias: ManagedAgentsDocumentBlockSourceUnionParam + +> **ManagedAgentsDocumentBlockSourceUnionParam** = [`ManagedAgentsBase64DocumentSourceParam`](../interfaces/ManagedAgentsBase64DocumentSourceParam.md) \| [`ManagedAgentsPlainTextDocumentSourceParam`](../interfaces/ManagedAgentsPlainTextDocumentSourceParam.md) \| [`ManagedAgentsURLDocumentSourceParam`](../interfaces/ManagedAgentsURLDocumentSourceParam.md) \| [`ManagedAgentsFileDocumentSourceParam`](../interfaces/ManagedAgentsFileDocumentSourceParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsDocumentBlockType.md b/docs/api/managed/type-aliases/ManagedAgentsDocumentBlockType.md new file mode 100644 index 0000000..4a278e1 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsDocumentBlockType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsDocumentBlockType + +# Type Alias: ManagedAgentsDocumentBlockType + +> **ManagedAgentsDocumentBlockType** = `"document"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEditToolConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsEditToolConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..2ac2224 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEditToolConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEditToolConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsEditToolConfigParamsPermissionPolicyUnion + +> **ManagedAgentsEditToolConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsEditToolConfigParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsEditToolConfigParamsType.md new file mode 100644 index 0000000..a07814a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEditToolConfigParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEditToolConfigParamsType + +# Type Alias: ManagedAgentsEditToolConfigParamsType + +> **ManagedAgentsEditToolConfigParamsType** = `"edit"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEditToolConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsEditToolConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..31a2bd3 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEditToolConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEditToolConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsEditToolConfigPermissionPolicyUnion + +> **ManagedAgentsEditToolConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsEditToolConfigPermissionPolicyUnion contains all possible +properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsEffortHighType.md b/docs/api/managed/type-aliases/ManagedAgentsEffortHighType.md new file mode 100644 index 0000000..8c6530d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEffortHighType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortHighType + +# Type Alias: ManagedAgentsEffortHighType + +> **ManagedAgentsEffortHighType** = `"high"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEffortLowType.md b/docs/api/managed/type-aliases/ManagedAgentsEffortLowType.md new file mode 100644 index 0000000..0af97b5 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEffortLowType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortLowType + +# Type Alias: ManagedAgentsEffortLowType + +> **ManagedAgentsEffortLowType** = `"low"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEffortMaxType.md b/docs/api/managed/type-aliases/ManagedAgentsEffortMaxType.md new file mode 100644 index 0000000..fa16000 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEffortMaxType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortMaxType + +# Type Alias: ManagedAgentsEffortMaxType + +> **ManagedAgentsEffortMaxType** = `"max"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEffortMediumType.md b/docs/api/managed/type-aliases/ManagedAgentsEffortMediumType.md new file mode 100644 index 0000000..70333dc --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEffortMediumType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortMediumType + +# Type Alias: ManagedAgentsEffortMediumType + +> **ManagedAgentsEffortMediumType** = `"medium"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEffortXhighType.md b/docs/api/managed/type-aliases/ManagedAgentsEffortXhighType.md new file mode 100644 index 0000000..8ca9ff1 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEffortXhighType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEffortXhighType + +# Type Alias: ManagedAgentsEffortXhighType + +> **ManagedAgentsEffortXhighType** = `"xhigh"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..5a45406 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorType + +> **ManagedAgentsEnvironmentArchivedDeploymentPausedReasonErrorType** = `"environment_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEnvironmentArchivedRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentArchivedRunErrorType.md new file mode 100644 index 0000000..5266f45 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentArchivedRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentArchivedRunErrorType + +# Type Alias: ManagedAgentsEnvironmentArchivedRunErrorType + +> **ManagedAgentsEnvironmentArchivedRunErrorType** = `"environment_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..a120c81 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorType + +> **ManagedAgentsEnvironmentNotFoundDeploymentPausedReasonErrorType** = `"environment_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEnvironmentNotFoundRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentNotFoundRunErrorType.md new file mode 100644 index 0000000..a48b660 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentNotFoundRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentNotFoundRunErrorType + +# Type Alias: ManagedAgentsEnvironmentNotFoundRunErrorType + +> **ManagedAgentsEnvironmentNotFoundRunErrorType** = `"environment_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion.md b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion.md new file mode 100644 index 0000000..80f6b2f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion + +# Type Alias: ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion + +> **ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion** = [`ManagedAgentsUnrestrictedCredentialNetworkingResponse`](../interfaces/ManagedAgentsUnrestrictedCredentialNetworkingResponse.md) \| [`ManagedAgentsLimitedCredentialNetworkingResponse`](../interfaces/ManagedAgentsLimitedCredentialNetworkingResponse.md) + +ManagedAgentsEnvironmentVariableAuthResponseNetworkingUnion contains all +possible properties and values from +`ManagedAgentsUnrestrictedCredentialNetworkingResponse`, +`ManagedAgentsLimitedCredentialNetworkingResponse`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableAuthResponseType.md b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableAuthResponseType.md new file mode 100644 index 0000000..8dda190 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableAuthResponseType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentVariableAuthResponseType + +# Type Alias: ManagedAgentsEnvironmentVariableAuthResponseType + +> **ManagedAgentsEnvironmentVariableAuthResponseType** = `"environment_variable"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableCreateParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableCreateParamsType.md new file mode 100644 index 0000000..79bae11 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableCreateParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentVariableCreateParamsType + +# Type Alias: ManagedAgentsEnvironmentVariableCreateParamsType + +> **ManagedAgentsEnvironmentVariableCreateParamsType** = `"environment_variable"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableUpdateParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableUpdateParamsType.md new file mode 100644 index 0000000..22e406a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEnvironmentVariableUpdateParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEnvironmentVariableUpdateParamsType + +# Type Alias: ManagedAgentsEnvironmentVariableUpdateParamsType + +> **ManagedAgentsEnvironmentVariableUpdateParamsType** = `"environment_variable"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsErrorDeploymentPausedReasonType.md b/docs/api/managed/type-aliases/ManagedAgentsErrorDeploymentPausedReasonType.md new file mode 100644 index 0000000..560059e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsErrorDeploymentPausedReasonType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsErrorDeploymentPausedReasonType + +# Type Alias: ManagedAgentsErrorDeploymentPausedReasonType + +> **ManagedAgentsErrorDeploymentPausedReasonType** = `"error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsEventParamsUnion.md b/docs/api/managed/type-aliases/ManagedAgentsEventParamsUnion.md new file mode 100644 index 0000000..f0c3e68 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsEventParamsUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsEventParamsUnion + +# Type Alias: ManagedAgentsEventParamsUnion + +> **ManagedAgentsEventParamsUnion** = [`ManagedAgentsUserMessageEventParams`](../interfaces/ManagedAgentsUserMessageEventParams.md) \| [`ManagedAgentsUserInterruptEventParams`](../interfaces/ManagedAgentsUserInterruptEventParams.md) \| [`ManagedAgentsUserToolConfirmationEventParams`](../interfaces/ManagedAgentsUserToolConfirmationEventParams.md) \| [`ManagedAgentsUserCustomToolResultEventParams`](../interfaces/ManagedAgentsUserCustomToolResultEventParams.md) \| [`ManagedAgentsUserDefineOutcomeEventParams`](../interfaces/ManagedAgentsUserDefineOutcomeEventParams.md) \| [`ManagedAgentsUserToolResultEventParams`](../interfaces/ManagedAgentsUserToolResultEventParams.md) \| [`ManagedAgentsSystemMessageEventParams`](../interfaces/ManagedAgentsSystemMessageEventParams.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsFileDocumentSourceType.md b/docs/api/managed/type-aliases/ManagedAgentsFileDocumentSourceType.md new file mode 100644 index 0000000..87a64ef --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsFileDocumentSourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileDocumentSourceType + +# Type Alias: ManagedAgentsFileDocumentSourceType + +> **ManagedAgentsFileDocumentSourceType** = `"file"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsFileImageSourceType.md b/docs/api/managed/type-aliases/ManagedAgentsFileImageSourceType.md new file mode 100644 index 0000000..00c8d62 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsFileImageSourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileImageSourceType + +# Type Alias: ManagedAgentsFileImageSourceType + +> **ManagedAgentsFileImageSourceType** = `"file"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsFileNotFoundDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsFileNotFoundDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..710b40b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsFileNotFoundDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileNotFoundDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsFileNotFoundDeploymentPausedReasonErrorType + +> **ManagedAgentsFileNotFoundDeploymentPausedReasonErrorType** = `"file_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsFileNotFoundRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsFileNotFoundRunErrorType.md new file mode 100644 index 0000000..8431fcb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsFileNotFoundRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileNotFoundRunErrorType + +# Type Alias: ManagedAgentsFileNotFoundRunErrorType + +> **ManagedAgentsFileNotFoundRunErrorType** = `"file_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsFileResourceConfigType.md b/docs/api/managed/type-aliases/ManagedAgentsFileResourceConfigType.md new file mode 100644 index 0000000..469a76c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsFileResourceConfigType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileResourceConfigType + +# Type Alias: ManagedAgentsFileResourceConfigType + +> **ManagedAgentsFileResourceConfigType** = `"file"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsFileResourceParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsFileResourceParamsType.md new file mode 100644 index 0000000..71190bb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsFileResourceParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileResourceParamsType + +# Type Alias: ManagedAgentsFileResourceParamsType + +> **ManagedAgentsFileResourceParamsType** = `"file"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsFileResourceType.md b/docs/api/managed/type-aliases/ManagedAgentsFileResourceType.md new file mode 100644 index 0000000..475d356 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsFileResourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileResourceType + +# Type Alias: ManagedAgentsFileResourceType + +> **ManagedAgentsFileResourceType** = `"file"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsFileRubricParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsFileRubricParamsType.md new file mode 100644 index 0000000..5f1f7e7 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsFileRubricParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileRubricParamsType + +# Type Alias: ManagedAgentsFileRubricParamsType + +> **ManagedAgentsFileRubricParamsType** = `"file"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsFileRubricType.md b/docs/api/managed/type-aliases/ManagedAgentsFileRubricType.md new file mode 100644 index 0000000..0f84d3f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsFileRubricType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsFileRubricType + +# Type Alias: ManagedAgentsFileRubricType + +> **ManagedAgentsFileRubricType** = `"file"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceCheckoutUnion.md b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceCheckoutUnion.md new file mode 100644 index 0000000..ea5f68f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceCheckoutUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGitHubRepositoryResourceCheckoutUnion + +# Type Alias: ManagedAgentsGitHubRepositoryResourceCheckoutUnion + +> **ManagedAgentsGitHubRepositoryResourceCheckoutUnion** = [`ManagedAgentsBranchCheckout`](../interfaces/ManagedAgentsBranchCheckout.md) \| [`ManagedAgentsCommitCheckout`](../interfaces/ManagedAgentsCommitCheckout.md) + +ManagedAgentsGitHubRepositoryResourceCheckoutUnion contains all possible +properties and values from `ManagedAgentsBranchCheckout`, +`ManagedAgentsCommitCheckout`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion.md b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion.md new file mode 100644 index 0000000..4af1141 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion + +# Type Alias: ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion + +> **ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion** = [`ManagedAgentsBranchCheckout`](../interfaces/ManagedAgentsBranchCheckout.md) \| [`ManagedAgentsCommitCheckout`](../interfaces/ManagedAgentsCommitCheckout.md) + +ManagedAgentsGitHubRepositoryResourceConfigCheckoutUnion contains all +possible properties and values from `ManagedAgentsBranchCheckout`, +`ManagedAgentsCommitCheckout`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceConfigType.md b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceConfigType.md new file mode 100644 index 0000000..e810e93 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceConfigType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGitHubRepositoryResourceConfigType + +# Type Alias: ManagedAgentsGitHubRepositoryResourceConfigType + +> **ManagedAgentsGitHubRepositoryResourceConfigType** = `"github_repository"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion.md b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion.md new file mode 100644 index 0000000..a0c87ac --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion + +# Type Alias: ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion + +> **ManagedAgentsGitHubRepositoryResourceParamsCheckoutUnion** = [`ManagedAgentsBranchCheckoutParam`](../interfaces/ManagedAgentsBranchCheckoutParam.md) \| [`ManagedAgentsCommitCheckoutParam`](../interfaces/ManagedAgentsCommitCheckoutParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceParamsType.md new file mode 100644 index 0000000..f402420 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGitHubRepositoryResourceParamsType + +# Type Alias: ManagedAgentsGitHubRepositoryResourceParamsType + +> **ManagedAgentsGitHubRepositoryResourceParamsType** = `"github_repository"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceType.md b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceType.md new file mode 100644 index 0000000..d9654b1 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGitHubRepositoryResourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGitHubRepositoryResourceType + +# Type Alias: ManagedAgentsGitHubRepositoryResourceType + +> **ManagedAgentsGitHubRepositoryResourceType** = `"github_repository"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..bdef6cf --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion + +> **ManagedAgentsGlobToolConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigParamsType.md new file mode 100644 index 0000000..4a37320 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGlobToolConfigParamsType + +# Type Alias: ManagedAgentsGlobToolConfigParamsType + +> **ManagedAgentsGlobToolConfigParamsType** = `"glob"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..17c5091 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGlobToolConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGlobToolConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsGlobToolConfigPermissionPolicyUnion + +> **ManagedAgentsGlobToolConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsGlobToolConfigPermissionPolicyUnion contains all possible +properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..f5922ee --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion + +> **ManagedAgentsGrepToolConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigParamsType.md new file mode 100644 index 0000000..1bd27ac --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGrepToolConfigParamsType + +# Type Alias: ManagedAgentsGrepToolConfigParamsType + +> **ManagedAgentsGrepToolConfigParamsType** = `"grep"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..795e803 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsGrepToolConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsGrepToolConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsGrepToolConfigPermissionPolicyUnion + +> **ManagedAgentsGrepToolConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsGrepToolConfigPermissionPolicyUnion contains all possible +properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsImageBlockSourceUnion.md b/docs/api/managed/type-aliases/ManagedAgentsImageBlockSourceUnion.md new file mode 100644 index 0000000..9a51d8c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsImageBlockSourceUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsImageBlockSourceUnion + +# Type Alias: ManagedAgentsImageBlockSourceUnion + +> **ManagedAgentsImageBlockSourceUnion** = [`ManagedAgentsBase64ImageSource`](../interfaces/ManagedAgentsBase64ImageSource.md) \| [`ManagedAgentsURLImageSource`](../interfaces/ManagedAgentsURLImageSource.md) \| [`ManagedAgentsFileImageSource`](../interfaces/ManagedAgentsFileImageSource.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsImageBlockSourceUnionParam.md b/docs/api/managed/type-aliases/ManagedAgentsImageBlockSourceUnionParam.md new file mode 100644 index 0000000..b0618cb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsImageBlockSourceUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsImageBlockSourceUnionParam + +# Type Alias: ManagedAgentsImageBlockSourceUnionParam + +> **ManagedAgentsImageBlockSourceUnionParam** = [`ManagedAgentsBase64ImageSourceParam`](../interfaces/ManagedAgentsBase64ImageSourceParam.md) \| [`ManagedAgentsURLImageSourceParam`](../interfaces/ManagedAgentsURLImageSourceParam.md) \| [`ManagedAgentsFileImageSourceParam`](../interfaces/ManagedAgentsFileImageSourceParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsImageBlockType.md b/docs/api/managed/type-aliases/ManagedAgentsImageBlockType.md new file mode 100644 index 0000000..5173371 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsImageBlockType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsImageBlockType + +# Type Alias: ManagedAgentsImageBlockType + +> **ManagedAgentsImageBlockType** = `"image"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsLimitedCredentialNetworkingParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsLimitedCredentialNetworkingParamsType.md new file mode 100644 index 0000000..dcdaffb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsLimitedCredentialNetworkingParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsLimitedCredentialNetworkingParamsType + +# Type Alias: ManagedAgentsLimitedCredentialNetworkingParamsType + +> **ManagedAgentsLimitedCredentialNetworkingParamsType** = `"limited"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsLimitedCredentialNetworkingResponseType.md b/docs/api/managed/type-aliases/ManagedAgentsLimitedCredentialNetworkingResponseType.md new file mode 100644 index 0000000..2a80602 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsLimitedCredentialNetworkingResponseType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsLimitedCredentialNetworkingResponseType + +# Type Alias: ManagedAgentsLimitedCredentialNetworkingResponseType + +> **ManagedAgentsLimitedCredentialNetworkingResponseType** = `"limited"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion.md new file mode 100644 index 0000000..a10448a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion + +# Type Alias: ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion + +> **ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion** = [`ManagedAgentsRetryStatusRetrying`](../interfaces/ManagedAgentsRetryStatusRetrying.md) \| [`ManagedAgentsRetryStatusExhausted`](../interfaces/ManagedAgentsRetryStatusExhausted.md) \| [`ManagedAgentsRetryStatusTerminal`](../interfaces/ManagedAgentsRetryStatusTerminal.md) + +ManagedAgentsMCPAuthenticationFailedErrorRetryStatusUnion contains all +possible properties and values from `ManagedAgentsRetryStatusRetrying`, +`ManagedAgentsRetryStatusExhausted`, `ManagedAgentsRetryStatusTerminal`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPAuthenticationFailedErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPAuthenticationFailedErrorType.md new file mode 100644 index 0000000..fbc433e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPAuthenticationFailedErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPAuthenticationFailedErrorType + +# Type Alias: ManagedAgentsMCPAuthenticationFailedErrorType + +> **ManagedAgentsMCPAuthenticationFailedErrorType** = `"mcp_authentication_failed_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion.md new file mode 100644 index 0000000..db511b9 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion + +# Type Alias: ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion + +> **ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion** = [`ManagedAgentsRetryStatusRetrying`](../interfaces/ManagedAgentsRetryStatusRetrying.md) \| [`ManagedAgentsRetryStatusExhausted`](../interfaces/ManagedAgentsRetryStatusExhausted.md) \| [`ManagedAgentsRetryStatusTerminal`](../interfaces/ManagedAgentsRetryStatusTerminal.md) + +ManagedAgentsMCPConnectionFailedErrorRetryStatusUnion contains all possible +properties and values from `ManagedAgentsRetryStatusRetrying`, +`ManagedAgentsRetryStatusExhausted`, `ManagedAgentsRetryStatusTerminal`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPConnectionFailedErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPConnectionFailedErrorType.md new file mode 100644 index 0000000..af3bee6 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPConnectionFailedErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPConnectionFailedErrorType + +# Type Alias: ManagedAgentsMCPConnectionFailedErrorType + +> **ManagedAgentsMCPConnectionFailedErrorType** = `"mcp_connection_failed_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..b85a953 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorType + +> **ManagedAgentsMCPEgressBlockedDeploymentPausedReasonErrorType** = `"mcp_egress_blocked_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPEgressBlockedRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPEgressBlockedRunErrorType.md new file mode 100644 index 0000000..e68cfca --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPEgressBlockedRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPEgressBlockedRunErrorType + +# Type Alias: ManagedAgentsMCPEgressBlockedRunErrorType + +> **ManagedAgentsMCPEgressBlockedRunErrorType** = `"mcp_egress_blocked_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthAuthResponseType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthAuthResponseType.md new file mode 100644 index 0000000..a6ffae6 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthAuthResponseType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthAuthResponseType + +# Type Alias: ManagedAgentsMCPOAuthAuthResponseType + +> **ManagedAgentsMCPOAuthAuthResponseType** = `"mcp_oauth"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthCreateParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthCreateParamsType.md new file mode 100644 index 0000000..d18ed74 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthCreateParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthCreateParamsType + +# Type Alias: ManagedAgentsMCPOAuthCreateParamsType + +> **ManagedAgentsMCPOAuthCreateParamsType** = `"mcp_oauth"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion.md new file mode 100644 index 0000000..c495452 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion + +# Type Alias: ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion + +> **ManagedAgentsMCPOAuthRefreshParamsTokenEndpointAuthUnion** = [`ManagedAgentsTokenEndpointAuthNoneParam`](../interfaces/ManagedAgentsTokenEndpointAuthNoneParam.md) \| [`ManagedAgentsTokenEndpointAuthBasicParam`](../interfaces/ManagedAgentsTokenEndpointAuthBasicParam.md) \| [`ManagedAgentsTokenEndpointAuthPostParam`](../interfaces/ManagedAgentsTokenEndpointAuthPostParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion.md new file mode 100644 index 0000000..7d2e680 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion.md @@ -0,0 +1,15 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion + +# Type Alias: ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion + +> **ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion** = [`ManagedAgentsTokenEndpointAuthNoneResponse`](../interfaces/ManagedAgentsTokenEndpointAuthNoneResponse.md) \| [`ManagedAgentsTokenEndpointAuthBasicResponse`](../interfaces/ManagedAgentsTokenEndpointAuthBasicResponse.md) \| [`ManagedAgentsTokenEndpointAuthPostResponse`](../interfaces/ManagedAgentsTokenEndpointAuthPostResponse.md) + +ManagedAgentsMCPOAuthRefreshResponseTokenEndpointAuthUnion contains all +possible properties and values from +`ManagedAgentsTokenEndpointAuthNoneResponse`, +`ManagedAgentsTokenEndpointAuthBasicResponse`, +`ManagedAgentsTokenEndpointAuthPostResponse`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion.md new file mode 100644 index 0000000..1be290e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion + +# Type Alias: ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion + +> **ManagedAgentsMCPOAuthRefreshUpdateParamsTokenEndpointAuthUnion** = [`ManagedAgentsTokenEndpointAuthBasicUpdateParam`](../interfaces/ManagedAgentsTokenEndpointAuthBasicUpdateParam.md) \| [`ManagedAgentsTokenEndpointAuthPostUpdateParam`](../interfaces/ManagedAgentsTokenEndpointAuthPostUpdateParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthUpdateParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthUpdateParamsType.md new file mode 100644 index 0000000..0d44150 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPOAuthUpdateParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPOAuthUpdateParamsType + +# Type Alias: ManagedAgentsMCPOAuthUpdateParamsType + +> **ManagedAgentsMCPOAuthUpdateParamsType** = `"mcp_oauth"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPServerURLDefinitionType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPServerURLDefinitionType.md new file mode 100644 index 0000000..ed6bf0e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPServerURLDefinitionType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPServerURLDefinitionType + +# Type Alias: ManagedAgentsMCPServerURLDefinitionType + +> **ManagedAgentsMCPServerURLDefinitionType** = `"url"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..6dd5f78 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion + +> **ManagedAgentsMCPToolConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPToolConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMCPToolConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..d073c22 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPToolConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsMCPToolConfigPermissionPolicyUnion + +> **ManagedAgentsMCPToolConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsMCPToolConfigPermissionPolicyUnion contains all possible +properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..0999aaa --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion + +> **ManagedAgentsMCPToolsetDefaultConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..f06f1f2 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion + +> **ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsMCPToolsetDefaultConfigPermissionPolicyUnion contains all +possible properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetParamsType.md new file mode 100644 index 0000000..0d19220 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolsetParamsType + +# Type Alias: ManagedAgentsMCPToolsetParamsType + +> **ManagedAgentsMCPToolsetParamsType** = `"mcp_toolset"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetType.md b/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetType.md new file mode 100644 index 0000000..4d0d5c8 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMCPToolsetType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMCPToolsetType + +# Type Alias: ManagedAgentsMCPToolsetType + +> **ManagedAgentsMCPToolsetType** = `"mcp_toolset"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsManualDeploymentPausedReasonType.md b/docs/api/managed/type-aliases/ManagedAgentsManualDeploymentPausedReasonType.md new file mode 100644 index 0000000..0b35ab8 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsManualDeploymentPausedReasonType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsManualDeploymentPausedReasonType + +# Type Alias: ManagedAgentsManualDeploymentPausedReasonType + +> **ManagedAgentsManualDeploymentPausedReasonType** = `"manual"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsManualTriggerContextType.md b/docs/api/managed/type-aliases/ManagedAgentsManualTriggerContextType.md new file mode 100644 index 0000000..3601c30 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsManualTriggerContextType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsManualTriggerContextType + +# Type Alias: ManagedAgentsManualTriggerContextType + +> **ManagedAgentsManualTriggerContextType** = `"manual"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryListItemUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryListItemUnion.md new file mode 100644 index 0000000..8fbf86c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryListItemUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryListItemUnion + +# Type Alias: ManagedAgentsMemoryListItemUnion + +> **ManagedAgentsMemoryListItemUnion** = [`ManagedAgentsMemory`](../interfaces/ManagedAgentsMemory.md) \| [`ManagedAgentsMemoryPrefix`](../interfaces/ManagedAgentsMemoryPrefix.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryPrefixType.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryPrefixType.md new file mode 100644 index 0000000..352859b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryPrefixType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryPrefixType + +# Type Alias: ManagedAgentsMemoryPrefixType + +> **ManagedAgentsMemoryPrefixType** = `"memory_prefix"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..84a69a6 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorType + +> **ManagedAgentsMemoryStoreArchivedDeploymentPausedReasonErrorType** = `"memory_store_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreArchivedRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreArchivedRunErrorType.md new file mode 100644 index 0000000..fe5efdb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreArchivedRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreArchivedRunErrorType + +# Type Alias: ManagedAgentsMemoryStoreArchivedRunErrorType + +> **ManagedAgentsMemoryStoreArchivedRunErrorType** = `"memory_store_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceAccess.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceAccess.md new file mode 100644 index 0000000..135bb78 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceAccess.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreResourceAccess + +# Type Alias: ManagedAgentsMemoryStoreResourceAccess + +> **ManagedAgentsMemoryStoreResourceAccess** = `"read_write"` \| `"read_only"` + +Access mode for an attached memory store. diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceConfigAccess.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceConfigAccess.md new file mode 100644 index 0000000..9761909 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceConfigAccess.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreResourceConfigAccess + +# Type Alias: ManagedAgentsMemoryStoreResourceConfigAccess + +> **ManagedAgentsMemoryStoreResourceConfigAccess** = `"read_write"` \| `"read_only"` + +Access mode for an attached memory store. diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceConfigType.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceConfigType.md new file mode 100644 index 0000000..5ab240b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceConfigType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreResourceConfigType + +# Type Alias: ManagedAgentsMemoryStoreResourceConfigType + +> **ManagedAgentsMemoryStoreResourceConfigType** = `"memory_store"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceParamAccess.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceParamAccess.md new file mode 100644 index 0000000..c7daada --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceParamAccess.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreResourceParamAccess + +# Type Alias: ManagedAgentsMemoryStoreResourceParamAccess + +> **ManagedAgentsMemoryStoreResourceParamAccess** = `"read_write"` \| `"read_only"` + +Access mode for an attached memory store. diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceParamType.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceParamType.md new file mode 100644 index 0000000..d4cdaeb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceParamType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreResourceParamType + +# Type Alias: ManagedAgentsMemoryStoreResourceParamType + +> **ManagedAgentsMemoryStoreResourceParamType** = `"memory_store"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceType.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceType.md new file mode 100644 index 0000000..1dc708c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreResourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreResourceType + +# Type Alias: ManagedAgentsMemoryStoreResourceType + +> **ManagedAgentsMemoryStoreResourceType** = `"memory_store"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreType.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreType.md new file mode 100644 index 0000000..57d0a4b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryStoreType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryStoreType + +# Type Alias: ManagedAgentsMemoryStoreType + +> **ManagedAgentsMemoryStoreType** = `"memory_store"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryType.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryType.md new file mode 100644 index 0000000..e19ee82 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryType + +# Type Alias: ManagedAgentsMemoryType + +> **ManagedAgentsMemoryType** = `"memory"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryVersionOperation.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryVersionOperation.md new file mode 100644 index 0000000..cb3aee7 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryVersionOperation.md @@ -0,0 +1,12 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryVersionOperation + +# Type Alias: ManagedAgentsMemoryVersionOperation + +> **ManagedAgentsMemoryVersionOperation** = `"created"` \| `"modified"` \| `"deleted"` + +The kind of mutation a `memory_version` records. Every non-no-op mutation to a +memory appends exactly one version row with one of these values. diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryVersionType.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryVersionType.md new file mode 100644 index 0000000..685a63a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryVersionType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryVersionType + +# Type Alias: ManagedAgentsMemoryVersionType + +> **ManagedAgentsMemoryVersionType** = `"memory_version"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMemoryView.md b/docs/api/managed/type-aliases/ManagedAgentsMemoryView.md new file mode 100644 index 0000000..b232cd0 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMemoryView.md @@ -0,0 +1,15 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMemoryView + +# Type Alias: ManagedAgentsMemoryView + +> **ManagedAgentsMemoryView** = `"basic"` \| `"full"` + +Selects which projection of a `memory` or `memory_version` the server returns. +`basic` returns the object with `content` set to `null`; `full` populates +`content`. When omitted, the default is endpoint-specific: retrieve operations +default to `full`; list, create, and update operations default to `basic`. +Listing with `view=full` caps `limit` at 20. diff --git a/docs/api/managed/type-aliases/ManagedAgentsModel.md b/docs/api/managed/type-aliases/ManagedAgentsModel.md new file mode 100644 index 0000000..3eca070 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModel.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModel + +# Type Alias: ManagedAgentsModel + +> **ManagedAgentsModel** = `"claude-fable-5-1"` \| `"claude-sonnet-5"` \| `"claude-fable-5"` \| `"claude-opus-5"` \| `"claude-opus-4-8"` \| `"claude-opus-4-7"` \| `"claude-opus-4-6"` \| `"claude-sonnet-4-6"` \| `"claude-haiku-4-5"` \| `"claude-haiku-4-5-20251001"` \| `"claude-opus-4-5"` \| `"claude-opus-4-5-20251101"` \| `"claude-sonnet-4-5"` \| `"claude-sonnet-4-5-20250929"` \| `string` & `object` + +The model that will power your agent. + +See [models](https://docs.qoder.com/cloud-agents/api/models/list) for additional +details and options. diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelConfig.md b/docs/api/managed/type-aliases/ManagedAgentsModelConfig.md new file mode 100644 index 0000000..d947a66 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelConfig.md @@ -0,0 +1,58 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelConfig + +# Type Alias: ManagedAgentsModelConfig + +> **ManagedAgentsModelConfig** = `string` \| \{ `context_window?`: `number`; `effort?`: [`ManagedAgentsModelConfigEffortUnion`](ManagedAgentsModelConfigEffortUnion.md); `id`: [`ManagedAgentsModel`](ManagedAgentsModel.md); `inference_geo?`: `string`; `speed?`: [`ManagedAgentsModelConfigSpeed`](ManagedAgentsModelConfigSpeed.md); \} + +Model identifier and configuration. + +## Union Members + +`string` + +*** + +### Type Literal + +\{ `context_window?`: `number`; `effort?`: [`ManagedAgentsModelConfigEffortUnion`](ManagedAgentsModelConfigEffortUnion.md); `id`: [`ManagedAgentsModel`](ManagedAgentsModel.md); `inference_geo?`: `string`; `speed?`: [`ManagedAgentsModelConfigSpeed`](ManagedAgentsModelConfigSpeed.md); \} + +#### context\_window? + +> `optional` **context\_window?**: `number` + +#### effort? + +> `optional` **effort?**: [`ManagedAgentsModelConfigEffortUnion`](ManagedAgentsModelConfigEffortUnion.md) + +How hard Claude works on each turn. Sets `output_config.effort` on every +Messages call the session makes. + +#### id + +> **id**: [`ManagedAgentsModel`](ManagedAgentsModel.md) + +The model that will power your agent. + +See [models](https://docs.qoder.com/cloud-agents/api/models/list) for additional +details and options. + +#### inference\_geo? + +> `optional` **inference\_geo?**: `string` + +Geographic region for model inference. When unset, requests fall through to the +workspace's default_inference_geo. + +#### speed? + +> `optional` **speed?**: [`ManagedAgentsModelConfigSpeed`](ManagedAgentsModelConfigSpeed.md) + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. + +Any of "standard", "fast". diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelConfigEffortUnion.md b/docs/api/managed/type-aliases/ManagedAgentsModelConfigEffortUnion.md new file mode 100644 index 0000000..9844f4c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelConfigEffortUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelConfigEffortUnion + +# Type Alias: ManagedAgentsModelConfigEffortUnion + +> **ManagedAgentsModelConfigEffortUnion** = [`ManagedAgentsEffortLow`](../interfaces/ManagedAgentsEffortLow.md) \| [`ManagedAgentsEffortMedium`](../interfaces/ManagedAgentsEffortMedium.md) \| [`ManagedAgentsEffortHigh`](../interfaces/ManagedAgentsEffortHigh.md) \| [`ManagedAgentsEffortXhigh`](../interfaces/ManagedAgentsEffortXhigh.md) \| [`ManagedAgentsEffortMax`](../interfaces/ManagedAgentsEffortMax.md) \| `"low"` \| `"medium"` \| `"high"` \| `"xhigh"` \| `"max"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelConfigParams.md b/docs/api/managed/type-aliases/ManagedAgentsModelConfigParams.md new file mode 100644 index 0000000..56fb223 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelConfigParams.md @@ -0,0 +1,60 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelConfigParams + +# Type Alias: ManagedAgentsModelConfigParams + +> **ManagedAgentsModelConfigParams** = `string` \| \{ `context_window?`: `number` \| `null`; `effort?`: [`ManagedAgentsModelConfigParamsEffortUnion`](ManagedAgentsModelConfigParamsEffortUnion.md) \| `null`; `id`: [`ManagedAgentsModel`](ManagedAgentsModel.md); `inference_geo?`: `string` \| `null`; `speed?`: [`ManagedAgentsModelConfigParamsSpeed`](ManagedAgentsModelConfigParamsSpeed.md) \| `null`; \} + +An object that defines additional configuration control over model use + +## Union Members + +`string` + +*** + +### Type Literal + +\{ `context_window?`: `number` \| `null`; `effort?`: [`ManagedAgentsModelConfigParamsEffortUnion`](ManagedAgentsModelConfigParamsEffortUnion.md) \| `null`; `id`: [`ManagedAgentsModel`](ManagedAgentsModel.md); `inference_geo?`: `string` \| `null`; `speed?`: [`ManagedAgentsModelConfigParamsSpeed`](ManagedAgentsModelConfigParamsSpeed.md) \| `null`; \} + +#### context\_window? + +> `optional` **context\_window?**: `number` \| `null` + +#### effort? + +> `optional` **effort?**: [`ManagedAgentsModelConfigParamsEffortUnion`](ManagedAgentsModelConfigParamsEffortUnion.md) \| `null` + +How hard Claude works on each inference call. Accepts a bare level string +(`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model +default; on update, omitting it leaves the stored value unchanged. + +#### id + +> **id**: [`ManagedAgentsModel`](ManagedAgentsModel.md) + +The model that will power your agent. + +See [models](https://docs.qoder.com/cloud-agents/api/models/list) for additional +details and options. + +#### inference\_geo? + +> `optional` **inference\_geo?**: `string` \| `null` + +Geographic region for model inference. When unset, requests fall through to the +workspace's default_inference_geo. On update, `model` is whole-object +replacement — omitting inference_geo clears it. + +#### speed? + +> `optional` **speed?**: [`ManagedAgentsModelConfigParamsSpeed`](ManagedAgentsModelConfigParamsSpeed.md) \| `null` + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. + +Any of "standard", "fast". diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsEffortManagedAgentsEffortLevel.md b/docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsEffortManagedAgentsEffortLevel.md new file mode 100644 index 0000000..a01c8fa --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsEffortManagedAgentsEffortLevel.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelConfigParamsEffortManagedAgentsEffortLevel + +# Type Alias: ManagedAgentsModelConfigParamsEffortManagedAgentsEffortLevel + +> **ManagedAgentsModelConfigParamsEffortManagedAgentsEffortLevel** = `"low"` \| `"medium"` \| `"high"` \| `"xhigh"` \| `"max"` + +How hard Claude works on each turn. Higher levels favor reasoning depth over +latency. Not all models accept every level; invalid combinations are rejected at +create time. diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsEffortUnion.md b/docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsEffortUnion.md new file mode 100644 index 0000000..f6a9f09 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsEffortUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelConfigParamsEffortUnion + +# Type Alias: ManagedAgentsModelConfigParamsEffortUnion + +> **ManagedAgentsModelConfigParamsEffortUnion** = `string` \| [`ManagedAgentsEffortLowParam`](../interfaces/ManagedAgentsEffortLowParam.md) \| [`ManagedAgentsEffortMediumParam`](../interfaces/ManagedAgentsEffortMediumParam.md) \| [`ManagedAgentsEffortHighParam`](../interfaces/ManagedAgentsEffortHighParam.md) \| [`ManagedAgentsEffortXhighParam`](../interfaces/ManagedAgentsEffortXhighParam.md) \| [`ManagedAgentsEffortMaxParam`](../interfaces/ManagedAgentsEffortMaxParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsSpeed.md b/docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsSpeed.md new file mode 100644 index 0000000..2145afb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelConfigParamsSpeed.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelConfigParamsSpeed + +# Type Alias: ManagedAgentsModelConfigParamsSpeed + +> **ManagedAgentsModelConfigParamsSpeed** = `"standard"` \| `"fast"` + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelConfigSpeed.md b/docs/api/managed/type-aliases/ManagedAgentsModelConfigSpeed.md new file mode 100644 index 0000000..770b94c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelConfigSpeed.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelConfigSpeed + +# Type Alias: ManagedAgentsModelConfigSpeed + +> **ManagedAgentsModelConfigSpeed** = `"standard"` \| `"fast"` + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelOverloadedErrorRetryStatusUnion.md b/docs/api/managed/type-aliases/ManagedAgentsModelOverloadedErrorRetryStatusUnion.md new file mode 100644 index 0000000..d420ab4 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelOverloadedErrorRetryStatusUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelOverloadedErrorRetryStatusUnion + +# Type Alias: ManagedAgentsModelOverloadedErrorRetryStatusUnion + +> **ManagedAgentsModelOverloadedErrorRetryStatusUnion** = [`ManagedAgentsRetryStatusRetrying`](../interfaces/ManagedAgentsRetryStatusRetrying.md) \| [`ManagedAgentsRetryStatusExhausted`](../interfaces/ManagedAgentsRetryStatusExhausted.md) \| [`ManagedAgentsRetryStatusTerminal`](../interfaces/ManagedAgentsRetryStatusTerminal.md) + +ManagedAgentsModelOverloadedErrorRetryStatusUnion contains all possible +properties and values from `ManagedAgentsRetryStatusRetrying`, +`ManagedAgentsRetryStatusExhausted`, `ManagedAgentsRetryStatusTerminal`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelOverloadedErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsModelOverloadedErrorType.md new file mode 100644 index 0000000..04dac5c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelOverloadedErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelOverloadedErrorType + +# Type Alias: ManagedAgentsModelOverloadedErrorType + +> **ManagedAgentsModelOverloadedErrorType** = `"model_overloaded_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelRateLimitedErrorRetryStatusUnion.md b/docs/api/managed/type-aliases/ManagedAgentsModelRateLimitedErrorRetryStatusUnion.md new file mode 100644 index 0000000..bffb51a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelRateLimitedErrorRetryStatusUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelRateLimitedErrorRetryStatusUnion + +# Type Alias: ManagedAgentsModelRateLimitedErrorRetryStatusUnion + +> **ManagedAgentsModelRateLimitedErrorRetryStatusUnion** = [`ManagedAgentsRetryStatusRetrying`](../interfaces/ManagedAgentsRetryStatusRetrying.md) \| [`ManagedAgentsRetryStatusExhausted`](../interfaces/ManagedAgentsRetryStatusExhausted.md) \| [`ManagedAgentsRetryStatusTerminal`](../interfaces/ManagedAgentsRetryStatusTerminal.md) + +ManagedAgentsModelRateLimitedErrorRetryStatusUnion contains all possible +properties and values from `ManagedAgentsRetryStatusRetrying`, +`ManagedAgentsRetryStatusExhausted`, `ManagedAgentsRetryStatusTerminal`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelRateLimitedErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsModelRateLimitedErrorType.md new file mode 100644 index 0000000..ca4d902 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelRateLimitedErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelRateLimitedErrorType + +# Type Alias: ManagedAgentsModelRateLimitedErrorType + +> **ManagedAgentsModelRateLimitedErrorType** = `"model_rate_limited_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelRequestFailedErrorRetryStatusUnion.md b/docs/api/managed/type-aliases/ManagedAgentsModelRequestFailedErrorRetryStatusUnion.md new file mode 100644 index 0000000..5a6bf0d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelRequestFailedErrorRetryStatusUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelRequestFailedErrorRetryStatusUnion + +# Type Alias: ManagedAgentsModelRequestFailedErrorRetryStatusUnion + +> **ManagedAgentsModelRequestFailedErrorRetryStatusUnion** = [`ManagedAgentsRetryStatusRetrying`](../interfaces/ManagedAgentsRetryStatusRetrying.md) \| [`ManagedAgentsRetryStatusExhausted`](../interfaces/ManagedAgentsRetryStatusExhausted.md) \| [`ManagedAgentsRetryStatusTerminal`](../interfaces/ManagedAgentsRetryStatusTerminal.md) + +ManagedAgentsModelRequestFailedErrorRetryStatusUnion contains all possible +properties and values from `ManagedAgentsRetryStatusRetrying`, +`ManagedAgentsRetryStatusExhausted`, `ManagedAgentsRetryStatusTerminal`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsModelRequestFailedErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsModelRequestFailedErrorType.md new file mode 100644 index 0000000..3b829f0 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsModelRequestFailedErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsModelRequestFailedErrorType + +# Type Alias: ManagedAgentsModelRequestFailedErrorType + +> **ManagedAgentsModelRequestFailedErrorType** = `"model_request_failed_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMultiagentAgentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMultiagentAgentUnion.md new file mode 100644 index 0000000..884566d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMultiagentAgentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMultiagentAgentUnion + +# Type Alias: ManagedAgentsMultiagentAgentUnion + +> **ManagedAgentsMultiagentAgentUnion** = [`ManagedAgentsAgentReference`](../interfaces/ManagedAgentsAgentReference.md) \| [`ManagedAgentsAdvisor`](../interfaces/ManagedAgentsAdvisor.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsMultiagentParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsMultiagentParamsType.md new file mode 100644 index 0000000..790e6bd --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMultiagentParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMultiagentParamsType + +# Type Alias: ManagedAgentsMultiagentParamsType + +> **ManagedAgentsMultiagentParamsType** = `"coordinator"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMultiagentRosterEntryParamsUnion.md b/docs/api/managed/type-aliases/ManagedAgentsMultiagentRosterEntryParamsUnion.md new file mode 100644 index 0000000..40c972e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMultiagentRosterEntryParamsUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMultiagentRosterEntryParamsUnion + +# Type Alias: ManagedAgentsMultiagentRosterEntryParamsUnion + +> **ManagedAgentsMultiagentRosterEntryParamsUnion** = `string` \| [`ManagedAgentsAgentParams`](../interfaces/ManagedAgentsAgentParams.md) \| [`ManagedAgentsMultiagentSelfParams`](../interfaces/ManagedAgentsMultiagentSelfParams.md) \| [`ManagedAgentsAdvisorParams`](../interfaces/ManagedAgentsAdvisorParams.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsMultiagentSelfParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsMultiagentSelfParamsType.md new file mode 100644 index 0000000..f42f85f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMultiagentSelfParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMultiagentSelfParamsType + +# Type Alias: ManagedAgentsMultiagentSelfParamsType + +> **ManagedAgentsMultiagentSelfParamsType** = `"self"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsMultiagentType.md b/docs/api/managed/type-aliases/ManagedAgentsMultiagentType.md new file mode 100644 index 0000000..dceaa7c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsMultiagentType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsMultiagentType + +# Type Alias: ManagedAgentsMultiagentType + +> **ManagedAgentsMultiagentType** = `"coordinator"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..e58b78e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorType + +> **ManagedAgentsOrganizationDisabledDeploymentPausedReasonErrorType** = `"organization_disabled_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsOrganizationDisabledRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsOrganizationDisabledRunErrorType.md new file mode 100644 index 0000000..843e7ce --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsOrganizationDisabledRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsOrganizationDisabledRunErrorType + +# Type Alias: ManagedAgentsOrganizationDisabledRunErrorType + +> **ManagedAgentsOrganizationDisabledRunErrorType** = `"organization_disabled_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsOutcomeEvaluationResourceType.md b/docs/api/managed/type-aliases/ManagedAgentsOutcomeEvaluationResourceType.md new file mode 100644 index 0000000..dd26db4 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsOutcomeEvaluationResourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsOutcomeEvaluationResourceType + +# Type Alias: ManagedAgentsOutcomeEvaluationResourceType + +> **ManagedAgentsOutcomeEvaluationResourceType** = `"outcome_evaluation"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsPlainTextDocumentSourceMediaType.md b/docs/api/managed/type-aliases/ManagedAgentsPlainTextDocumentSourceMediaType.md new file mode 100644 index 0000000..750951d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsPlainTextDocumentSourceMediaType.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsPlainTextDocumentSourceMediaType + +# Type Alias: ManagedAgentsPlainTextDocumentSourceMediaType + +> **ManagedAgentsPlainTextDocumentSourceMediaType** = `"text/plain"` + +MIME type of the text content. Must be "text/plain". diff --git a/docs/api/managed/type-aliases/ManagedAgentsPlainTextDocumentSourceType.md b/docs/api/managed/type-aliases/ManagedAgentsPlainTextDocumentSourceType.md new file mode 100644 index 0000000..0b41176 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsPlainTextDocumentSourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsPlainTextDocumentSourceType + +# Type Alias: ManagedAgentsPlainTextDocumentSourceType + +> **ManagedAgentsPlainTextDocumentSourceType** = `"text"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsPreconditionType.md b/docs/api/managed/type-aliases/ManagedAgentsPreconditionType.md new file mode 100644 index 0000000..6dd2777 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsPreconditionType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsPreconditionType + +# Type Alias: ManagedAgentsPreconditionType + +> **ManagedAgentsPreconditionType** = `"content_sha256"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsQoderSkillParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsQoderSkillParamsType.md new file mode 100644 index 0000000..60c186b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsQoderSkillParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsQoderSkillParamsType + +# Type Alias: ManagedAgentsQoderSkillParamsType + +> **ManagedAgentsQoderSkillParamsType** = `"qoder"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsQoderSkillType.md b/docs/api/managed/type-aliases/ManagedAgentsQoderSkillType.md new file mode 100644 index 0000000..a60e2df --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsQoderSkillType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsQoderSkillType + +# Type Alias: ManagedAgentsQoderSkillType + +> **ManagedAgentsQoderSkillType** = `"qoder"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsReadToolConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsReadToolConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..7c82d57 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsReadToolConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsReadToolConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsReadToolConfigParamsPermissionPolicyUnion + +> **ManagedAgentsReadToolConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsReadToolConfigParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsReadToolConfigParamsType.md new file mode 100644 index 0000000..7764844 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsReadToolConfigParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsReadToolConfigParamsType + +# Type Alias: ManagedAgentsReadToolConfigParamsType + +> **ManagedAgentsReadToolConfigParamsType** = `"read"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsReadToolConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsReadToolConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..d45dddd --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsReadToolConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsReadToolConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsReadToolConfigPermissionPolicyUnion + +> **ManagedAgentsReadToolConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsReadToolConfigPermissionPolicyUnion contains all possible +properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsRedactedBlockType.md b/docs/api/managed/type-aliases/ManagedAgentsRedactedBlockType.md new file mode 100644 index 0000000..2b3fecb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsRedactedBlockType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRedactedBlockType + +# Type Alias: ManagedAgentsRedactedBlockType + +> **ManagedAgentsRedactedBlockType** = `"redacted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsRefreshObjectStatus.md b/docs/api/managed/type-aliases/ManagedAgentsRefreshObjectStatus.md new file mode 100644 index 0000000..4ecf8ac --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsRefreshObjectStatus.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRefreshObjectStatus + +# Type Alias: ManagedAgentsRefreshObjectStatus + +> **ManagedAgentsRefreshObjectStatus** = `"succeeded"` \| `"failed"` \| `"connect_error"` \| `"no_refresh_token"` + +Outcome of a refresh-token exchange attempted during credential validation. diff --git a/docs/api/managed/type-aliases/ManagedAgentsRetryStatusExhaustedType.md b/docs/api/managed/type-aliases/ManagedAgentsRetryStatusExhaustedType.md new file mode 100644 index 0000000..c60f29e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsRetryStatusExhaustedType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRetryStatusExhaustedType + +# Type Alias: ManagedAgentsRetryStatusExhaustedType + +> **ManagedAgentsRetryStatusExhaustedType** = `"exhausted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsRetryStatusRetryingType.md b/docs/api/managed/type-aliases/ManagedAgentsRetryStatusRetryingType.md new file mode 100644 index 0000000..0219eae --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsRetryStatusRetryingType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRetryStatusRetryingType + +# Type Alias: ManagedAgentsRetryStatusRetryingType + +> **ManagedAgentsRetryStatusRetryingType** = `"retrying"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsRetryStatusTerminalType.md b/docs/api/managed/type-aliases/ManagedAgentsRetryStatusTerminalType.md new file mode 100644 index 0000000..ead809e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsRetryStatusTerminalType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsRetryStatusTerminalType + +# Type Alias: ManagedAgentsRetryStatusTerminalType + +> **ManagedAgentsRetryStatusTerminalType** = `"terminal"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsScheduleParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsScheduleParamsType.md new file mode 100644 index 0000000..25fc51c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsScheduleParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsScheduleParamsType + +# Type Alias: ManagedAgentsScheduleParamsType + +> **ManagedAgentsScheduleParamsType** = `"cron"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsScheduleTriggerContextType.md b/docs/api/managed/type-aliases/ManagedAgentsScheduleTriggerContextType.md new file mode 100644 index 0000000..e7da453 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsScheduleTriggerContextType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsScheduleTriggerContextType + +# Type Alias: ManagedAgentsScheduleTriggerContextType + +> **ManagedAgentsScheduleTriggerContextType** = `"schedule"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsScheduleType.md b/docs/api/managed/type-aliases/ManagedAgentsScheduleType.md new file mode 100644 index 0000000..5e412f4 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsScheduleType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsScheduleType + +# Type Alias: ManagedAgentsScheduleType + +> **ManagedAgentsScheduleType** = `"cron"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSearchResultBlockType.md b/docs/api/managed/type-aliases/ManagedAgentsSearchResultBlockType.md new file mode 100644 index 0000000..d5b8636 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSearchResultBlockType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSearchResultBlockType + +# Type Alias: ManagedAgentsSearchResultBlockType + +> **ManagedAgentsSearchResultBlockType** = `"search_result"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSearchResultContentType.md b/docs/api/managed/type-aliases/ManagedAgentsSearchResultContentType.md new file mode 100644 index 0000000..6360123 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSearchResultContentType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSearchResultContentType + +# Type Alias: ManagedAgentsSearchResultContentType + +> **ManagedAgentsSearchResultContentType** = `"text"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..1d70b98 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorType + +> **ManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonErrorType** = `"self_hosted_resources_unsupported_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedRunErrorType.md new file mode 100644 index 0000000..0da9d15 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSelfHostedResourcesUnsupportedRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSelfHostedResourcesUnsupportedRunErrorType + +# Type Alias: ManagedAgentsSelfHostedResourcesUnsupportedRunErrorType + +> **ManagedAgentsSelfHostedResourcesUnsupportedRunErrorType** = `"self_hosted_resources_unsupported_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSendSessionEventsDataUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSendSessionEventsDataUnion.md new file mode 100644 index 0000000..7fab560 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSendSessionEventsDataUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSendSessionEventsDataUnion + +# Type Alias: ManagedAgentsSendSessionEventsDataUnion + +> **ManagedAgentsSendSessionEventsDataUnion** = [`ManagedAgentsUserMessageEvent`](../interfaces/ManagedAgentsUserMessageEvent.md) \| [`ManagedAgentsUserInterruptEvent`](../interfaces/ManagedAgentsUserInterruptEvent.md) \| [`ManagedAgentsUserToolConfirmationEvent`](../interfaces/ManagedAgentsUserToolConfirmationEvent.md) \| [`ManagedAgentsUserCustomToolResultEvent`](../interfaces/ManagedAgentsUserCustomToolResultEvent.md) \| [`ManagedAgentsUserDefineOutcomeEvent`](../interfaces/ManagedAgentsUserDefineOutcomeEvent.md) \| [`ManagedAgentsUserToolResultEvent`](../interfaces/ManagedAgentsUserToolResultEvent.md) \| [`ManagedAgentsSystemMessageEvent`](../interfaces/ManagedAgentsSystemMessageEvent.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSendSessionEventsDataUnionContent.md b/docs/api/managed/type-aliases/ManagedAgentsSendSessionEventsDataUnionContent.md new file mode 100644 index 0000000..91acf01 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSendSessionEventsDataUnionContent.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSendSessionEventsDataUnionContent + +# Type Alias: ManagedAgentsSendSessionEventsDataUnionContent + +> **ManagedAgentsSendSessionEventsDataUnionContent** = [`ManagedAgentsUserMessageEventContentUnion`](ManagedAgentsUserMessageEventContentUnion.md)[] \| [`ManagedAgentsUserCustomToolResultEventContentUnion`](ManagedAgentsUserCustomToolResultEventContentUnion.md)[] \| [`ManagedAgentsUserToolResultEventContentUnion`](ManagedAgentsUserToolResultEventContentUnion.md)[] \| [`ManagedAgentsSystemContentBlock`](../interfaces/ManagedAgentsSystemContentBlock.md)[] diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionActorType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionActorType.md new file mode 100644 index 0000000..c78e546 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionActorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionActorType + +# Type Alias: ManagedAgentsSessionActorType + +> **ManagedAgentsSessionActorType** = `"session_actor"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionAgentSkillUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentSkillUnion.md new file mode 100644 index 0000000..65b9cd1 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentSkillUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionAgentSkillUnion + +# Type Alias: ManagedAgentsSessionAgentSkillUnion + +> **ManagedAgentsSessionAgentSkillUnion** = [`ManagedAgentsQoderSkill`](../interfaces/ManagedAgentsQoderSkill.md) \| [`ManagedAgentsCustomSkill`](../interfaces/ManagedAgentsCustomSkill.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionAgentToolUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentToolUnion.md new file mode 100644 index 0000000..8dcdd97 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentToolUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionAgentToolUnion + +# Type Alias: ManagedAgentsSessionAgentToolUnion + +> **ManagedAgentsSessionAgentToolUnion** = [`ManagedAgentsAgentToolset20260401`](../interfaces/ManagedAgentsAgentToolset20260401.md) \| [`ManagedAgentsMCPToolset`](../interfaces/ManagedAgentsMCPToolset.md) \| [`ManagedAgentsCustomTool`](../interfaces/ManagedAgentsCustomTool.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionAgentToolUnionConfigs.md b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentToolUnionConfigs.md new file mode 100644 index 0000000..34a78f8 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentToolUnionConfigs.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionAgentToolUnionConfigs + +# Type Alias: ManagedAgentsSessionAgentToolUnionConfigs + +> **ManagedAgentsSessionAgentToolUnionConfigs** = [`ManagedAgentsAgentToolConfigUnion`](ManagedAgentsAgentToolConfigUnion.md)[] \| [`ManagedAgentsMCPToolConfig`](../interfaces/ManagedAgentsMCPToolConfig.md)[] diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionAgentType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentType.md new file mode 100644 index 0000000..8647842 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionAgentType + +# Type Alias: ManagedAgentsSessionAgentType + +> **ManagedAgentsSessionAgentType** = `"agent"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionAgentUpdateToolUnionParam.md b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentUpdateToolUnionParam.md new file mode 100644 index 0000000..673c43d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionAgentUpdateToolUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionAgentUpdateToolUnionParam + +# Type Alias: ManagedAgentsSessionAgentUpdateToolUnionParam + +> **ManagedAgentsSessionAgentUpdateToolUnionParam** = [`ManagedAgentsAgentToolset20260401Params`](../interfaces/ManagedAgentsAgentToolset20260401Params.md) \| [`ManagedAgentsMCPToolsetParams`](../interfaces/ManagedAgentsMCPToolsetParams.md) \| [`ManagedAgentsCustomToolParams`](../interfaces/ManagedAgentsCustomToolParams.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionBudgetReachedType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionBudgetReachedType.md new file mode 100644 index 0000000..a750350 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionBudgetReachedType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionBudgetReachedType + +# Type Alias: ManagedAgentsSessionBudgetReachedType + +> **ManagedAgentsSessionBudgetReachedType** = `"budget_reached"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionCreationRejectedRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionCreationRejectedRunErrorType.md new file mode 100644 index 0000000..d0c1ca9 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionCreationRejectedRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionCreationRejectedRunErrorType + +# Type Alias: ManagedAgentsSessionCreationRejectedRunErrorType + +> **ManagedAgentsSessionCreationRejectedRunErrorType** = `"session_creation_rejected_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionDeletedEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionDeletedEventType.md new file mode 100644 index 0000000..f3d1730 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionDeletedEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionDeletedEventType + +# Type Alias: ManagedAgentsSessionDeletedEventType + +> **ManagedAgentsSessionDeletedEventType** = `"session.deleted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionEndTurnType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionEndTurnType.md new file mode 100644 index 0000000..e48f9c3 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionEndTurnType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionEndTurnType + +# Type Alias: ManagedAgentsSessionEndTurnType + +> **ManagedAgentsSessionEndTurnType** = `"end_turn"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionErrorEventErrorUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionErrorEventErrorUnion.md new file mode 100644 index 0000000..0ebf696 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionErrorEventErrorUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionErrorEventErrorUnion + +# Type Alias: ManagedAgentsSessionErrorEventErrorUnion + +> **ManagedAgentsSessionErrorEventErrorUnion** = [`ManagedAgentsUnknownError`](../interfaces/ManagedAgentsUnknownError.md) \| [`ManagedAgentsModelOverloadedError`](../interfaces/ManagedAgentsModelOverloadedError.md) \| [`ManagedAgentsModelRateLimitedError`](../interfaces/ManagedAgentsModelRateLimitedError.md) \| [`ManagedAgentsModelRequestFailedError`](../interfaces/ManagedAgentsModelRequestFailedError.md) \| [`ManagedAgentsMCPConnectionFailedError`](../interfaces/ManagedAgentsMCPConnectionFailedError.md) \| [`ManagedAgentsMCPAuthenticationFailedError`](../interfaces/ManagedAgentsMCPAuthenticationFailedError.md) \| [`ManagedAgentsBillingError`](../interfaces/ManagedAgentsBillingError.md) \| [`ManagedAgentsCredentialHostUnreachableError`](../interfaces/ManagedAgentsCredentialHostUnreachableError.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionErrorEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionErrorEventType.md new file mode 100644 index 0000000..2aa2e50 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionErrorEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionErrorEventType + +# Type Alias: ManagedAgentsSessionErrorEventType + +> **ManagedAgentsSessionErrorEventType** = `"session.error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionEventUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionEventUnion.md new file mode 100644 index 0000000..600a212 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionEventUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionEventUnion + +# Type Alias: ManagedAgentsSessionEventUnion + +> **ManagedAgentsSessionEventUnion** = [`ManagedAgentsUserMessageEvent`](../interfaces/ManagedAgentsUserMessageEvent.md) \| [`ManagedAgentsUserInterruptEvent`](../interfaces/ManagedAgentsUserInterruptEvent.md) \| [`ManagedAgentsUserToolConfirmationEvent`](../interfaces/ManagedAgentsUserToolConfirmationEvent.md) \| [`ManagedAgentsUserCustomToolResultEvent`](../interfaces/ManagedAgentsUserCustomToolResultEvent.md) \| [`ManagedAgentsAgentCustomToolUseEvent`](../interfaces/ManagedAgentsAgentCustomToolUseEvent.md) \| [`ManagedAgentsAgentMessageEvent`](../interfaces/ManagedAgentsAgentMessageEvent.md) \| [`ManagedAgentsAgentThinkingEvent`](../interfaces/ManagedAgentsAgentThinkingEvent.md) \| [`ManagedAgentsAgentMCPToolUseEvent`](../interfaces/ManagedAgentsAgentMCPToolUseEvent.md) \| [`ManagedAgentsAgentMCPToolResultEvent`](../interfaces/ManagedAgentsAgentMCPToolResultEvent.md) \| [`ManagedAgentsAgentToolUseEvent`](../interfaces/ManagedAgentsAgentToolUseEvent.md) \| [`ManagedAgentsAgentToolResultEvent`](../interfaces/ManagedAgentsAgentToolResultEvent.md) \| [`ManagedAgentsAgentThreadMessageReceivedEvent`](../interfaces/ManagedAgentsAgentThreadMessageReceivedEvent.md) \| [`ManagedAgentsAgentThreadMessageSentEvent`](../interfaces/ManagedAgentsAgentThreadMessageSentEvent.md) \| [`ManagedAgentsAgentThreadContextCompactedEvent`](../interfaces/ManagedAgentsAgentThreadContextCompactedEvent.md) \| [`ManagedAgentsSessionErrorEvent`](../interfaces/ManagedAgentsSessionErrorEvent.md) \| [`ManagedAgentsSessionStatusRescheduledEvent`](../interfaces/ManagedAgentsSessionStatusRescheduledEvent.md) \| [`ManagedAgentsSessionStatusRunningEvent`](../interfaces/ManagedAgentsSessionStatusRunningEvent.md) \| [`ManagedAgentsSessionStatusIdleEvent`](../interfaces/ManagedAgentsSessionStatusIdleEvent.md) \| [`ManagedAgentsSessionStatusTerminatedEvent`](../interfaces/ManagedAgentsSessionStatusTerminatedEvent.md) \| [`ManagedAgentsSessionThreadCreatedEvent`](../interfaces/ManagedAgentsSessionThreadCreatedEvent.md) \| [`ManagedAgentsSpanOutcomeEvaluationStartEvent`](../interfaces/ManagedAgentsSpanOutcomeEvaluationStartEvent.md) \| [`ManagedAgentsSpanOutcomeEvaluationEndEvent`](../interfaces/ManagedAgentsSpanOutcomeEvaluationEndEvent.md) \| [`ManagedAgentsSpanModelRequestStartEvent`](../interfaces/ManagedAgentsSpanModelRequestStartEvent.md) \| [`ManagedAgentsSpanModelRequestEndEvent`](../interfaces/ManagedAgentsSpanModelRequestEndEvent.md) \| [`ManagedAgentsSpanOutcomeEvaluationOngoingEvent`](../interfaces/ManagedAgentsSpanOutcomeEvaluationOngoingEvent.md) \| [`ManagedAgentsUserDefineOutcomeEvent`](../interfaces/ManagedAgentsUserDefineOutcomeEvent.md) \| [`ManagedAgentsSessionDeletedEvent`](../interfaces/ManagedAgentsSessionDeletedEvent.md) \| [`ManagedAgentsSessionThreadStatusRunningEvent`](../interfaces/ManagedAgentsSessionThreadStatusRunningEvent.md) \| [`ManagedAgentsSessionThreadStatusIdleEvent`](../interfaces/ManagedAgentsSessionThreadStatusIdleEvent.md) \| [`ManagedAgentsSessionThreadStatusTerminatedEvent`](../interfaces/ManagedAgentsSessionThreadStatusTerminatedEvent.md) \| [`ManagedAgentsUserToolResultEvent`](../interfaces/ManagedAgentsUserToolResultEvent.md) \| [`ManagedAgentsSessionThreadStatusRescheduledEvent`](../interfaces/ManagedAgentsSessionThreadStatusRescheduledEvent.md) \| [`ManagedAgentsSessionUpdatedEvent`](../interfaces/ManagedAgentsSessionUpdatedEvent.md) \| [`ManagedAgentsSystemMessageEvent`](../interfaces/ManagedAgentsSystemMessageEvent.md) \| [`ManagedAgentsSessionUsageEvent`](../interfaces/ManagedAgentsSessionUsageEvent.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionEventUnionContent.md b/docs/api/managed/type-aliases/ManagedAgentsSessionEventUnionContent.md new file mode 100644 index 0000000..33b2f89 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionEventUnionContent.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionEventUnionContent + +# Type Alias: ManagedAgentsSessionEventUnionContent + +> **ManagedAgentsSessionEventUnionContent** = [`ManagedAgentsUserMessageEventContentUnion`](ManagedAgentsUserMessageEventContentUnion.md)[] \| [`ManagedAgentsUserCustomToolResultEventContentUnion`](ManagedAgentsUserCustomToolResultEventContentUnion.md)[] \| [`ManagedAgentsAgentMessageEventContentUnion`](ManagedAgentsAgentMessageEventContentUnion.md)[] \| [`ManagedAgentsAgentMCPToolResultEventContentUnion`](ManagedAgentsAgentMCPToolResultEventContentUnion.md)[] \| [`ManagedAgentsAgentToolResultEventContentUnion`](ManagedAgentsAgentToolResultEventContentUnion.md)[] \| [`ManagedAgentsAgentThreadMessageReceivedEventContentUnion`](ManagedAgentsAgentThreadMessageReceivedEventContentUnion.md)[] \| [`ManagedAgentsAgentThreadMessageSentEventContentUnion`](ManagedAgentsAgentThreadMessageSentEventContentUnion.md)[] \| [`ManagedAgentsUserToolResultEventContentUnion`](ManagedAgentsUserToolResultEventContentUnion.md)[] \| [`ManagedAgentsSystemContentBlock`](../interfaces/ManagedAgentsSystemContentBlock.md)[] diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnion.md new file mode 100644 index 0000000..1646bc4 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionMultiagentCoordinatorAgentUnion + +# Type Alias: ManagedAgentsSessionMultiagentCoordinatorAgentUnion + +> **ManagedAgentsSessionMultiagentCoordinatorAgentUnion** = [`ManagedAgentsSessionThreadAgent`](../interfaces/ManagedAgentsSessionThreadAgent.md) \| [`ManagedAgentsAdvisor`](../interfaces/ManagedAgentsAdvisor.md) + +ManagedAgentsSessionMultiagentCoordinatorAgentUnion contains all possible +properties and values from `ManagedAgentsSessionThreadAgent`, +`ManagedAgentsAdvisor`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel.md b/docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel.md new file mode 100644 index 0000000..73d9860 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel.md @@ -0,0 +1,48 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel + +# Type Alias: ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel + +> **ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel** = `string` \| \{ `effort?`: [`ManagedAgentsModelConfigEffortUnion`](ManagedAgentsModelConfigEffortUnion.md); `id?`: [`ManagedAgentsModel`](ManagedAgentsModel.md); `inference_geo?`: `string`; `speed?`: [`ManagedAgentsModelConfigSpeed`](ManagedAgentsModelConfigSpeed.md); \} + +ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel is an implicit +subunion of `ManagedAgentsSessionMultiagentCoordinatorAgentUnion`. +ManagedAgentsSessionMultiagentCoordinatorAgentUnionModel provides convenient +access to the sub-properties of the union. + +## Union Members + +`string` + +*** + +### Type Literal + +\{ `effort?`: [`ManagedAgentsModelConfigEffortUnion`](ManagedAgentsModelConfigEffortUnion.md); `id?`: [`ManagedAgentsModel`](ManagedAgentsModel.md); `inference_geo?`: `string`; `speed?`: [`ManagedAgentsModelConfigSpeed`](ManagedAgentsModelConfigSpeed.md); \} + +#### effort? + +> `optional` **effort?**: [`ManagedAgentsModelConfigEffortUnion`](ManagedAgentsModelConfigEffortUnion.md) + +This field is from variant `ManagedAgentsModelConfig`. + +#### id? + +> `optional` **id?**: [`ManagedAgentsModel`](ManagedAgentsModel.md) + +This field is from variant `ManagedAgentsModelConfig`. + +#### inference\_geo? + +> `optional` **inference\_geo?**: `string` + +This field is from variant `ManagedAgentsModelConfig`. + +#### speed? + +> `optional` **speed?**: [`ManagedAgentsModelConfigSpeed`](ManagedAgentsModelConfigSpeed.md) + +This field is from variant `ManagedAgentsModelConfig`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorType.md new file mode 100644 index 0000000..7b86485 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionMultiagentCoordinatorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionMultiagentCoordinatorType + +# Type Alias: ManagedAgentsSessionMultiagentCoordinatorType + +> **ManagedAgentsSessionMultiagentCoordinatorType** = `"coordinator"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionRateLimitedRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionRateLimitedRunErrorType.md new file mode 100644 index 0000000..acbc4e3 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionRateLimitedRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionRateLimitedRunErrorType + +# Type Alias: ManagedAgentsSessionRateLimitedRunErrorType + +> **ManagedAgentsSessionRateLimitedRunErrorType** = `"session_rate_limited_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionRequiresActionType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionRequiresActionType.md new file mode 100644 index 0000000..d52a821 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionRequiresActionType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionRequiresActionType + +# Type Alias: ManagedAgentsSessionRequiresActionType + +> **ManagedAgentsSessionRequiresActionType** = `"requires_action"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionResourceConfigUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionResourceConfigUnion.md new file mode 100644 index 0000000..1f61341 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionResourceConfigUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionResourceConfigUnion + +# Type Alias: ManagedAgentsSessionResourceConfigUnion + +> **ManagedAgentsSessionResourceConfigUnion** = [`ManagedAgentsGitHubRepositoryResourceConfig`](../interfaces/ManagedAgentsGitHubRepositoryResourceConfig.md) \| [`ManagedAgentsFileResourceConfig`](../interfaces/ManagedAgentsFileResourceConfig.md) \| [`ManagedAgentsMemoryStoreResourceConfig`](../interfaces/ManagedAgentsMemoryStoreResourceConfig.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..a790a3f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorType + +> **ManagedAgentsSessionResourceNotFoundDeploymentPausedReasonErrorType** = `"session_resource_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionResourceNotFoundRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionResourceNotFoundRunErrorType.md new file mode 100644 index 0000000..14a27f9 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionResourceNotFoundRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionResourceNotFoundRunErrorType + +# Type Alias: ManagedAgentsSessionResourceNotFoundRunErrorType + +> **ManagedAgentsSessionResourceNotFoundRunErrorType** = `"session_resource_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionResourceUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionResourceUnion.md new file mode 100644 index 0000000..bf46e17 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionResourceUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionResourceUnion + +# Type Alias: ManagedAgentsSessionResourceUnion + +> **ManagedAgentsSessionResourceUnion** = [`ManagedAgentsGitHubRepositoryResource`](../interfaces/ManagedAgentsGitHubRepositoryResource.md) \| [`ManagedAgentsFileResource`](../interfaces/ManagedAgentsFileResource.md) \| [`ManagedAgentsMemoryStoreResource`](../interfaces/ManagedAgentsMemoryStoreResource.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionRetriesExhaustedType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionRetriesExhaustedType.md new file mode 100644 index 0000000..1999de4 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionRetriesExhaustedType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionRetriesExhaustedType + +# Type Alias: ManagedAgentsSessionRetriesExhaustedType + +> **ManagedAgentsSessionRetriesExhaustedType** = `"retries_exhausted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionStatus.md b/docs/api/managed/type-aliases/ManagedAgentsSessionStatus.md new file mode 100644 index 0000000..c40eac3 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionStatus.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatus + +# Type Alias: ManagedAgentsSessionStatus + +> **ManagedAgentsSessionStatus** = `"rescheduling"` \| `"running"` \| `"idle"` \| `"terminated"` + +SessionStatus enum diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionStatusIdleEventStopReasonUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusIdleEventStopReasonUnion.md new file mode 100644 index 0000000..4f3015e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusIdleEventStopReasonUnion.md @@ -0,0 +1,15 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatusIdleEventStopReasonUnion + +# Type Alias: ManagedAgentsSessionStatusIdleEventStopReasonUnion + +> **ManagedAgentsSessionStatusIdleEventStopReasonUnion** = [`ManagedAgentsSessionEndTurn`](../interfaces/ManagedAgentsSessionEndTurn.md) \| [`ManagedAgentsSessionRequiresAction`](../interfaces/ManagedAgentsSessionRequiresAction.md) \| [`ManagedAgentsSessionRetriesExhausted`](../interfaces/ManagedAgentsSessionRetriesExhausted.md) \| [`ManagedAgentsSessionBudgetReached`](../interfaces/ManagedAgentsSessionBudgetReached.md) + +ManagedAgentsSessionStatusIdleEventStopReasonUnion contains all possible +properties and values from `ManagedAgentsSessionEndTurn`, +`ManagedAgentsSessionRequiresAction`, +`ManagedAgentsSessionRetriesExhausted`, +`ManagedAgentsSessionBudgetReached`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionStatusIdleEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusIdleEventType.md new file mode 100644 index 0000000..8833beb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusIdleEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatusIdleEventType + +# Type Alias: ManagedAgentsSessionStatusIdleEventType + +> **ManagedAgentsSessionStatusIdleEventType** = `"session.status_idle"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionStatusRescheduledEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusRescheduledEventType.md new file mode 100644 index 0000000..9081f64 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusRescheduledEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatusRescheduledEventType + +# Type Alias: ManagedAgentsSessionStatusRescheduledEventType + +> **ManagedAgentsSessionStatusRescheduledEventType** = `"session.status_rescheduled"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionStatusRunningEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusRunningEventType.md new file mode 100644 index 0000000..2baf6fe --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusRunningEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatusRunningEventType + +# Type Alias: ManagedAgentsSessionStatusRunningEventType + +> **ManagedAgentsSessionStatusRunningEventType** = `"session.status_running"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionStatusTerminatedEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusTerminatedEventType.md new file mode 100644 index 0000000..9b34504 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionStatusTerminatedEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionStatusTerminatedEventType + +# Type Alias: ManagedAgentsSessionStatusTerminatedEventType + +> **ManagedAgentsSessionStatusTerminatedEventType** = `"session.status_terminated"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentSkillUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentSkillUnion.md new file mode 100644 index 0000000..2b26ead --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentSkillUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadAgentSkillUnion + +# Type Alias: ManagedAgentsSessionThreadAgentSkillUnion + +> **ManagedAgentsSessionThreadAgentSkillUnion** = [`ManagedAgentsQoderSkill`](../interfaces/ManagedAgentsQoderSkill.md) \| [`ManagedAgentsCustomSkill`](../interfaces/ManagedAgentsCustomSkill.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentToolUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentToolUnion.md new file mode 100644 index 0000000..9ba5ea3 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentToolUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadAgentToolUnion + +# Type Alias: ManagedAgentsSessionThreadAgentToolUnion + +> **ManagedAgentsSessionThreadAgentToolUnion** = [`ManagedAgentsAgentToolset20260401`](../interfaces/ManagedAgentsAgentToolset20260401.md) \| [`ManagedAgentsMCPToolset`](../interfaces/ManagedAgentsMCPToolset.md) \| [`ManagedAgentsCustomTool`](../interfaces/ManagedAgentsCustomTool.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentToolUnionConfigs.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentToolUnionConfigs.md new file mode 100644 index 0000000..b5beabb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentToolUnionConfigs.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadAgentToolUnionConfigs + +# Type Alias: ManagedAgentsSessionThreadAgentToolUnionConfigs + +> **ManagedAgentsSessionThreadAgentToolUnionConfigs** = [`ManagedAgentsAgentToolConfigUnion`](ManagedAgentsAgentToolConfigUnion.md)[] \| [`ManagedAgentsMCPToolConfig`](../interfaces/ManagedAgentsMCPToolConfig.md)[] diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentType.md new file mode 100644 index 0000000..f0aa595 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadAgentType + +# Type Alias: ManagedAgentsSessionThreadAgentType + +> **ManagedAgentsSessionThreadAgentType** = `"agent"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentUnion.md new file mode 100644 index 0000000..a2b73e1 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadAgentUnion + +# Type Alias: ManagedAgentsSessionThreadAgentUnion + +> **ManagedAgentsSessionThreadAgentUnion** = [`ManagedAgentsSessionThreadAgent`](../interfaces/ManagedAgentsSessionThreadAgent.md) \| [`ManagedAgentsAdvisor`](../interfaces/ManagedAgentsAdvisor.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentUnionModel.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentUnionModel.md new file mode 100644 index 0000000..2d92547 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadAgentUnionModel.md @@ -0,0 +1,43 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadAgentUnionModel + +# Type Alias: ManagedAgentsSessionThreadAgentUnionModel + +> **ManagedAgentsSessionThreadAgentUnionModel** = `string` \| \{ `effort?`: [`ManagedAgentsModelConfigEffortUnion`](ManagedAgentsModelConfigEffortUnion.md); `id?`: [`ManagedAgentsModel`](ManagedAgentsModel.md); `inference_geo?`: `string`; `speed?`: [`ManagedAgentsModelConfigSpeed`](ManagedAgentsModelConfigSpeed.md); \} + +## Union Members + +`string` + +*** + +### Type Literal + +\{ `effort?`: [`ManagedAgentsModelConfigEffortUnion`](ManagedAgentsModelConfigEffortUnion.md); `id?`: [`ManagedAgentsModel`](ManagedAgentsModel.md); `inference_geo?`: `string`; `speed?`: [`ManagedAgentsModelConfigSpeed`](ManagedAgentsModelConfigSpeed.md); \} + +#### effort? + +> `optional` **effort?**: [`ManagedAgentsModelConfigEffortUnion`](ManagedAgentsModelConfigEffortUnion.md) + +This field is from variant `ManagedAgentsModelConfig`. + +#### id? + +> `optional` **id?**: [`ManagedAgentsModel`](ManagedAgentsModel.md) + +This field is from variant `ManagedAgentsModelConfig`. + +#### inference\_geo? + +> `optional` **inference\_geo?**: `string` + +This field is from variant `ManagedAgentsModelConfig`. + +#### speed? + +> `optional` **speed?**: [`ManagedAgentsModelConfigSpeed`](ManagedAgentsModelConfigSpeed.md) + +This field is from variant `ManagedAgentsModelConfig`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadCreatedEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadCreatedEventType.md new file mode 100644 index 0000000..15aeedf --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadCreatedEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadCreatedEventType + +# Type Alias: ManagedAgentsSessionThreadCreatedEventType + +> **ManagedAgentsSessionThreadCreatedEventType** = `"session.thread_created"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatus.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatus.md new file mode 100644 index 0000000..c7f70be --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatus.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatus + +# Type Alias: ManagedAgentsSessionThreadStatus + +> **ManagedAgentsSessionThreadStatus** = `"running"` \| `"idle"` \| `"rescheduling"` \| `"terminated"` + +SessionThreadStatus enum diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion.md new file mode 100644 index 0000000..fdedf0d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion.md @@ -0,0 +1,15 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion + +# Type Alias: ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion + +> **ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion** = [`ManagedAgentsSessionEndTurn`](../interfaces/ManagedAgentsSessionEndTurn.md) \| [`ManagedAgentsSessionRequiresAction`](../interfaces/ManagedAgentsSessionRequiresAction.md) \| [`ManagedAgentsSessionRetriesExhausted`](../interfaces/ManagedAgentsSessionRetriesExhausted.md) \| [`ManagedAgentsSessionBudgetReached`](../interfaces/ManagedAgentsSessionBudgetReached.md) + +ManagedAgentsSessionThreadStatusIdleEventStopReasonUnion contains all +possible properties and values from `ManagedAgentsSessionEndTurn`, +`ManagedAgentsSessionRequiresAction`, +`ManagedAgentsSessionRetriesExhausted`, +`ManagedAgentsSessionBudgetReached`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusIdleEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusIdleEventType.md new file mode 100644 index 0000000..d3453ac --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusIdleEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatusIdleEventType + +# Type Alias: ManagedAgentsSessionThreadStatusIdleEventType + +> **ManagedAgentsSessionThreadStatusIdleEventType** = `"session.thread_status_idle"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusRescheduledEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusRescheduledEventType.md new file mode 100644 index 0000000..c303206 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusRescheduledEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatusRescheduledEventType + +# Type Alias: ManagedAgentsSessionThreadStatusRescheduledEventType + +> **ManagedAgentsSessionThreadStatusRescheduledEventType** = `"session.thread_status_rescheduled"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusRunningEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusRunningEventType.md new file mode 100644 index 0000000..e1773ae --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusRunningEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatusRunningEventType + +# Type Alias: ManagedAgentsSessionThreadStatusRunningEventType + +> **ManagedAgentsSessionThreadStatusRunningEventType** = `"session.thread_status_running"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusTerminatedEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusTerminatedEventType.md new file mode 100644 index 0000000..aebfc2f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadStatusTerminatedEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadStatusTerminatedEventType + +# Type Alias: ManagedAgentsSessionThreadStatusTerminatedEventType + +> **ManagedAgentsSessionThreadStatusTerminatedEventType** = `"session.thread_status_terminated"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionThreadType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadType.md new file mode 100644 index 0000000..67701c1 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionThreadType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionThreadType + +# Type Alias: ManagedAgentsSessionThreadType + +> **ManagedAgentsSessionThreadType** = `"session_thread"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionType.md new file mode 100644 index 0000000..f9ef3e3 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionType + +# Type Alias: ManagedAgentsSessionType + +> **ManagedAgentsSessionType** = `"session"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionUpdatedEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionUpdatedEventType.md new file mode 100644 index 0000000..6241968 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionUpdatedEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionUpdatedEventType + +# Type Alias: ManagedAgentsSessionUpdatedEventType + +> **ManagedAgentsSessionUpdatedEventType** = `"session.updated"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSessionUsageEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSessionUsageEventType.md new file mode 100644 index 0000000..bbd8ac2 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSessionUsageEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSessionUsageEventType + +# Type Alias: ManagedAgentsSessionUsageEventType + +> **ManagedAgentsSessionUsageEventType** = `"session.usage"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSkillNotFoundDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsSkillNotFoundDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..bfaab9f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSkillNotFoundDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSkillNotFoundDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsSkillNotFoundDeploymentPausedReasonErrorType + +> **ManagedAgentsSkillNotFoundDeploymentPausedReasonErrorType** = `"skill_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSkillNotFoundRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsSkillNotFoundRunErrorType.md new file mode 100644 index 0000000..10ddcdc --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSkillNotFoundRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSkillNotFoundRunErrorType + +# Type Alias: ManagedAgentsSkillNotFoundRunErrorType + +> **ManagedAgentsSkillNotFoundRunErrorType** = `"skill_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSkillParamsUnion.md b/docs/api/managed/type-aliases/ManagedAgentsSkillParamsUnion.md new file mode 100644 index 0000000..994c0bb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSkillParamsUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSkillParamsUnion + +# Type Alias: ManagedAgentsSkillParamsUnion + +> **ManagedAgentsSkillParamsUnion** = [`ManagedAgentsQoderSkillParams`](../interfaces/ManagedAgentsQoderSkillParams.md) \| [`ManagedAgentsCustomSkillParams`](../interfaces/ManagedAgentsCustomSkillParams.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsSpanModelRequestEndEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSpanModelRequestEndEventType.md new file mode 100644 index 0000000..de14dc5 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSpanModelRequestEndEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanModelRequestEndEventType + +# Type Alias: ManagedAgentsSpanModelRequestEndEventType + +> **ManagedAgentsSpanModelRequestEndEventType** = `"span.model_request_end"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSpanModelRequestStartEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSpanModelRequestStartEventType.md new file mode 100644 index 0000000..609fd73 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSpanModelRequestStartEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanModelRequestStartEventType + +# Type Alias: ManagedAgentsSpanModelRequestStartEventType + +> **ManagedAgentsSpanModelRequestStartEventType** = `"span.model_request_start"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSpanModelUsageSpeed.md b/docs/api/managed/type-aliases/ManagedAgentsSpanModelUsageSpeed.md new file mode 100644 index 0000000..3b805a4 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSpanModelUsageSpeed.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanModelUsageSpeed + +# Type Alias: ManagedAgentsSpanModelUsageSpeed + +> **ManagedAgentsSpanModelUsageSpeed** = `"standard"` \| `"fast"` + +Inference speed mode. `fast` provides significantly faster output token +generation at premium pricing. Not all models support `fast`; invalid +combinations are rejected at create time. diff --git a/docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationEndEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationEndEventType.md new file mode 100644 index 0000000..b3669f1 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationEndEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanOutcomeEvaluationEndEventType + +# Type Alias: ManagedAgentsSpanOutcomeEvaluationEndEventType + +> **ManagedAgentsSpanOutcomeEvaluationEndEventType** = `"span.outcome_evaluation_end"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationOngoingEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationOngoingEventType.md new file mode 100644 index 0000000..9afd5a7 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationOngoingEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanOutcomeEvaluationOngoingEventType + +# Type Alias: ManagedAgentsSpanOutcomeEvaluationOngoingEventType + +> **ManagedAgentsSpanOutcomeEvaluationOngoingEventType** = `"span.outcome_evaluation_ongoing"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationStartEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationStartEventType.md new file mode 100644 index 0000000..1909f84 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSpanOutcomeEvaluationStartEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSpanOutcomeEvaluationStartEventType + +# Type Alias: ManagedAgentsSpanOutcomeEvaluationStartEventType + +> **ManagedAgentsSpanOutcomeEvaluationStartEventType** = `"span.outcome_evaluation_start"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsStartEventPreviewUnion.md b/docs/api/managed/type-aliases/ManagedAgentsStartEventPreviewUnion.md new file mode 100644 index 0000000..cebd4f5 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsStartEventPreviewUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStartEventPreviewUnion + +# Type Alias: ManagedAgentsStartEventPreviewUnion + +> **ManagedAgentsStartEventPreviewUnion** = [`ManagedAgentsAgentMessagePreview`](../interfaces/ManagedAgentsAgentMessagePreview.md) \| [`ManagedAgentsAgentThinkingPreview`](../interfaces/ManagedAgentsAgentThinkingPreview.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsStartEventType.md b/docs/api/managed/type-aliases/ManagedAgentsStartEventType.md new file mode 100644 index 0000000..694f665 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsStartEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStartEventType + +# Type Alias: ManagedAgentsStartEventType + +> **ManagedAgentsStartEventType** = `"event_start"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsStaticBearerAuthResponseType.md b/docs/api/managed/type-aliases/ManagedAgentsStaticBearerAuthResponseType.md new file mode 100644 index 0000000..13426ea --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsStaticBearerAuthResponseType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStaticBearerAuthResponseType + +# Type Alias: ManagedAgentsStaticBearerAuthResponseType + +> **ManagedAgentsStaticBearerAuthResponseType** = `"static_bearer"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsStaticBearerCreateParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsStaticBearerCreateParamsType.md new file mode 100644 index 0000000..077b108 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsStaticBearerCreateParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStaticBearerCreateParamsType + +# Type Alias: ManagedAgentsStaticBearerCreateParamsType + +> **ManagedAgentsStaticBearerCreateParamsType** = `"static_bearer"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsStaticBearerUpdateParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsStaticBearerUpdateParamsType.md new file mode 100644 index 0000000..953ac44 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsStaticBearerUpdateParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStaticBearerUpdateParamsType + +# Type Alias: ManagedAgentsStaticBearerUpdateParamsType + +> **ManagedAgentsStaticBearerUpdateParamsType** = `"static_bearer"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsStreamSessionEventsUnion.md b/docs/api/managed/type-aliases/ManagedAgentsStreamSessionEventsUnion.md new file mode 100644 index 0000000..65e9e7f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsStreamSessionEventsUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStreamSessionEventsUnion + +# Type Alias: ManagedAgentsStreamSessionEventsUnion + +> **ManagedAgentsStreamSessionEventsUnion** = [`ManagedAgentsUserMessageEvent`](../interfaces/ManagedAgentsUserMessageEvent.md) \| [`ManagedAgentsUserInterruptEvent`](../interfaces/ManagedAgentsUserInterruptEvent.md) \| [`ManagedAgentsUserToolConfirmationEvent`](../interfaces/ManagedAgentsUserToolConfirmationEvent.md) \| [`ManagedAgentsUserCustomToolResultEvent`](../interfaces/ManagedAgentsUserCustomToolResultEvent.md) \| [`ManagedAgentsAgentCustomToolUseEvent`](../interfaces/ManagedAgentsAgentCustomToolUseEvent.md) \| [`ManagedAgentsAgentMessageEvent`](../interfaces/ManagedAgentsAgentMessageEvent.md) \| [`ManagedAgentsAgentThinkingEvent`](../interfaces/ManagedAgentsAgentThinkingEvent.md) \| [`ManagedAgentsAgentMCPToolUseEvent`](../interfaces/ManagedAgentsAgentMCPToolUseEvent.md) \| [`ManagedAgentsAgentMCPToolResultEvent`](../interfaces/ManagedAgentsAgentMCPToolResultEvent.md) \| [`ManagedAgentsAgentToolUseEvent`](../interfaces/ManagedAgentsAgentToolUseEvent.md) \| [`ManagedAgentsAgentToolResultEvent`](../interfaces/ManagedAgentsAgentToolResultEvent.md) \| [`ManagedAgentsAgentThreadMessageReceivedEvent`](../interfaces/ManagedAgentsAgentThreadMessageReceivedEvent.md) \| [`ManagedAgentsAgentThreadMessageSentEvent`](../interfaces/ManagedAgentsAgentThreadMessageSentEvent.md) \| [`ManagedAgentsAgentThreadContextCompactedEvent`](../interfaces/ManagedAgentsAgentThreadContextCompactedEvent.md) \| [`ManagedAgentsSessionErrorEvent`](../interfaces/ManagedAgentsSessionErrorEvent.md) \| [`ManagedAgentsSessionStatusRescheduledEvent`](../interfaces/ManagedAgentsSessionStatusRescheduledEvent.md) \| [`ManagedAgentsSessionStatusRunningEvent`](../interfaces/ManagedAgentsSessionStatusRunningEvent.md) \| [`ManagedAgentsSessionStatusIdleEvent`](../interfaces/ManagedAgentsSessionStatusIdleEvent.md) \| [`ManagedAgentsSessionStatusTerminatedEvent`](../interfaces/ManagedAgentsSessionStatusTerminatedEvent.md) \| [`ManagedAgentsSessionThreadCreatedEvent`](../interfaces/ManagedAgentsSessionThreadCreatedEvent.md) \| [`ManagedAgentsSpanOutcomeEvaluationStartEvent`](../interfaces/ManagedAgentsSpanOutcomeEvaluationStartEvent.md) \| [`ManagedAgentsSpanOutcomeEvaluationEndEvent`](../interfaces/ManagedAgentsSpanOutcomeEvaluationEndEvent.md) \| [`ManagedAgentsSpanModelRequestStartEvent`](../interfaces/ManagedAgentsSpanModelRequestStartEvent.md) \| [`ManagedAgentsSpanModelRequestEndEvent`](../interfaces/ManagedAgentsSpanModelRequestEndEvent.md) \| [`ManagedAgentsSpanOutcomeEvaluationOngoingEvent`](../interfaces/ManagedAgentsSpanOutcomeEvaluationOngoingEvent.md) \| [`ManagedAgentsUserDefineOutcomeEvent`](../interfaces/ManagedAgentsUserDefineOutcomeEvent.md) \| [`ManagedAgentsSessionDeletedEvent`](../interfaces/ManagedAgentsSessionDeletedEvent.md) \| [`ManagedAgentsSessionThreadStatusRunningEvent`](../interfaces/ManagedAgentsSessionThreadStatusRunningEvent.md) \| [`ManagedAgentsSessionThreadStatusIdleEvent`](../interfaces/ManagedAgentsSessionThreadStatusIdleEvent.md) \| [`ManagedAgentsSessionThreadStatusTerminatedEvent`](../interfaces/ManagedAgentsSessionThreadStatusTerminatedEvent.md) \| [`ManagedAgentsUserToolResultEvent`](../interfaces/ManagedAgentsUserToolResultEvent.md) \| [`ManagedAgentsSessionThreadStatusRescheduledEvent`](../interfaces/ManagedAgentsSessionThreadStatusRescheduledEvent.md) \| [`ManagedAgentsSessionUpdatedEvent`](../interfaces/ManagedAgentsSessionUpdatedEvent.md) \| [`ManagedAgentsStartEvent`](../interfaces/ManagedAgentsStartEvent.md) \| [`ManagedAgentsDeltaEvent`](../interfaces/ManagedAgentsDeltaEvent.md) \| [`ManagedAgentsSystemMessageEvent`](../interfaces/ManagedAgentsSystemMessageEvent.md) \| [`ManagedAgentsSessionUsageEvent`](../interfaces/ManagedAgentsSessionUsageEvent.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsStreamSessionEventsUnionContent.md b/docs/api/managed/type-aliases/ManagedAgentsStreamSessionEventsUnionContent.md new file mode 100644 index 0000000..ffe1c00 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsStreamSessionEventsUnionContent.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStreamSessionEventsUnionContent + +# Type Alias: ManagedAgentsStreamSessionEventsUnionContent + +> **ManagedAgentsStreamSessionEventsUnionContent** = [`ManagedAgentsUserMessageEventContentUnion`](ManagedAgentsUserMessageEventContentUnion.md)[] \| [`ManagedAgentsUserCustomToolResultEventContentUnion`](ManagedAgentsUserCustomToolResultEventContentUnion.md)[] \| [`ManagedAgentsAgentMessageEventContentUnion`](ManagedAgentsAgentMessageEventContentUnion.md)[] \| [`ManagedAgentsAgentMCPToolResultEventContentUnion`](ManagedAgentsAgentMCPToolResultEventContentUnion.md)[] \| [`ManagedAgentsAgentToolResultEventContentUnion`](ManagedAgentsAgentToolResultEventContentUnion.md)[] \| [`ManagedAgentsAgentThreadMessageReceivedEventContentUnion`](ManagedAgentsAgentThreadMessageReceivedEventContentUnion.md)[] \| [`ManagedAgentsAgentThreadMessageSentEventContentUnion`](ManagedAgentsAgentThreadMessageSentEventContentUnion.md)[] \| [`ManagedAgentsUserToolResultEventContentUnion`](ManagedAgentsUserToolResultEventContentUnion.md)[] \| [`ManagedAgentsSystemContentBlock`](../interfaces/ManagedAgentsSystemContentBlock.md)[] diff --git a/docs/api/managed/type-aliases/ManagedAgentsStreamSessionThreadEventsUnion.md b/docs/api/managed/type-aliases/ManagedAgentsStreamSessionThreadEventsUnion.md new file mode 100644 index 0000000..dc07344 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsStreamSessionThreadEventsUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStreamSessionThreadEventsUnion + +# Type Alias: ManagedAgentsStreamSessionThreadEventsUnion + +> **ManagedAgentsStreamSessionThreadEventsUnion** = [`ManagedAgentsUserMessageEvent`](../interfaces/ManagedAgentsUserMessageEvent.md) \| [`ManagedAgentsUserInterruptEvent`](../interfaces/ManagedAgentsUserInterruptEvent.md) \| [`ManagedAgentsUserToolConfirmationEvent`](../interfaces/ManagedAgentsUserToolConfirmationEvent.md) \| [`ManagedAgentsUserCustomToolResultEvent`](../interfaces/ManagedAgentsUserCustomToolResultEvent.md) \| [`ManagedAgentsAgentCustomToolUseEvent`](../interfaces/ManagedAgentsAgentCustomToolUseEvent.md) \| [`ManagedAgentsAgentMessageEvent`](../interfaces/ManagedAgentsAgentMessageEvent.md) \| [`ManagedAgentsAgentThinkingEvent`](../interfaces/ManagedAgentsAgentThinkingEvent.md) \| [`ManagedAgentsAgentMCPToolUseEvent`](../interfaces/ManagedAgentsAgentMCPToolUseEvent.md) \| [`ManagedAgentsAgentMCPToolResultEvent`](../interfaces/ManagedAgentsAgentMCPToolResultEvent.md) \| [`ManagedAgentsAgentToolUseEvent`](../interfaces/ManagedAgentsAgentToolUseEvent.md) \| [`ManagedAgentsAgentToolResultEvent`](../interfaces/ManagedAgentsAgentToolResultEvent.md) \| [`ManagedAgentsAgentThreadMessageReceivedEvent`](../interfaces/ManagedAgentsAgentThreadMessageReceivedEvent.md) \| [`ManagedAgentsAgentThreadMessageSentEvent`](../interfaces/ManagedAgentsAgentThreadMessageSentEvent.md) \| [`ManagedAgentsAgentThreadContextCompactedEvent`](../interfaces/ManagedAgentsAgentThreadContextCompactedEvent.md) \| [`ManagedAgentsSessionErrorEvent`](../interfaces/ManagedAgentsSessionErrorEvent.md) \| [`ManagedAgentsSessionStatusRescheduledEvent`](../interfaces/ManagedAgentsSessionStatusRescheduledEvent.md) \| [`ManagedAgentsSessionStatusRunningEvent`](../interfaces/ManagedAgentsSessionStatusRunningEvent.md) \| [`ManagedAgentsSessionStatusIdleEvent`](../interfaces/ManagedAgentsSessionStatusIdleEvent.md) \| [`ManagedAgentsSessionStatusTerminatedEvent`](../interfaces/ManagedAgentsSessionStatusTerminatedEvent.md) \| [`ManagedAgentsSessionThreadCreatedEvent`](../interfaces/ManagedAgentsSessionThreadCreatedEvent.md) \| [`ManagedAgentsSpanOutcomeEvaluationStartEvent`](../interfaces/ManagedAgentsSpanOutcomeEvaluationStartEvent.md) \| [`ManagedAgentsSpanOutcomeEvaluationEndEvent`](../interfaces/ManagedAgentsSpanOutcomeEvaluationEndEvent.md) \| [`ManagedAgentsSpanModelRequestStartEvent`](../interfaces/ManagedAgentsSpanModelRequestStartEvent.md) \| [`ManagedAgentsSpanModelRequestEndEvent`](../interfaces/ManagedAgentsSpanModelRequestEndEvent.md) \| [`ManagedAgentsSpanOutcomeEvaluationOngoingEvent`](../interfaces/ManagedAgentsSpanOutcomeEvaluationOngoingEvent.md) \| [`ManagedAgentsUserDefineOutcomeEvent`](../interfaces/ManagedAgentsUserDefineOutcomeEvent.md) \| [`ManagedAgentsSessionDeletedEvent`](../interfaces/ManagedAgentsSessionDeletedEvent.md) \| [`ManagedAgentsSessionThreadStatusRunningEvent`](../interfaces/ManagedAgentsSessionThreadStatusRunningEvent.md) \| [`ManagedAgentsSessionThreadStatusIdleEvent`](../interfaces/ManagedAgentsSessionThreadStatusIdleEvent.md) \| [`ManagedAgentsSessionThreadStatusTerminatedEvent`](../interfaces/ManagedAgentsSessionThreadStatusTerminatedEvent.md) \| [`ManagedAgentsUserToolResultEvent`](../interfaces/ManagedAgentsUserToolResultEvent.md) \| [`ManagedAgentsSessionThreadStatusRescheduledEvent`](../interfaces/ManagedAgentsSessionThreadStatusRescheduledEvent.md) \| [`ManagedAgentsSessionUpdatedEvent`](../interfaces/ManagedAgentsSessionUpdatedEvent.md) \| [`ManagedAgentsStartEvent`](../interfaces/ManagedAgentsStartEvent.md) \| [`ManagedAgentsDeltaEvent`](../interfaces/ManagedAgentsDeltaEvent.md) \| [`ManagedAgentsSystemMessageEvent`](../interfaces/ManagedAgentsSystemMessageEvent.md) \| [`ManagedAgentsSessionUsageEvent`](../interfaces/ManagedAgentsSessionUsageEvent.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsStreamSessionThreadEventsUnionContent.md b/docs/api/managed/type-aliases/ManagedAgentsStreamSessionThreadEventsUnionContent.md new file mode 100644 index 0000000..a9ce95b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsStreamSessionThreadEventsUnionContent.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsStreamSessionThreadEventsUnionContent + +# Type Alias: ManagedAgentsStreamSessionThreadEventsUnionContent + +> **ManagedAgentsStreamSessionThreadEventsUnionContent** = [`ManagedAgentsUserMessageEventContentUnion`](ManagedAgentsUserMessageEventContentUnion.md)[] \| [`ManagedAgentsUserCustomToolResultEventContentUnion`](ManagedAgentsUserCustomToolResultEventContentUnion.md)[] \| [`ManagedAgentsAgentMessageEventContentUnion`](ManagedAgentsAgentMessageEventContentUnion.md)[] \| [`ManagedAgentsAgentMCPToolResultEventContentUnion`](ManagedAgentsAgentMCPToolResultEventContentUnion.md)[] \| [`ManagedAgentsAgentToolResultEventContentUnion`](ManagedAgentsAgentToolResultEventContentUnion.md)[] \| [`ManagedAgentsAgentThreadMessageReceivedEventContentUnion`](ManagedAgentsAgentThreadMessageReceivedEventContentUnion.md)[] \| [`ManagedAgentsAgentThreadMessageSentEventContentUnion`](ManagedAgentsAgentThreadMessageSentEventContentUnion.md)[] \| [`ManagedAgentsUserToolResultEventContentUnion`](ManagedAgentsUserToolResultEventContentUnion.md)[] \| [`ManagedAgentsSystemContentBlock`](../interfaces/ManagedAgentsSystemContentBlock.md)[] diff --git a/docs/api/managed/type-aliases/ManagedAgentsSystemContentBlockType.md b/docs/api/managed/type-aliases/ManagedAgentsSystemContentBlockType.md new file mode 100644 index 0000000..cace04a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSystemContentBlockType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSystemContentBlockType + +# Type Alias: ManagedAgentsSystemContentBlockType + +> **ManagedAgentsSystemContentBlockType** = `"text"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSystemMessageEventParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsSystemMessageEventParamsType.md new file mode 100644 index 0000000..c420ea8 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSystemMessageEventParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSystemMessageEventParamsType + +# Type Alias: ManagedAgentsSystemMessageEventParamsType + +> **ManagedAgentsSystemMessageEventParamsType** = `"system.message"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsSystemMessageEventType.md b/docs/api/managed/type-aliases/ManagedAgentsSystemMessageEventType.md new file mode 100644 index 0000000..cfa4deb --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsSystemMessageEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsSystemMessageEventType + +# Type Alias: ManagedAgentsSystemMessageEventType + +> **ManagedAgentsSystemMessageEventType** = `"system.message"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTextBlockType.md b/docs/api/managed/type-aliases/ManagedAgentsTextBlockType.md new file mode 100644 index 0000000..2eebe88 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTextBlockType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTextBlockType + +# Type Alias: ManagedAgentsTextBlockType + +> **ManagedAgentsTextBlockType** = `"text"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTextRubricParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsTextRubricParamsType.md new file mode 100644 index 0000000..cc78d59 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTextRubricParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTextRubricParamsType + +# Type Alias: ManagedAgentsTextRubricParamsType + +> **ManagedAgentsTextRubricParamsType** = `"text"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTextRubricType.md b/docs/api/managed/type-aliases/ManagedAgentsTextRubricType.md new file mode 100644 index 0000000..c1f9dde --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTextRubricType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTextRubricType + +# Type Alias: ManagedAgentsTextRubricType + +> **ManagedAgentsTextRubricType** = `"text"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicParamType.md b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicParamType.md new file mode 100644 index 0000000..ef6f7ce --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicParamType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthBasicParamType + +# Type Alias: ManagedAgentsTokenEndpointAuthBasicParamType + +> **ManagedAgentsTokenEndpointAuthBasicParamType** = `"client_secret_basic"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicResponseType.md b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicResponseType.md new file mode 100644 index 0000000..792ff44 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicResponseType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthBasicResponseType + +# Type Alias: ManagedAgentsTokenEndpointAuthBasicResponseType + +> **ManagedAgentsTokenEndpointAuthBasicResponseType** = `"client_secret_basic"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicUpdateParamType.md b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicUpdateParamType.md new file mode 100644 index 0000000..4ed014f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthBasicUpdateParamType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthBasicUpdateParamType + +# Type Alias: ManagedAgentsTokenEndpointAuthBasicUpdateParamType + +> **ManagedAgentsTokenEndpointAuthBasicUpdateParamType** = `"client_secret_basic"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthNoneParamType.md b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthNoneParamType.md new file mode 100644 index 0000000..f69e72c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthNoneParamType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthNoneParamType + +# Type Alias: ManagedAgentsTokenEndpointAuthNoneParamType + +> **ManagedAgentsTokenEndpointAuthNoneParamType** = `"none"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthNoneResponseType.md b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthNoneResponseType.md new file mode 100644 index 0000000..ebec2da --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthNoneResponseType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthNoneResponseType + +# Type Alias: ManagedAgentsTokenEndpointAuthNoneResponseType + +> **ManagedAgentsTokenEndpointAuthNoneResponseType** = `"none"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostParamType.md b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostParamType.md new file mode 100644 index 0000000..a9ce604 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostParamType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthPostParamType + +# Type Alias: ManagedAgentsTokenEndpointAuthPostParamType + +> **ManagedAgentsTokenEndpointAuthPostParamType** = `"client_secret_post"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostResponseType.md b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostResponseType.md new file mode 100644 index 0000000..5886917 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostResponseType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthPostResponseType + +# Type Alias: ManagedAgentsTokenEndpointAuthPostResponseType + +> **ManagedAgentsTokenEndpointAuthPostResponseType** = `"client_secret_post"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostUpdateParamType.md b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostUpdateParamType.md new file mode 100644 index 0000000..4cc263a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTokenEndpointAuthPostUpdateParamType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTokenEndpointAuthPostUpdateParamType + +# Type Alias: ManagedAgentsTokenEndpointAuthPostUpdateParamType + +> **ManagedAgentsTokenEndpointAuthPostUpdateParamType** = `"client_secret_post"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsTriggerContextUnion.md b/docs/api/managed/type-aliases/ManagedAgentsTriggerContextUnion.md new file mode 100644 index 0000000..3cb075c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTriggerContextUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTriggerContextUnion + +# Type Alias: ManagedAgentsTriggerContextUnion + +> **ManagedAgentsTriggerContextUnion** = [`ManagedAgentsScheduleTriggerContext`](../interfaces/ManagedAgentsScheduleTriggerContext.md) \| [`ManagedAgentsManualTriggerContext`](../interfaces/ManagedAgentsManualTriggerContext.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsTriggerType.md b/docs/api/managed/type-aliases/ManagedAgentsTriggerType.md new file mode 100644 index 0000000..3e1005e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsTriggerType.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsTriggerType + +# Type Alias: ManagedAgentsTriggerType + +> **ManagedAgentsTriggerType** = `"schedule"` \| `"manual"` + +What triggered a deployment run. diff --git a/docs/api/managed/type-aliases/ManagedAgentsURLDocumentSourceType.md b/docs/api/managed/type-aliases/ManagedAgentsURLDocumentSourceType.md new file mode 100644 index 0000000..162fc03 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsURLDocumentSourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsURLDocumentSourceType + +# Type Alias: ManagedAgentsURLDocumentSourceType + +> **ManagedAgentsURLDocumentSourceType** = `"url"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsURLImageSourceType.md b/docs/api/managed/type-aliases/ManagedAgentsURLImageSourceType.md new file mode 100644 index 0000000..59ca783 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsURLImageSourceType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsURLImageSourceType + +# Type Alias: ManagedAgentsURLImageSourceType + +> **ManagedAgentsURLImageSourceType** = `"url"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsURLMCPServerParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsURLMCPServerParamsType.md new file mode 100644 index 0000000..5d0d64a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsURLMCPServerParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsURLMCPServerParamsType + +# Type Alias: ManagedAgentsURLMCPServerParamsType + +> **ManagedAgentsURLMCPServerParamsType** = `"url"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUnknownDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsUnknownDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..a967d0a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUnknownDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnknownDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsUnknownDeploymentPausedReasonErrorType + +> **ManagedAgentsUnknownDeploymentPausedReasonErrorType** = `"unknown_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUnknownErrorRetryStatusUnion.md b/docs/api/managed/type-aliases/ManagedAgentsUnknownErrorRetryStatusUnion.md new file mode 100644 index 0000000..c8e5ab8 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUnknownErrorRetryStatusUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnknownErrorRetryStatusUnion + +# Type Alias: ManagedAgentsUnknownErrorRetryStatusUnion + +> **ManagedAgentsUnknownErrorRetryStatusUnion** = [`ManagedAgentsRetryStatusRetrying`](../interfaces/ManagedAgentsRetryStatusRetrying.md) \| [`ManagedAgentsRetryStatusExhausted`](../interfaces/ManagedAgentsRetryStatusExhausted.md) \| [`ManagedAgentsRetryStatusTerminal`](../interfaces/ManagedAgentsRetryStatusTerminal.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsUnknownErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsUnknownErrorType.md new file mode 100644 index 0000000..3f3375f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUnknownErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnknownErrorType + +# Type Alias: ManagedAgentsUnknownErrorType + +> **ManagedAgentsUnknownErrorType** = `"unknown_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUnknownRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsUnknownRunErrorType.md new file mode 100644 index 0000000..bc05aff --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUnknownRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnknownRunErrorType + +# Type Alias: ManagedAgentsUnknownRunErrorType + +> **ManagedAgentsUnknownRunErrorType** = `"unknown_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingParamsType.md new file mode 100644 index 0000000..4fb16c6 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnrestrictedCredentialNetworkingParamsType + +# Type Alias: ManagedAgentsUnrestrictedCredentialNetworkingParamsType + +> **ManagedAgentsUnrestrictedCredentialNetworkingParamsType** = `"unrestricted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingResponseType.md b/docs/api/managed/type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingResponseType.md new file mode 100644 index 0000000..11b35cf --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUnrestrictedCredentialNetworkingResponseType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUnrestrictedCredentialNetworkingResponseType + +# Type Alias: ManagedAgentsUnrestrictedCredentialNetworkingResponseType + +> **ManagedAgentsUnrestrictedCredentialNetworkingResponseType** = `"unrestricted"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserActorType.md b/docs/api/managed/type-aliases/ManagedAgentsUserActorType.md new file mode 100644 index 0000000..f03376d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserActorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserActorType + +# Type Alias: ManagedAgentsUserActorType + +> **ManagedAgentsUserActorType** = `"user_actor"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventContentUnion.md new file mode 100644 index 0000000..d9047e4 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventContentUnion.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserCustomToolResultEventContentUnion + +# Type Alias: ManagedAgentsUserCustomToolResultEventContentUnion + +> **ManagedAgentsUserCustomToolResultEventContentUnion** = [`ManagedAgentsTextBlock`](../interfaces/ManagedAgentsTextBlock.md) \| [`ManagedAgentsImageBlock`](../interfaces/ManagedAgentsImageBlock.md) \| [`ManagedAgentsDocumentBlock`](../interfaces/ManagedAgentsDocumentBlock.md) \| [`ManagedAgentsSearchResultBlock`](../interfaces/ManagedAgentsSearchResultBlock.md) + +ManagedAgentsUserCustomToolResultEventContentUnion contains all possible +properties and values from `ManagedAgentsTextBlock`, +`ManagedAgentsImageBlock`, `ManagedAgentsDocumentBlock`, +`ManagedAgentsSearchResultBlock`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventContentUnionSource.md b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventContentUnionSource.md new file mode 100644 index 0000000..273ba09 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventContentUnionSource.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserCustomToolResultEventContentUnionSource + +# Type Alias: ManagedAgentsUserCustomToolResultEventContentUnionSource + +> **ManagedAgentsUserCustomToolResultEventContentUnionSource** = `string` \| \{ `data?`: `string`; `file_id?`: `string`; `media_type?`: `string`; `type?`: `string`; `url?`: `string`; \} + +ManagedAgentsUserCustomToolResultEventContentUnionSource is an implicit +subunion of `ManagedAgentsUserCustomToolResultEventContentUnion`. +ManagedAgentsUserCustomToolResultEventContentUnionSource provides convenient +access to the sub-properties of the union. diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventParamsContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventParamsContentUnion.md new file mode 100644 index 0000000..774cca9 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventParamsContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserCustomToolResultEventParamsContentUnion + +# Type Alias: ManagedAgentsUserCustomToolResultEventParamsContentUnion + +> **ManagedAgentsUserCustomToolResultEventParamsContentUnion** = [`ManagedAgentsTextBlockParam`](../interfaces/ManagedAgentsTextBlockParam.md) \| [`ManagedAgentsImageBlockParam`](../interfaces/ManagedAgentsImageBlockParam.md) \| [`ManagedAgentsDocumentBlockParam`](../interfaces/ManagedAgentsDocumentBlockParam.md) \| [`ManagedAgentsSearchResultBlockParam`](../interfaces/ManagedAgentsSearchResultBlockParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventParamsType.md new file mode 100644 index 0000000..5f75a7b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserCustomToolResultEventParamsType + +# Type Alias: ManagedAgentsUserCustomToolResultEventParamsType + +> **ManagedAgentsUserCustomToolResultEventParamsType** = `"user.custom_tool_result"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventType.md b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventType.md new file mode 100644 index 0000000..4f02655 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserCustomToolResultEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserCustomToolResultEventType + +# Type Alias: ManagedAgentsUserCustomToolResultEventType + +> **ManagedAgentsUserCustomToolResultEventType** = `"user.custom_tool_result"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventParamsRubricUnion.md b/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventParamsRubricUnion.md new file mode 100644 index 0000000..63b4569 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventParamsRubricUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserDefineOutcomeEventParamsRubricUnion + +# Type Alias: ManagedAgentsUserDefineOutcomeEventParamsRubricUnion + +> **ManagedAgentsUserDefineOutcomeEventParamsRubricUnion** = [`ManagedAgentsFileRubricParams`](../interfaces/ManagedAgentsFileRubricParams.md) \| [`ManagedAgentsTextRubricParams`](../interfaces/ManagedAgentsTextRubricParams.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventParamsType.md new file mode 100644 index 0000000..86e0844 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserDefineOutcomeEventParamsType + +# Type Alias: ManagedAgentsUserDefineOutcomeEventParamsType + +> **ManagedAgentsUserDefineOutcomeEventParamsType** = `"user.define_outcome"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventRubricUnion.md b/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventRubricUnion.md new file mode 100644 index 0000000..f1e9572 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventRubricUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserDefineOutcomeEventRubricUnion + +# Type Alias: ManagedAgentsUserDefineOutcomeEventRubricUnion + +> **ManagedAgentsUserDefineOutcomeEventRubricUnion** = [`ManagedAgentsFileRubric`](../interfaces/ManagedAgentsFileRubric.md) \| [`ManagedAgentsTextRubric`](../interfaces/ManagedAgentsTextRubric.md) + +ManagedAgentsUserDefineOutcomeEventRubricUnion contains all possible +properties and values from `ManagedAgentsFileRubric`, +`ManagedAgentsTextRubric`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventType.md b/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventType.md new file mode 100644 index 0000000..2baa93b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserDefineOutcomeEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserDefineOutcomeEventType + +# Type Alias: ManagedAgentsUserDefineOutcomeEventType + +> **ManagedAgentsUserDefineOutcomeEventType** = `"user.define_outcome"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserInterruptEventParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsUserInterruptEventParamsType.md new file mode 100644 index 0000000..8811a59 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserInterruptEventParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserInterruptEventParamsType + +# Type Alias: ManagedAgentsUserInterruptEventParamsType + +> **ManagedAgentsUserInterruptEventParamsType** = `"user.interrupt"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserInterruptEventType.md b/docs/api/managed/type-aliases/ManagedAgentsUserInterruptEventType.md new file mode 100644 index 0000000..d21d67b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserInterruptEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserInterruptEventType + +# Type Alias: ManagedAgentsUserInterruptEventType + +> **ManagedAgentsUserInterruptEventType** = `"user.interrupt"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventContentUnion.md new file mode 100644 index 0000000..1ebd693 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserMessageEventContentUnion + +# Type Alias: ManagedAgentsUserMessageEventContentUnion + +> **ManagedAgentsUserMessageEventContentUnion** = [`ManagedAgentsTextBlock`](../interfaces/ManagedAgentsTextBlock.md) \| [`ManagedAgentsImageBlock`](../interfaces/ManagedAgentsImageBlock.md) \| [`ManagedAgentsDocumentBlock`](../interfaces/ManagedAgentsDocumentBlock.md) \| [`ManagedAgentsRedactedBlock`](../interfaces/ManagedAgentsRedactedBlock.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventParamsContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventParamsContentUnion.md new file mode 100644 index 0000000..25d9717 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventParamsContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserMessageEventParamsContentUnion + +# Type Alias: ManagedAgentsUserMessageEventParamsContentUnion + +> **ManagedAgentsUserMessageEventParamsContentUnion** = [`ManagedAgentsTextBlockParam`](../interfaces/ManagedAgentsTextBlockParam.md) \| [`ManagedAgentsImageBlockParam`](../interfaces/ManagedAgentsImageBlockParam.md) \| [`ManagedAgentsDocumentBlockParam`](../interfaces/ManagedAgentsDocumentBlockParam.md) \| [`ManagedAgentsRedactedBlockParam`](../interfaces/ManagedAgentsRedactedBlockParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventParamsType.md new file mode 100644 index 0000000..190aaca --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserMessageEventParamsType + +# Type Alias: ManagedAgentsUserMessageEventParamsType + +> **ManagedAgentsUserMessageEventParamsType** = `"user.message"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventType.md b/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventType.md new file mode 100644 index 0000000..2432b77 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserMessageEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserMessageEventType + +# Type Alias: ManagedAgentsUserMessageEventType + +> **ManagedAgentsUserMessageEventType** = `"user.message"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventParamsResult.md b/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventParamsResult.md new file mode 100644 index 0000000..bf439f8 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventParamsResult.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolConfirmationEventParamsResult + +# Type Alias: ManagedAgentsUserToolConfirmationEventParamsResult + +> **ManagedAgentsUserToolConfirmationEventParamsResult** = `"allow"` \| `"deny"` + +UserToolConfirmationResult enum diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventParamsType.md new file mode 100644 index 0000000..5052246 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolConfirmationEventParamsType + +# Type Alias: ManagedAgentsUserToolConfirmationEventParamsType + +> **ManagedAgentsUserToolConfirmationEventParamsType** = `"user.tool_confirmation"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventResult.md b/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventResult.md new file mode 100644 index 0000000..df1fb72 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventResult.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolConfirmationEventResult + +# Type Alias: ManagedAgentsUserToolConfirmationEventResult + +> **ManagedAgentsUserToolConfirmationEventResult** = `"allow"` \| `"deny"` + +UserToolConfirmationResult enum diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventType.md b/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventType.md new file mode 100644 index 0000000..59f4dee --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserToolConfirmationEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolConfirmationEventType + +# Type Alias: ManagedAgentsUserToolConfirmationEventType + +> **ManagedAgentsUserToolConfirmationEventType** = `"user.tool_confirmation"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventContentUnion.md new file mode 100644 index 0000000..2b66a1c --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventContentUnion.md @@ -0,0 +1,14 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolResultEventContentUnion + +# Type Alias: ManagedAgentsUserToolResultEventContentUnion + +> **ManagedAgentsUserToolResultEventContentUnion** = [`ManagedAgentsTextBlock`](../interfaces/ManagedAgentsTextBlock.md) \| [`ManagedAgentsImageBlock`](../interfaces/ManagedAgentsImageBlock.md) \| [`ManagedAgentsDocumentBlock`](../interfaces/ManagedAgentsDocumentBlock.md) \| [`ManagedAgentsSearchResultBlock`](../interfaces/ManagedAgentsSearchResultBlock.md) + +ManagedAgentsUserToolResultEventContentUnion contains all possible +properties and values from `ManagedAgentsTextBlock`, +`ManagedAgentsImageBlock`, `ManagedAgentsDocumentBlock`, +`ManagedAgentsSearchResultBlock`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventContentUnionSource.md b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventContentUnionSource.md new file mode 100644 index 0000000..d1c9b7e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventContentUnionSource.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolResultEventContentUnionSource + +# Type Alias: ManagedAgentsUserToolResultEventContentUnionSource + +> **ManagedAgentsUserToolResultEventContentUnionSource** = `string` \| \{ `data?`: `string`; `file_id?`: `string`; `media_type?`: `string`; `type?`: `string`; `url?`: `string`; \} diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventParamsContentUnion.md b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventParamsContentUnion.md new file mode 100644 index 0000000..08c95f1 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventParamsContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolResultEventParamsContentUnion + +# Type Alias: ManagedAgentsUserToolResultEventParamsContentUnion + +> **ManagedAgentsUserToolResultEventParamsContentUnion** = [`ManagedAgentsTextBlockParam`](../interfaces/ManagedAgentsTextBlockParam.md) \| [`ManagedAgentsImageBlockParam`](../interfaces/ManagedAgentsImageBlockParam.md) \| [`ManagedAgentsDocumentBlockParam`](../interfaces/ManagedAgentsDocumentBlockParam.md) \| [`ManagedAgentsSearchResultBlockParam`](../interfaces/ManagedAgentsSearchResultBlockParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventParamsType.md new file mode 100644 index 0000000..d6701e4 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolResultEventParamsType + +# Type Alias: ManagedAgentsUserToolResultEventParamsType + +> **ManagedAgentsUserToolResultEventParamsType** = `"user.tool_result"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventType.md b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventType.md new file mode 100644 index 0000000..75d149f --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsUserToolResultEventType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsUserToolResultEventType + +# Type Alias: ManagedAgentsUserToolResultEventType + +> **ManagedAgentsUserToolResultEventType** = `"user.tool_result"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsVaultArchivedDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsVaultArchivedDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..04e560d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsVaultArchivedDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVaultArchivedDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsVaultArchivedDeploymentPausedReasonErrorType + +> **ManagedAgentsVaultArchivedDeploymentPausedReasonErrorType** = `"vault_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsVaultArchivedRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsVaultArchivedRunErrorType.md new file mode 100644 index 0000000..47546a3 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsVaultArchivedRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVaultArchivedRunErrorType + +# Type Alias: ManagedAgentsVaultArchivedRunErrorType + +> **ManagedAgentsVaultArchivedRunErrorType** = `"vault_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsVaultNotFoundDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsVaultNotFoundDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..7deadc9 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsVaultNotFoundDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVaultNotFoundDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsVaultNotFoundDeploymentPausedReasonErrorType + +> **ManagedAgentsVaultNotFoundDeploymentPausedReasonErrorType** = `"vault_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsVaultNotFoundRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsVaultNotFoundRunErrorType.md new file mode 100644 index 0000000..c69da1a --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsVaultNotFoundRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVaultNotFoundRunErrorType + +# Type Alias: ManagedAgentsVaultNotFoundRunErrorType + +> **ManagedAgentsVaultNotFoundRunErrorType** = `"vault_not_found_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsVaultType.md b/docs/api/managed/type-aliases/ManagedAgentsVaultType.md new file mode 100644 index 0000000..dc9679b --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsVaultType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsVaultType + +# Type Alias: ManagedAgentsVaultType + +> **ManagedAgentsVaultType** = `"vault"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..2a8beed --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion + +> **ManagedAgentsWebFetchToolConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigParamsType.md new file mode 100644 index 0000000..32781f8 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebFetchToolConfigParamsType + +# Type Alias: ManagedAgentsWebFetchToolConfigParamsType + +> **ManagedAgentsWebFetchToolConfigParamsType** = `"web_fetch"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..f4545b5 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWebFetchToolConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebFetchToolConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsWebFetchToolConfigPermissionPolicyUnion + +> **ManagedAgentsWebFetchToolConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsWebFetchToolConfigPermissionPolicyUnion contains all possible +properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..b5f0286 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion + +> **ManagedAgentsWebSearchToolConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigParamsType.md new file mode 100644 index 0000000..c37d1c8 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebSearchToolConfigParamsType + +# Type Alias: ManagedAgentsWebSearchToolConfigParamsType + +> **ManagedAgentsWebSearchToolConfigParamsType** = `"web_search"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..842e168 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWebSearchToolConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWebSearchToolConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsWebSearchToolConfigPermissionPolicyUnion + +> **ManagedAgentsWebSearchToolConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsWebSearchToolConfigPermissionPolicyUnion contains all possible +properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonErrorType.md new file mode 100644 index 0000000..3e0e31e --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWorkspaceArchivedDeploymentPausedReasonErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWorkspaceArchivedDeploymentPausedReasonErrorType + +# Type Alias: ManagedAgentsWorkspaceArchivedDeploymentPausedReasonErrorType + +> **ManagedAgentsWorkspaceArchivedDeploymentPausedReasonErrorType** = `"workspace_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsWorkspaceArchivedRunErrorType.md b/docs/api/managed/type-aliases/ManagedAgentsWorkspaceArchivedRunErrorType.md new file mode 100644 index 0000000..b24f479 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWorkspaceArchivedRunErrorType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWorkspaceArchivedRunErrorType + +# Type Alias: ManagedAgentsWorkspaceArchivedRunErrorType + +> **ManagedAgentsWorkspaceArchivedRunErrorType** = `"workspace_archived_error"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion.md new file mode 100644 index 0000000..c6a382d --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion + +# Type Alias: ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion + +> **ManagedAgentsWriteToolConfigParamsPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicyParam`](../interfaces/ManagedAgentsAlwaysAllowPolicyParam.md) \| [`ManagedAgentsAlwaysAskPolicyParam`](../interfaces/ManagedAgentsAlwaysAskPolicyParam.md) diff --git a/docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigParamsType.md b/docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigParamsType.md new file mode 100644 index 0000000..e47fb64 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigParamsType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWriteToolConfigParamsType + +# Type Alias: ManagedAgentsWriteToolConfigParamsType + +> **ManagedAgentsWriteToolConfigParamsType** = `"write"` diff --git a/docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigPermissionPolicyUnion.md b/docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigPermissionPolicyUnion.md new file mode 100644 index 0000000..fc362a7 --- /dev/null +++ b/docs/api/managed/type-aliases/ManagedAgentsWriteToolConfigPermissionPolicyUnion.md @@ -0,0 +1,13 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ManagedAgentsWriteToolConfigPermissionPolicyUnion + +# Type Alias: ManagedAgentsWriteToolConfigPermissionPolicyUnion + +> **ManagedAgentsWriteToolConfigPermissionPolicyUnion** = [`ManagedAgentsAlwaysAllowPolicy`](../interfaces/ManagedAgentsAlwaysAllowPolicy.md) \| [`ManagedAgentsAlwaysAskPolicy`](../interfaces/ManagedAgentsAlwaysAskPolicy.md) + +ManagedAgentsWriteToolConfigPermissionPolicyUnion contains all possible +properties and values from `ManagedAgentsAlwaysAllowPolicy`, +`ManagedAgentsAlwaysAskPolicy`. diff --git a/docs/api/managed/type-aliases/MemoryStoreCreateParams.md b/docs/api/managed/type-aliases/MemoryStoreCreateParams.md new file mode 100644 index 0000000..35e832b --- /dev/null +++ b/docs/api/managed/type-aliases/MemoryStoreCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreCreateParams + +# Type Alias: MemoryStoreCreateParams + +> **MemoryStoreCreateParams** = [`MemoryStoreNewParams`](../interfaces/MemoryStoreNewParams.md) diff --git a/docs/api/managed/type-aliases/MemoryStoreMemoryCreateParams.md b/docs/api/managed/type-aliases/MemoryStoreMemoryCreateParams.md new file mode 100644 index 0000000..a0f8801 --- /dev/null +++ b/docs/api/managed/type-aliases/MemoryStoreMemoryCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryCreateParams + +# Type Alias: MemoryStoreMemoryCreateParams + +> **MemoryStoreMemoryCreateParams** = [`MemoryStoreMemoryNewParams`](../interfaces/MemoryStoreMemoryNewParams.md) diff --git a/docs/api/managed/type-aliases/MemoryStoreMemoryRetrieveParams.md b/docs/api/managed/type-aliases/MemoryStoreMemoryRetrieveParams.md new file mode 100644 index 0000000..9d9212a --- /dev/null +++ b/docs/api/managed/type-aliases/MemoryStoreMemoryRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryRetrieveParams + +# Type Alias: MemoryStoreMemoryRetrieveParams + +> **MemoryStoreMemoryRetrieveParams** = [`MemoryStoreMemoryGetParams`](../interfaces/MemoryStoreMemoryGetParams.md) diff --git a/docs/api/managed/type-aliases/MemoryStoreMemoryVersionRetrieveParams.md b/docs/api/managed/type-aliases/MemoryStoreMemoryVersionRetrieveParams.md new file mode 100644 index 0000000..623bda2 --- /dev/null +++ b/docs/api/managed/type-aliases/MemoryStoreMemoryVersionRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreMemoryVersionRetrieveParams + +# Type Alias: MemoryStoreMemoryVersionRetrieveParams + +> **MemoryStoreMemoryVersionRetrieveParams** = [`MemoryStoreMemoryVersionGetParams`](../interfaces/MemoryStoreMemoryVersionGetParams.md) diff --git a/docs/api/managed/type-aliases/MemoryStoreRetrieveParams.md b/docs/api/managed/type-aliases/MemoryStoreRetrieveParams.md new file mode 100644 index 0000000..d9fe97f --- /dev/null +++ b/docs/api/managed/type-aliases/MemoryStoreRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / MemoryStoreRetrieveParams + +# Type Alias: MemoryStoreRetrieveParams + +> **MemoryStoreRetrieveParams** = [`MemoryStoreGetParams`](../interfaces/MemoryStoreGetParams.md) diff --git a/docs/api/managed/type-aliases/Model.md b/docs/api/managed/type-aliases/Model.md new file mode 100644 index 0000000..4c3c0ea --- /dev/null +++ b/docs/api/managed/type-aliases/Model.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / Model + +# Type Alias: Model + +> **Model** = `string` + +Model identifies a model available to the API. diff --git a/docs/api/managed/type-aliases/OutputBehaviorCreateNewType.md b/docs/api/managed/type-aliases/OutputBehaviorCreateNewType.md new file mode 100644 index 0000000..e99c2c9 --- /dev/null +++ b/docs/api/managed/type-aliases/OutputBehaviorCreateNewType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / OutputBehaviorCreateNewType + +# Type Alias: OutputBehaviorCreateNewType + +> **OutputBehaviorCreateNewType** = `"create_new"` diff --git a/docs/api/managed/type-aliases/OutputBehaviorUnion.md b/docs/api/managed/type-aliases/OutputBehaviorUnion.md new file mode 100644 index 0000000..33ab018 --- /dev/null +++ b/docs/api/managed/type-aliases/OutputBehaviorUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / OutputBehaviorUnion + +# Type Alias: OutputBehaviorUnion + +> **OutputBehaviorUnion** = [`OutputBehaviorCreateNew`](../interfaces/OutputBehaviorCreateNew.md) \| [`OutputBehaviorUpdateExisting`](../interfaces/OutputBehaviorUpdateExisting.md) diff --git a/docs/api/managed/type-aliases/OutputBehaviorUnionParam.md b/docs/api/managed/type-aliases/OutputBehaviorUnionParam.md new file mode 100644 index 0000000..1ff6344 --- /dev/null +++ b/docs/api/managed/type-aliases/OutputBehaviorUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / OutputBehaviorUnionParam + +# Type Alias: OutputBehaviorUnionParam + +> **OutputBehaviorUnionParam** = [`OutputBehaviorCreateNewParam`](../interfaces/OutputBehaviorCreateNewParam.md) \| [`OutputBehaviorUpdateExistingParam`](../interfaces/OutputBehaviorUpdateExistingParam.md) diff --git a/docs/api/managed/type-aliases/OutputBehaviorUpdateExistingType.md b/docs/api/managed/type-aliases/OutputBehaviorUpdateExistingType.md new file mode 100644 index 0000000..b745c63 --- /dev/null +++ b/docs/api/managed/type-aliases/OutputBehaviorUpdateExistingType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / OutputBehaviorUpdateExistingType + +# Type Alias: OutputBehaviorUpdateExistingType + +> **OutputBehaviorUpdateExistingType** = `"update_existing"` diff --git a/docs/api/managed/type-aliases/PackagesParamsType.md b/docs/api/managed/type-aliases/PackagesParamsType.md new file mode 100644 index 0000000..1de0763 --- /dev/null +++ b/docs/api/managed/type-aliases/PackagesParamsType.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / PackagesParamsType + +# Type Alias: PackagesParamsType + +> **PackagesParamsType** = `"packages"` + +Package configuration type diff --git a/docs/api/managed/type-aliases/PackagesType.md b/docs/api/managed/type-aliases/PackagesType.md new file mode 100644 index 0000000..d1cd793 --- /dev/null +++ b/docs/api/managed/type-aliases/PackagesType.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / PackagesType + +# Type Alias: PackagesType + +> **PackagesType** = `"packages"` + +Package configuration type diff --git a/docs/api/managed/type-aliases/QoderBeta.md b/docs/api/managed/type-aliases/QoderBeta.md new file mode 100644 index 0000000..2e185e0 --- /dev/null +++ b/docs/api/managed/type-aliases/QoderBeta.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / QoderBeta + +# Type Alias: QoderBeta + +> **QoderBeta** = `string` diff --git a/docs/api/managed/type-aliases/RequestDocumentBlockSourceUnionParam.md b/docs/api/managed/type-aliases/RequestDocumentBlockSourceUnionParam.md new file mode 100644 index 0000000..f2c0e43 --- /dev/null +++ b/docs/api/managed/type-aliases/RequestDocumentBlockSourceUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / RequestDocumentBlockSourceUnionParam + +# Type Alias: RequestDocumentBlockSourceUnionParam + +> **RequestDocumentBlockSourceUnionParam** = [`Base64PDFSourceParam`](../interfaces/Base64PDFSourceParam.md) \| [`PlainTextSourceParam`](../interfaces/PlainTextSourceParam.md) \| [`ContentBlockSourceParam`](../interfaces/ContentBlockSourceParam.md) \| [`URLPDFSourceParam`](../interfaces/URLPDFSourceParam.md) \| [`FileDocumentSourceParam`](../interfaces/FileDocumentSourceParam.md) diff --git a/docs/api/managed/type-aliases/RequestMCPToolResultBlockParamContentUnion.md b/docs/api/managed/type-aliases/RequestMCPToolResultBlockParamContentUnion.md new file mode 100644 index 0000000..4087612 --- /dev/null +++ b/docs/api/managed/type-aliases/RequestMCPToolResultBlockParamContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / RequestMCPToolResultBlockParamContentUnion + +# Type Alias: RequestMCPToolResultBlockParamContentUnion + +> **RequestMCPToolResultBlockParamContentUnion** = `string` \| [`TextBlockParam`](../interfaces/TextBlockParam.md)[] diff --git a/docs/api/managed/type-aliases/RequestToolAdditionBlockToolUnionParam.md b/docs/api/managed/type-aliases/RequestToolAdditionBlockToolUnionParam.md new file mode 100644 index 0000000..dfc3b3b --- /dev/null +++ b/docs/api/managed/type-aliases/RequestToolAdditionBlockToolUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / RequestToolAdditionBlockToolUnionParam + +# Type Alias: RequestToolAdditionBlockToolUnionParam + +> **RequestToolAdditionBlockToolUnionParam** = [`ToolChangeToolReferenceParam`](../interfaces/ToolChangeToolReferenceParam.md) \| [`ToolChangeMCPToolReferenceParam`](../interfaces/ToolChangeMCPToolReferenceParam.md) \| [`ToolChangeMCPToolsetReferenceParam`](../interfaces/ToolChangeMCPToolsetReferenceParam.md) diff --git a/docs/api/managed/type-aliases/RequestToolRemovalBlockToolUnionParam.md b/docs/api/managed/type-aliases/RequestToolRemovalBlockToolUnionParam.md new file mode 100644 index 0000000..0ab36ee --- /dev/null +++ b/docs/api/managed/type-aliases/RequestToolRemovalBlockToolUnionParam.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / RequestToolRemovalBlockToolUnionParam + +# Type Alias: RequestToolRemovalBlockToolUnionParam + +> **RequestToolRemovalBlockToolUnionParam** = [`ToolChangeToolReferenceParam`](../interfaces/ToolChangeToolReferenceParam.md) \| [`ToolChangeMCPToolReferenceParam`](../interfaces/ToolChangeMCPToolReferenceParam.md) \| [`ToolChangeMCPToolsetReferenceParam`](../interfaces/ToolChangeMCPToolsetReferenceParam.md) diff --git a/docs/api/managed/type-aliases/SelfHostedWorkHeartbeatResponseState.md b/docs/api/managed/type-aliases/SelfHostedWorkHeartbeatResponseState.md new file mode 100644 index 0000000..7f998ca --- /dev/null +++ b/docs/api/managed/type-aliases/SelfHostedWorkHeartbeatResponseState.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedWorkHeartbeatResponseState + +# Type Alias: SelfHostedWorkHeartbeatResponseState + +> **SelfHostedWorkHeartbeatResponseState** = `"queued"` \| `"starting"` \| `"active"` \| `"stopping"` \| `"stopped"` + +Current state of the work item (active/stopping/stopped) diff --git a/docs/api/managed/type-aliases/SelfHostedWorkState.md b/docs/api/managed/type-aliases/SelfHostedWorkState.md new file mode 100644 index 0000000..f9a4e2d --- /dev/null +++ b/docs/api/managed/type-aliases/SelfHostedWorkState.md @@ -0,0 +1,11 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SelfHostedWorkState + +# Type Alias: SelfHostedWorkState + +> **SelfHostedWorkState** = `"queued"` \| `"starting"` \| `"active"` \| `"stopping"` \| `"stopped"` + +Current state of the work item diff --git a/docs/api/managed/type-aliases/ServerToolUseBlockParamCallerUnion.md b/docs/api/managed/type-aliases/ServerToolUseBlockParamCallerUnion.md new file mode 100644 index 0000000..9c91db5 --- /dev/null +++ b/docs/api/managed/type-aliases/ServerToolUseBlockParamCallerUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ServerToolUseBlockParamCallerUnion + +# Type Alias: ServerToolUseBlockParamCallerUnion + +> **ServerToolUseBlockParamCallerUnion** = [`DirectCallerParam`](../interfaces/DirectCallerParam.md) \| [`ServerToolCallerParam`](../interfaces/ServerToolCallerParam.md) \| [`ServerToolCaller20260120Param`](../interfaces/ServerToolCaller20260120Param.md) diff --git a/docs/api/managed/type-aliases/ServerToolUseBlockParamName.md b/docs/api/managed/type-aliases/ServerToolUseBlockParamName.md new file mode 100644 index 0000000..7d1ae47 --- /dev/null +++ b/docs/api/managed/type-aliases/ServerToolUseBlockParamName.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ServerToolUseBlockParamName + +# Type Alias: ServerToolUseBlockParamName + +> **ServerToolUseBlockParamName** = `string` diff --git a/docs/api/managed/type-aliases/SessionCreateParams.md b/docs/api/managed/type-aliases/SessionCreateParams.md new file mode 100644 index 0000000..88bbcf4 --- /dev/null +++ b/docs/api/managed/type-aliases/SessionCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionCreateParams + +# Type Alias: SessionCreateParams + +> **SessionCreateParams** = [`SessionNewParams`](../interfaces/SessionNewParams.md) diff --git a/docs/api/managed/type-aliases/SessionEventListParamsOrder.md b/docs/api/managed/type-aliases/SessionEventListParamsOrder.md new file mode 100644 index 0000000..f84f75b --- /dev/null +++ b/docs/api/managed/type-aliases/SessionEventListParamsOrder.md @@ -0,0 +1,12 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionEventListParamsOrder + +# Type Alias: SessionEventListParamsOrder + +> **SessionEventListParamsOrder** = `"asc"` \| `"desc"` + +Sort direction for results, ordered by the event's `processed_at`. Defaults to +`asc` (chronological). diff --git a/docs/api/managed/type-aliases/SessionListParamsOrder.md b/docs/api/managed/type-aliases/SessionListParamsOrder.md new file mode 100644 index 0000000..7b7acb2 --- /dev/null +++ b/docs/api/managed/type-aliases/SessionListParamsOrder.md @@ -0,0 +1,12 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionListParamsOrder + +# Type Alias: SessionListParamsOrder + +> **SessionListParamsOrder** = `"asc"` \| `"desc"` + +Sort direction for results, ordered by `created_at`. Defaults to `desc` (newest +first). diff --git a/docs/api/managed/type-aliases/SessionNewParamsAgentUnion.md b/docs/api/managed/type-aliases/SessionNewParamsAgentUnion.md new file mode 100644 index 0000000..a57ad43 --- /dev/null +++ b/docs/api/managed/type-aliases/SessionNewParamsAgentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionNewParamsAgentUnion + +# Type Alias: SessionNewParamsAgentUnion + +> **SessionNewParamsAgentUnion** = `string` \| [`ManagedAgentsAgentParams`](../interfaces/ManagedAgentsAgentParams.md) \| [`ManagedAgentsAgentWithOverridesParams`](../interfaces/ManagedAgentsAgentWithOverridesParams.md) diff --git a/docs/api/managed/type-aliases/SessionNewParamsInitialEventUnion.md b/docs/api/managed/type-aliases/SessionNewParamsInitialEventUnion.md new file mode 100644 index 0000000..b736e87 --- /dev/null +++ b/docs/api/managed/type-aliases/SessionNewParamsInitialEventUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionNewParamsInitialEventUnion + +# Type Alias: SessionNewParamsInitialEventUnion + +> **SessionNewParamsInitialEventUnion** = [`ManagedAgentsUserMessageEventParams`](../interfaces/ManagedAgentsUserMessageEventParams.md) \| [`ManagedAgentsUserDefineOutcomeEventParams`](../interfaces/ManagedAgentsUserDefineOutcomeEventParams.md) diff --git a/docs/api/managed/type-aliases/SessionNewParamsResourceUnion.md b/docs/api/managed/type-aliases/SessionNewParamsResourceUnion.md new file mode 100644 index 0000000..b04d8ce --- /dev/null +++ b/docs/api/managed/type-aliases/SessionNewParamsResourceUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionNewParamsResourceUnion + +# Type Alias: SessionNewParamsResourceUnion + +> **SessionNewParamsResourceUnion** = [`ManagedAgentsGitHubRepositoryResourceParams`](../interfaces/ManagedAgentsGitHubRepositoryResourceParams.md) \| [`ManagedAgentsFileResourceParams`](../interfaces/ManagedAgentsFileResourceParams.md) \| [`ManagedAgentsMemoryStoreResourceParam`](../interfaces/ManagedAgentsMemoryStoreResourceParam.md) diff --git a/docs/api/managed/type-aliases/SessionResourceGetResponseUnion.md b/docs/api/managed/type-aliases/SessionResourceGetResponseUnion.md new file mode 100644 index 0000000..b5584bf --- /dev/null +++ b/docs/api/managed/type-aliases/SessionResourceGetResponseUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionResourceGetResponseUnion + +# Type Alias: SessionResourceGetResponseUnion + +> **SessionResourceGetResponseUnion** = [`ManagedAgentsGitHubRepositoryResource`](../interfaces/ManagedAgentsGitHubRepositoryResource.md) \| [`ManagedAgentsFileResource`](../interfaces/ManagedAgentsFileResource.md) \| [`ManagedAgentsMemoryStoreResource`](../interfaces/ManagedAgentsMemoryStoreResource.md) diff --git a/docs/api/managed/type-aliases/SessionResourceRetrieveParams.md b/docs/api/managed/type-aliases/SessionResourceRetrieveParams.md new file mode 100644 index 0000000..08a0ce2 --- /dev/null +++ b/docs/api/managed/type-aliases/SessionResourceRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionResourceRetrieveParams + +# Type Alias: SessionResourceRetrieveParams + +> **SessionResourceRetrieveParams** = [`SessionResourceGetParams`](../interfaces/SessionResourceGetParams.md) diff --git a/docs/api/managed/type-aliases/SessionResourceUpdateResponseUnion.md b/docs/api/managed/type-aliases/SessionResourceUpdateResponseUnion.md new file mode 100644 index 0000000..d993388 --- /dev/null +++ b/docs/api/managed/type-aliases/SessionResourceUpdateResponseUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionResourceUpdateResponseUnion + +# Type Alias: SessionResourceUpdateResponseUnion + +> **SessionResourceUpdateResponseUnion** = [`ManagedAgentsGitHubRepositoryResource`](../interfaces/ManagedAgentsGitHubRepositoryResource.md) \| [`ManagedAgentsFileResource`](../interfaces/ManagedAgentsFileResource.md) \| [`ManagedAgentsMemoryStoreResource`](../interfaces/ManagedAgentsMemoryStoreResource.md) diff --git a/docs/api/managed/type-aliases/SessionRetrieveParams.md b/docs/api/managed/type-aliases/SessionRetrieveParams.md new file mode 100644 index 0000000..f338841 --- /dev/null +++ b/docs/api/managed/type-aliases/SessionRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionRetrieveParams + +# Type Alias: SessionRetrieveParams + +> **SessionRetrieveParams** = [`SessionGetParams`](../interfaces/SessionGetParams.md) diff --git a/docs/api/managed/type-aliases/SessionThreadRetrieveParams.md b/docs/api/managed/type-aliases/SessionThreadRetrieveParams.md new file mode 100644 index 0000000..19caf07 --- /dev/null +++ b/docs/api/managed/type-aliases/SessionThreadRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SessionThreadRetrieveParams + +# Type Alias: SessionThreadRetrieveParams + +> **SessionThreadRetrieveParams** = [`SessionThreadGetParams`](../interfaces/SessionThreadGetParams.md) diff --git a/docs/api/managed/type-aliases/SkillCreateParams.md b/docs/api/managed/type-aliases/SkillCreateParams.md new file mode 100644 index 0000000..f528e35 --- /dev/null +++ b/docs/api/managed/type-aliases/SkillCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillCreateParams + +# Type Alias: SkillCreateParams + +> **SkillCreateParams** = [`SkillNewParams`](../interfaces/SkillNewParams.md) diff --git a/docs/api/managed/type-aliases/SkillRetrieveParams.md b/docs/api/managed/type-aliases/SkillRetrieveParams.md new file mode 100644 index 0000000..32a31a7 --- /dev/null +++ b/docs/api/managed/type-aliases/SkillRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillRetrieveParams + +# Type Alias: SkillRetrieveParams + +> **SkillRetrieveParams** = [`SkillGetParams`](../interfaces/SkillGetParams.md) diff --git a/docs/api/managed/type-aliases/SkillSource.md b/docs/api/managed/type-aliases/SkillSource.md new file mode 100644 index 0000000..d9c5653 --- /dev/null +++ b/docs/api/managed/type-aliases/SkillSource.md @@ -0,0 +1,34 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillSource + +# Type Alias: SkillSource + +> **SkillSource** = `string` \| \{ `type`: [`SkillSourceType`](SkillSourceType.md); \} + +## Union Members + +`string` + +*** + +### Type Literal + +\{ `type`: [`SkillSourceType`](SkillSourceType.md); \} + +#### type + +> **type**: [`SkillSourceType`](SkillSourceType.md) + +Where the Skill comes from. + +Possible values: + +- `"custom"`: authored by the platform user; private to their workspace +- `"qoder"`: published by Qoder; shared and read-only +- `"qoder_example"`: Qoder-published sample Skill +- `"plugin"`: resolved from an installed plugin + +Any of "custom", "qoder", "qoder_example", "plugin". diff --git a/docs/api/managed/type-aliases/SkillSourceType.md b/docs/api/managed/type-aliases/SkillSourceType.md new file mode 100644 index 0000000..dcde941 --- /dev/null +++ b/docs/api/managed/type-aliases/SkillSourceType.md @@ -0,0 +1,18 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillSourceType + +# Type Alias: SkillSourceType + +> **SkillSourceType** = `"custom"` \| `"qoder"` \| `"qoder_example"` \| `"plugin"` + +Where the Skill comes from. + +Possible values: + +- `"custom"`: authored by the platform user; private to their workspace +- `"qoder"`: published by Qoder; shared and read-only +- `"qoder_example"`: Qoder-published sample Skill +- `"plugin"`: resolved from an installed plugin diff --git a/docs/api/managed/type-aliases/SkillVersionCreateParams.md b/docs/api/managed/type-aliases/SkillVersionCreateParams.md new file mode 100644 index 0000000..bb907c9 --- /dev/null +++ b/docs/api/managed/type-aliases/SkillVersionCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillVersionCreateParams + +# Type Alias: SkillVersionCreateParams + +> **SkillVersionCreateParams** = [`SkillVersionNewParams`](../interfaces/SkillVersionNewParams.md) diff --git a/docs/api/managed/type-aliases/SkillVersionRetrieveParams.md b/docs/api/managed/type-aliases/SkillVersionRetrieveParams.md new file mode 100644 index 0000000..c0ef573 --- /dev/null +++ b/docs/api/managed/type-aliases/SkillVersionRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / SkillVersionRetrieveParams + +# Type Alias: SkillVersionRetrieveParams + +> **SkillVersionRetrieveParams** = [`SkillVersionGetParams`](../interfaces/SkillVersionGetParams.md) diff --git a/docs/api/managed/type-aliases/TextCitationParamUnion.md b/docs/api/managed/type-aliases/TextCitationParamUnion.md new file mode 100644 index 0000000..e9b346b --- /dev/null +++ b/docs/api/managed/type-aliases/TextCitationParamUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextCitationParamUnion + +# Type Alias: TextCitationParamUnion + +> **TextCitationParamUnion** = [`CitationCharLocationParam`](../interfaces/CitationCharLocationParam.md) \| [`CitationPageLocationParam`](../interfaces/CitationPageLocationParam.md) \| [`CitationContentBlockLocationParam`](../interfaces/CitationContentBlockLocationParam.md) \| [`CitationWebSearchResultLocationParam`](../interfaces/CitationWebSearchResultLocationParam.md) \| [`CitationSearchResultLocationParam`](../interfaces/CitationSearchResultLocationParam.md) diff --git a/docs/api/managed/type-aliases/TextEditorCodeExecutionToolResultBlockParamContentUnion.md b/docs/api/managed/type-aliases/TextEditorCodeExecutionToolResultBlockParamContentUnion.md new file mode 100644 index 0000000..4e4d75c --- /dev/null +++ b/docs/api/managed/type-aliases/TextEditorCodeExecutionToolResultBlockParamContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextEditorCodeExecutionToolResultBlockParamContentUnion + +# Type Alias: TextEditorCodeExecutionToolResultBlockParamContentUnion + +> **TextEditorCodeExecutionToolResultBlockParamContentUnion** = [`TextEditorCodeExecutionToolResultErrorParam`](../interfaces/TextEditorCodeExecutionToolResultErrorParam.md) \| [`TextEditorCodeExecutionViewResultBlockParam`](../interfaces/TextEditorCodeExecutionViewResultBlockParam.md) \| [`TextEditorCodeExecutionCreateResultBlockParam`](../interfaces/TextEditorCodeExecutionCreateResultBlockParam.md) \| [`TextEditorCodeExecutionStrReplaceResultBlockParam`](../interfaces/TextEditorCodeExecutionStrReplaceResultBlockParam.md) diff --git a/docs/api/managed/type-aliases/TextEditorCodeExecutionToolResultErrorParamErrorCode.md b/docs/api/managed/type-aliases/TextEditorCodeExecutionToolResultErrorParamErrorCode.md new file mode 100644 index 0000000..9cff291 --- /dev/null +++ b/docs/api/managed/type-aliases/TextEditorCodeExecutionToolResultErrorParamErrorCode.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextEditorCodeExecutionToolResultErrorParamErrorCode + +# Type Alias: TextEditorCodeExecutionToolResultErrorParamErrorCode + +> **TextEditorCodeExecutionToolResultErrorParamErrorCode** = `string` diff --git a/docs/api/managed/type-aliases/TextEditorCodeExecutionViewResultBlockParamFileType.md b/docs/api/managed/type-aliases/TextEditorCodeExecutionViewResultBlockParamFileType.md new file mode 100644 index 0000000..c67752b --- /dev/null +++ b/docs/api/managed/type-aliases/TextEditorCodeExecutionViewResultBlockParamFileType.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / TextEditorCodeExecutionViewResultBlockParamFileType + +# Type Alias: TextEditorCodeExecutionViewResultBlockParamFileType + +> **TextEditorCodeExecutionViewResultBlockParamFileType** = `string` diff --git a/docs/api/managed/type-aliases/ToolResultBlockParamContentUnion.md b/docs/api/managed/type-aliases/ToolResultBlockParamContentUnion.md new file mode 100644 index 0000000..e6660cb --- /dev/null +++ b/docs/api/managed/type-aliases/ToolResultBlockParamContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolResultBlockParamContentUnion + +# Type Alias: ToolResultBlockParamContentUnion + +> **ToolResultBlockParamContentUnion** = [`TextBlockParam`](../interfaces/TextBlockParam.md) \| [`ImageBlockParam`](../interfaces/ImageBlockParam.md) \| [`SearchResultBlockParam`](../interfaces/SearchResultBlockParam.md) \| [`RequestDocumentBlockParam`](../interfaces/RequestDocumentBlockParam.md) \| [`ToolReferenceBlockParam`](../interfaces/ToolReferenceBlockParam.md) \| [`BrowserStateBlockParam`](../interfaces/BrowserStateBlockParam.md) diff --git a/docs/api/managed/type-aliases/ToolSearchToolResultBlockParamContentUnion.md b/docs/api/managed/type-aliases/ToolSearchToolResultBlockParamContentUnion.md new file mode 100644 index 0000000..ae03714 --- /dev/null +++ b/docs/api/managed/type-aliases/ToolSearchToolResultBlockParamContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolSearchToolResultBlockParamContentUnion + +# Type Alias: ToolSearchToolResultBlockParamContentUnion + +> **ToolSearchToolResultBlockParamContentUnion** = [`ToolSearchToolResultErrorParam`](../interfaces/ToolSearchToolResultErrorParam.md) \| [`ToolSearchToolSearchResultBlockParam`](../interfaces/ToolSearchToolSearchResultBlockParam.md) diff --git a/docs/api/managed/type-aliases/ToolSearchToolResultErrorParamErrorCode.md b/docs/api/managed/type-aliases/ToolSearchToolResultErrorParamErrorCode.md new file mode 100644 index 0000000..0f6afee --- /dev/null +++ b/docs/api/managed/type-aliases/ToolSearchToolResultErrorParamErrorCode.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolSearchToolResultErrorParamErrorCode + +# Type Alias: ToolSearchToolResultErrorParamErrorCode + +> **ToolSearchToolResultErrorParamErrorCode** = `string` diff --git a/docs/api/managed/type-aliases/ToolUseBlockParamCallerUnion.md b/docs/api/managed/type-aliases/ToolUseBlockParamCallerUnion.md new file mode 100644 index 0000000..d0f7d12 --- /dev/null +++ b/docs/api/managed/type-aliases/ToolUseBlockParamCallerUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / ToolUseBlockParamCallerUnion + +# Type Alias: ToolUseBlockParamCallerUnion + +> **ToolUseBlockParamCallerUnion** = [`DirectCallerParam`](../interfaces/DirectCallerParam.md) \| [`ServerToolCallerParam`](../interfaces/ServerToolCallerParam.md) \| [`ServerToolCaller20260120Param`](../interfaces/ServerToolCaller20260120Param.md) diff --git a/docs/api/managed/type-aliases/VaultCreateParams.md b/docs/api/managed/type-aliases/VaultCreateParams.md new file mode 100644 index 0000000..ec392b6 --- /dev/null +++ b/docs/api/managed/type-aliases/VaultCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCreateParams + +# Type Alias: VaultCreateParams + +> **VaultCreateParams** = [`VaultNewParams`](../interfaces/VaultNewParams.md) diff --git a/docs/api/managed/type-aliases/VaultCredentialCreateParams.md b/docs/api/managed/type-aliases/VaultCredentialCreateParams.md new file mode 100644 index 0000000..eb3d91b --- /dev/null +++ b/docs/api/managed/type-aliases/VaultCredentialCreateParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialCreateParams + +# Type Alias: VaultCredentialCreateParams + +> **VaultCredentialCreateParams** = [`VaultCredentialNewParams`](../interfaces/VaultCredentialNewParams.md) diff --git a/docs/api/managed/type-aliases/VaultCredentialNewParamsAuthUnion.md b/docs/api/managed/type-aliases/VaultCredentialNewParamsAuthUnion.md new file mode 100644 index 0000000..e256243 --- /dev/null +++ b/docs/api/managed/type-aliases/VaultCredentialNewParamsAuthUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialNewParamsAuthUnion + +# Type Alias: VaultCredentialNewParamsAuthUnion + +> **VaultCredentialNewParamsAuthUnion** = [`ManagedAgentsMCPOAuthCreateParams`](../interfaces/ManagedAgentsMCPOAuthCreateParams.md) \| [`ManagedAgentsStaticBearerCreateParams`](../interfaces/ManagedAgentsStaticBearerCreateParams.md) \| [`ManagedAgentsEnvironmentVariableCreateParams`](../interfaces/ManagedAgentsEnvironmentVariableCreateParams.md) diff --git a/docs/api/managed/type-aliases/VaultCredentialRetrieveParams.md b/docs/api/managed/type-aliases/VaultCredentialRetrieveParams.md new file mode 100644 index 0000000..41e5f13 --- /dev/null +++ b/docs/api/managed/type-aliases/VaultCredentialRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialRetrieveParams + +# Type Alias: VaultCredentialRetrieveParams + +> **VaultCredentialRetrieveParams** = [`VaultCredentialGetParams`](../interfaces/VaultCredentialGetParams.md) diff --git a/docs/api/managed/type-aliases/VaultCredentialUpdateParamsAuthUnion.md b/docs/api/managed/type-aliases/VaultCredentialUpdateParamsAuthUnion.md new file mode 100644 index 0000000..bf4e360 --- /dev/null +++ b/docs/api/managed/type-aliases/VaultCredentialUpdateParamsAuthUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultCredentialUpdateParamsAuthUnion + +# Type Alias: VaultCredentialUpdateParamsAuthUnion + +> **VaultCredentialUpdateParamsAuthUnion** = [`ManagedAgentsMCPOAuthUpdateParams`](../interfaces/ManagedAgentsMCPOAuthUpdateParams.md) \| [`ManagedAgentsStaticBearerUpdateParams`](../interfaces/ManagedAgentsStaticBearerUpdateParams.md) \| [`ManagedAgentsEnvironmentVariableUpdateParams`](../interfaces/ManagedAgentsEnvironmentVariableUpdateParams.md) diff --git a/docs/api/managed/type-aliases/VaultRetrieveParams.md b/docs/api/managed/type-aliases/VaultRetrieveParams.md new file mode 100644 index 0000000..af3faa5 --- /dev/null +++ b/docs/api/managed/type-aliases/VaultRetrieveParams.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / VaultRetrieveParams + +# Type Alias: VaultRetrieveParams + +> **VaultRetrieveParams** = [`VaultGetParams`](../interfaces/VaultGetParams.md) diff --git a/docs/api/managed/type-aliases/WebFetchToolResultBlockParamCallerUnion.md b/docs/api/managed/type-aliases/WebFetchToolResultBlockParamCallerUnion.md new file mode 100644 index 0000000..2c267cf --- /dev/null +++ b/docs/api/managed/type-aliases/WebFetchToolResultBlockParamCallerUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebFetchToolResultBlockParamCallerUnion + +# Type Alias: WebFetchToolResultBlockParamCallerUnion + +> **WebFetchToolResultBlockParamCallerUnion** = [`DirectCallerParam`](../interfaces/DirectCallerParam.md) \| [`ServerToolCallerParam`](../interfaces/ServerToolCallerParam.md) \| [`ServerToolCaller20260120Param`](../interfaces/ServerToolCaller20260120Param.md) diff --git a/docs/api/managed/type-aliases/WebFetchToolResultBlockParamContentUnion.md b/docs/api/managed/type-aliases/WebFetchToolResultBlockParamContentUnion.md new file mode 100644 index 0000000..3649641 --- /dev/null +++ b/docs/api/managed/type-aliases/WebFetchToolResultBlockParamContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebFetchToolResultBlockParamContentUnion + +# Type Alias: WebFetchToolResultBlockParamContentUnion + +> **WebFetchToolResultBlockParamContentUnion** = [`WebFetchToolResultErrorBlockParam`](../interfaces/WebFetchToolResultErrorBlockParam.md) \| [`WebFetchBlockParam`](../interfaces/WebFetchBlockParam.md) diff --git a/docs/api/managed/type-aliases/WebFetchToolResultErrorCode.md b/docs/api/managed/type-aliases/WebFetchToolResultErrorCode.md new file mode 100644 index 0000000..a73411b --- /dev/null +++ b/docs/api/managed/type-aliases/WebFetchToolResultErrorCode.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebFetchToolResultErrorCode + +# Type Alias: WebFetchToolResultErrorCode + +> **WebFetchToolResultErrorCode** = `string` diff --git a/docs/api/managed/type-aliases/WebSearchToolResultBlockParamCallerUnion.md b/docs/api/managed/type-aliases/WebSearchToolResultBlockParamCallerUnion.md new file mode 100644 index 0000000..30826df --- /dev/null +++ b/docs/api/managed/type-aliases/WebSearchToolResultBlockParamCallerUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebSearchToolResultBlockParamCallerUnion + +# Type Alias: WebSearchToolResultBlockParamCallerUnion + +> **WebSearchToolResultBlockParamCallerUnion** = [`DirectCallerParam`](../interfaces/DirectCallerParam.md) \| [`ServerToolCallerParam`](../interfaces/ServerToolCallerParam.md) \| [`ServerToolCaller20260120Param`](../interfaces/ServerToolCaller20260120Param.md) diff --git a/docs/api/managed/type-aliases/WebSearchToolResultBlockParamContentUnion.md b/docs/api/managed/type-aliases/WebSearchToolResultBlockParamContentUnion.md new file mode 100644 index 0000000..c3c7351 --- /dev/null +++ b/docs/api/managed/type-aliases/WebSearchToolResultBlockParamContentUnion.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebSearchToolResultBlockParamContentUnion + +# Type Alias: WebSearchToolResultBlockParamContentUnion + +> **WebSearchToolResultBlockParamContentUnion** = [`WebSearchResultBlockParam`](../interfaces/WebSearchResultBlockParam.md)[] \| [`WebSearchToolRequestErrorParam`](../interfaces/WebSearchToolRequestErrorParam.md) diff --git a/docs/api/managed/type-aliases/WebSearchToolResultErrorCode.md b/docs/api/managed/type-aliases/WebSearchToolResultErrorCode.md new file mode 100644 index 0000000..547721d --- /dev/null +++ b/docs/api/managed/type-aliases/WebSearchToolResultErrorCode.md @@ -0,0 +1,9 @@ +[**qca-sdk**](../../README.md) + +*** + +[qca-sdk](../../README.md) / [managed](../README.md) / WebSearchToolResultErrorCode + +# Type Alias: WebSearchToolResultErrorCode + +> **WebSearchToolResultErrorCode** = `string` diff --git a/docs/metadata.yaml b/docs/metadata.yaml new file mode 100644 index 0000000..1786ada --- /dev/null +++ b/docs/metadata.yaml @@ -0,0 +1,22 @@ +# docs/metadata.yaml — supplements the generated API reference. +# +# Consumed by scripts/generate-docs.mjs. This file only controls presentation: +# module ordering on the index page, symbols to hide, and related links. +# It deliberately does NOT duplicate parameter or return models — those come +# from the source JSDoc via TypeDoc. + +# Order of the top-level entry-point modules on docs/api/README.md. +order: + - index + - forward + - managed + +# Public export names to hide from the generated index (exact symbol names). +hidden: [] + +# Extra links appended to the generated index page under a "Related" heading. +relatedLinks: + - title: README + url: ../../README.md + - title: Examples + url: ../../examples diff --git a/package-lock.json b/package-lock.json index 587856b..0ca2e1e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,12 +9,262 @@ "version": "0.1.0", "license": "MIT", "devDependencies": { + "typedoc": "^0.28.20", + "typedoc-plugin-markdown": "^4.13.0", "typescript": "^5.8.3" }, "engines": { "node": ">=20.12.0" } }, + "node_modules/@gerrit0/mini-shiki": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.23.0.tgz", + "integrity": "sha512-bEMORlG0cqdjVyCEuU0cDQbORWX+kYCeo0kV1lbxF5bt4r7SID2l9bqsxJEM0zndaxpOUT7riCyIVEuqq/Ynxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/engine-oniguruma": "^3.23.0", + "@shikijs/langs": "^3.23.0", + "@shikijs/themes": "^3.23.0", + "@shikijs/types": "^3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz", + "integrity": "sha512-1nWINwKXxKKLqPibT5f4pAFLej9oZzQTsby8942OTlsJzOBZ0MWKiwzMsd+jhzu8YPCHAswGnnN1YtQfirL35g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.23.0.tgz", + "integrity": "sha512-2Ep4W3Re5aB1/62RSYQInK9mM3HsLeB91cHqznAJMuylqjzNVAVCMnNWRHFtcNHXsoNRayP9z1qj4Sq3nMqYXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.23.0.tgz", + "integrity": "sha512-5qySYa1ZgAT18HR/ypENL9cUSGOeI2x+4IvYJu4JgVJdizn6kG4ia5Q1jDEOi7gTbN4RbuYtmHh0W3eccOrjMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/types": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.23.0.tgz", + "integrity": "sha512-3JZ5HXOZfYjsYSk0yPwBrkupyYSLpAE26Qc0HLghhZNGTZg/SKxXIIgoxOpmmeQP0RRSDJTk1/vPfw9tbw+jSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/hast": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.5.tgz", + "integrity": "sha512-rp/ezSWaD1m44dPKICGhiskI13nVr7qTloFwDa/IYkhhf5nzwP+zIQcIJh3WIFSBOy/H1PzB40jPjMDksN4F+g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true, + "license": "Python-2.0" + }, + "node_modules/balanced-match": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", + "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/brace-expansion": { + "version": "5.0.12", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.12.tgz", + "integrity": "sha512-YovQ3rzhaLMIrDjNDMkNS01tea93qhEhG5xy8f6+R0l+dw3Ki+5sCoIoI942iuLZTHWogWktgwVDhU09iNEimQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^4.0.2" + }, + "engines": { + "node": "20 || >=22" + } + }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/linkify-it": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.2.tgz", + "integrity": "sha512-ONTm2jCMAVZjgQa/Fy1kScXsuOoF5NPTsoFBdE1KVIZ2vAh/r9+Bqo+0jINCBYnavTPQZz38QzFTme79ENoN3Q==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/markdown-it" + } + ], + "license": "MIT", + "dependencies": { + "uc.micro": "^2.0.0" + } + }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true, + "license": "MIT" + }, + "node_modules/markdown-it": { + "version": "14.3.2", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.3.2.tgz", + "integrity": "sha512-sHHjZ5fJKlgrG4qns2YwVcdNep35h5fERrfkD2YNsb9UFk0UIHarbiTaHKVMlPuWAoiilyK8Fv/jAm11slsY7Q==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/markdown-it" + } + ], + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.5.0", + "linkify-it": "^5.0.2", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, + "node_modules/mdurl": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.1.0.tgz", + "integrity": "sha512-1+HBaOx0zi/dQWht8rNv9MYf9qqpqL/kxI0hXImU6Y547zM6Sni8BQibt7ifgMcYtQg41ao3Ivd6cnSM86inpg==", + "dev": true, + "license": "MIT" + }, + "node_modules/minimatch": { + "version": "10.2.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.6.tgz", + "integrity": "sha512-vpLQEs+VLCr1nU0BXS07maYoFwlDAH0gngQuuttxIwutDFEMHq2blX+8vpgxDdK3J1PwjCJiep77OitTZ4Ll1A==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "brace-expansion": "^5.0.8" + }, + "engines": { + "node": "18 || 20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/typedoc": { + "version": "0.28.20", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.20.tgz", + "integrity": "sha512-uSKqkh8Cr48vllnEy+jdaAgOeR6Y+QCBW7usgUsKj7gJEfR7stw9U/fE49LBnj2tPRKPY0c0EBJSWe9Appmplg==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@gerrit0/mini-shiki": "^3.23.0", + "lunr": "^2.3.9", + "markdown-it": "^14.3.0", + "minimatch": "^10.2.5", + "yaml": "^2.9.0" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 18", + "pnpm": ">= 10" + }, + "peerDependencies": { + "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x || 6.0.x" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "4.13.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.13.0.tgz", + "integrity": "sha512-OHaOLoMTS0wL2ud73WXvxv486mrUEtgXxW4iKiTOGJVipT/VBWY76rlVRMQGes7aVonoIf5roWRe1UvHbufLlQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "typedoc": "0.28.x" + } + }, "node_modules/typescript": { "version": "5.9.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", @@ -28,6 +278,29 @@ "engines": { "node": ">=14.17" } + }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true, + "license": "MIT" + }, + "node_modules/yaml": { + "version": "2.9.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.1.tgz", + "integrity": "sha512-3NxN8+78OdzbT7C/WjGsyfPAtJaN3FNDsWxv7Y7mcDsT/oOmgW8BpyQQFFBnvZE3j9Y2Sdz1ULFLezL7Eb2yFw==", + "dev": true, + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14.6" + }, + "funding": { + "url": "https://github.com/sponsors/eemeli" + } } } } diff --git a/package.json b/package.json index 1a698e4..322593e 100644 --- a/package.json +++ b/package.json @@ -76,9 +76,12 @@ "prepack": "npm run build", "test:types": "tsc -p tsconfig.types.json", "test:e2e": "npm test && node scripts/run-live.mjs e2e", - "example": "npm run build && node examples/run.mjs" + "example": "npm run build && node examples/run.mjs", + "docs": "node scripts/generate-docs.mjs" }, "devDependencies": { + "typedoc": "^0.28.20", + "typedoc-plugin-markdown": "^4.13.0", "typescript": "^5.8.3" }, "type": "commonjs", diff --git a/scripts/generate-docs.mjs b/scripts/generate-docs.mjs new file mode 100644 index 0000000..1e492b4 --- /dev/null +++ b/scripts/generate-docs.mjs @@ -0,0 +1,177 @@ +import { spawnSync } from 'node:child_process'; +import { readFile, writeFile, readdir, rm, stat } from 'node:fs/promises'; +import { fileURLToPath } from 'node:url'; +import path from 'node:path'; + +// Deterministic API reference generator. +// +// Runs TypeDoc + typedoc-plugin-markdown over the public `src/` entry points and +// writes Markdown to docs/api/. TypeDoc's default source links embed absolute +// paths, line numbers and a generator footer, all of which change across +// machines or checkouts; we disable those inputs and then post-process every +// file so that re-running on the same commit yields byte-identical output. + +const repoRoot = path.resolve(fileURLToPath(new URL('..', import.meta.url))); +const outDir = path.join(repoRoot, 'docs', 'api'); +const metadataPath = path.join(repoRoot, 'docs', 'metadata.yaml'); + +// Public entry points, mirroring package.json "exports" (".", "./forward", +// "./managed"). The generator only reads exported symbols, types and JSDoc. +const entryPoints = ['src/index.ts', 'src/forward/index.ts', 'src/managed/index.ts']; + +/** + * Minimal parser for the fixed docs/metadata.yaml shape: + * order: [scalar] (top-level scalar list) + * hidden: [scalar] (top-level scalar list, may be `[]`) + * relatedLinks: [ {title, url} ] (list of maps) + * It intentionally supports only this structure, not general YAML. + */ +function parseMetadata(text) { + const result = { order: [], hidden: [], relatedLinks: [] }; + const lines = text.split('\n'); + let section = null; + for (const raw of lines) { + const line = raw.replace(/\r$/, ''); + if (line.trim() === '' || line.trim().startsWith('#')) continue; + + const topMatch = /^([A-Za-z0-9_]+):\s*(.*)$/.exec(line); + if (topMatch && !line.startsWith(' ')) { + const key = topMatch[1]; + const inline = topMatch[2].trim(); + section = key; + if (inline === '[]') result[key] = []; + continue; + } + + const listMatch = /^\s+-\s+(.*)$/.exec(line); + if (listMatch && section) { + const item = listMatch[1].trim(); + const kv = /^([A-Za-z0-9_]+):\s*(.*)$/.exec(item); + if (kv) { + result[section].push({ [kv[1]]: kv[2].trim() }); + } else { + result[section].push(item); + } + continue; + } + + // Continuation key for the previous map entry (e.g. relatedLinks url). + const contMatch = /^\s+([A-Za-z0-9_]+):\s*(.*)$/.exec(line); + if (contMatch && section) { + const list = result[section]; + const last = list[list.length - 1]; + if (last && typeof last === 'object') last[contMatch[1]] = contMatch[2].trim(); + } + } + return result; +} + +async function walkMarkdown(dir) { + const files = []; + const entries = (await readdir(dir)).sort(); + for (const name of entries) { + const full = path.join(dir, name); + const info = await stat(full); + if (info.isDirectory()) { + files.push(...(await walkMarkdown(full))); + } else if (name.endsWith('.md')) { + files.push(full); + } + } + return files; +} + +/** Strip any non-deterministic fragments TypeDoc may inject. */ +function stripNonDeterministic(content) { + let text = content.replace(/\r\n/g, '\n'); + const out = []; + for (const line of text.split('\n')) { + // Generator/version footer lines (defensive; --hideGenerator already omits). + if (/generated using \[?typedoc/i.test(line)) continue; + if (/last (?:modified|updated)/i.test(line)) continue; + // Absolute paths that could leak the build machine's layout. + const scrubbed = line + .split(repoRoot).join('.') + .replace(/\/(?:private\/)?var\/folders\/[^\s)`]+/g, '.') + .replace(/\/Users\/[^\s)`]+/g, '.'); + out.push(scrubbed); + } + return out.join('\n').replace(/\n+$/, '') + '\n'; +} + +/** Apply docs/metadata.yaml to the generated top-level index page. */ +function applyMetadata(indexContent, metadata) { + const lines = indexContent.split('\n'); + const start = lines.findIndex((l) => l.trim() === '## Modules'); + if (start === -1) return indexContent; + + let end = start + 1; + while (end < lines.length && !/^## /.test(lines[end])) end += 1; + + const bullets = lines.slice(start + 1, end).filter((l) => l.trim().startsWith('- ')); + const nameOf = (bullet) => { + const m = /\[([^\]]+)\]/.exec(bullet); + return m ? m[1] : bullet; + }; + + let kept = bullets.filter((b) => !metadata.hidden.includes(nameOf(b))); + if (metadata.order.length) { + const rank = new Map(metadata.order.map((name, i) => [name, i])); + kept = kept + .map((b, i) => ({ b, name: nameOf(b), i })) + .sort((a, x) => { + const ra = rank.has(a.name) ? rank.get(a.name) : Number.MAX_SAFE_INTEGER; + const rx = rank.has(x.name) ? rank.get(x.name) : Number.MAX_SAFE_INTEGER; + return ra !== rx ? ra - rx : a.i - x.i; + }) + .map((e) => e.b); + } + + const rebuilt = [...lines.slice(0, start + 1), '', ...kept, '', ...lines.slice(end)]; + + let result = rebuilt.join('\n'); + if (metadata.relatedLinks.length) { + const links = metadata.relatedLinks + .filter((l) => l && l.title && l.url) + .map((l) => `- [${l.title}](${l.url})`); + if (links.length) { + result = `${result.replace(/\n+$/, '')}\n\n## Related\n\n${links.join('\n')}\n`; + } + } + return result; +} + +async function main() { + const metadata = parseMetadata(await readFile(metadataPath, 'utf8')); + + await rm(outDir, { recursive: true, force: true }); + + const typedocBin = path.join(repoRoot, 'node_modules', 'typedoc', 'bin', 'typedoc'); + const args = [ + typedocBin, + '--plugin', 'typedoc-plugin-markdown', + '--tsconfig', path.join(repoRoot, 'tsconfig.json'), + '--out', outDir, + '--readme', 'none', + '--disableSources', + '--hideGenerator', + ]; + for (const ep of entryPoints) args.push('--entryPoints', ep); + + const run = spawnSync(process.execPath, args, { cwd: repoRoot, stdio: 'inherit' }); + if (run.status !== 0) process.exit(run.status ?? 1); + + const files = await walkMarkdown(outDir); + for (const file of files) { + const original = await readFile(file, 'utf8'); + let cleaned = stripNonDeterministic(original); + if (path.resolve(file) === path.join(outDir, 'README.md')) { + cleaned = stripNonDeterministic(applyMetadata(cleaned, metadata)); + } + if (cleaned !== original) await writeFile(file, cleaned); + } + + console.log(`docs/api generated (${files.length} files)`); +} + +await main(); From 61d558b0575f14191f9add72bf6bae23d42676a7 Mon Sep 17 00:00:00 2001 From: moonyue-w <300878504+moonyue-w@users.noreply.github.com> Date: Fri, 18 Sep 2026 16:23:52 +0800 Subject: [PATCH 2/3] feat(docs): add docs-check gate for generated reference --- Makefile | 5 +- package.json | 3 +- scripts/docs-check.mjs | 229 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 235 insertions(+), 2 deletions(-) create mode 100644 scripts/docs-check.mjs diff --git a/Makefile b/Makefile index 37647fd..a84adfb 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ LIVE_ENV_FILE ?= .env.live .DEFAULT_GOAL := test -.PHONY: build test test-unit test-contract test-scenarios test-live test-live-managed test-live-all test-live-check test-e2e docs +.PHONY: build test test-unit test-contract test-scenarios test-live test-live-managed test-live-all test-live-check test-e2e docs docs-check build: npm run build @@ -9,6 +9,9 @@ build: docs: npm run docs +docs-check: + npm run docs:check + test: npm test diff --git a/package.json b/package.json index 322593e..771bc8b 100644 --- a/package.json +++ b/package.json @@ -77,7 +77,8 @@ "test:types": "tsc -p tsconfig.types.json", "test:e2e": "npm test && node scripts/run-live.mjs e2e", "example": "npm run build && node examples/run.mjs", - "docs": "node scripts/generate-docs.mjs" + "docs": "node scripts/generate-docs.mjs", + "docs:check": "node scripts/docs-check.mjs" }, "devDependencies": { "typedoc": "^0.28.20", diff --git a/scripts/docs-check.mjs b/scripts/docs-check.mjs new file mode 100644 index 0000000..dcf5714 --- /dev/null +++ b/scripts/docs-check.mjs @@ -0,0 +1,229 @@ +import { spawnSync } from 'node:child_process'; +import { readFile, readdir, stat, rm, mkdir, writeFile } from 'node:fs/promises'; +import { existsSync } from 'node:fs'; +import { fileURLToPath } from 'node:url'; +import os from 'node:os'; +import path from 'node:path'; + +// docs-check gate. +// +// Verifies that the committed API reference is a byte-for-byte match of what the +// deterministic generator produces from the current source, that generated docs +// contain no dangling internal links, and that the README's TypeScript snippets +// still compile against the public type surface. External http(s) links are +// reported but never block. The whole check runs offline: it reads no PAT and +// contacts no live environment. + +const repoRoot = path.resolve(fileURLToPath(new URL('..', import.meta.url))); +const docsDir = path.join(repoRoot, 'docs', 'api'); +const readmePath = path.join(repoRoot, 'README.md'); +const scratchDir = path.join(os.tmpdir(), 'qca-sdk-docs-check'); + +function run(cmd, args, opts = {}) { + return spawnSync(cmd, args, { cwd: repoRoot, encoding: 'utf8', ...opts }); +} + +function fail(message, detail) { + console.error(`docs-check: FAIL — ${message}`); + if (detail) console.error(detail); + process.exit(1); +} + +async function walkMarkdown(dir) { + const files = []; + const entries = (await readdir(dir)).sort(); + for (const name of entries) { + const full = path.join(dir, name); + const info = await stat(full); + if (info.isDirectory()) files.push(...(await walkMarkdown(full))); + else if (name.endsWith('.md')) files.push(full); + } + return files; +} + +// --- Step 1: clear any leftover temporary output from a previous run. -------- +async function clearScratch() { + await rm(scratchDir, { recursive: true, force: true }); +} + +// --- Step 2: regenerate docs/api deterministically. -------------------------- +// Returns the set of relative link targets that TypeDoc reports as "not a file +// and will not be copied": these are JSDoc-authored references to hand-written +// companion documents outside the generated reference, not cross-references +// between generated pages, so the link check treats them as external. +function regenerate() { + const result = run(process.execPath, [path.join(repoRoot, 'scripts', 'generate-docs.mjs')]); + const output = `${result.stdout || ''}${result.stderr || ''}`; + process.stdout.write(output); + if (result.status !== 0) fail('docs generation failed'); + + const notCopied = new Set(); + const warnRe = /The relative path (.+?) is not a file and will not be copied/g; + let m; + while ((m = warnRe.exec(output)) !== null) { + notCopied.add(m[1].split('#')[0]); + } + return notCopied; +} + +// --- Step 3: committed docs/api must equal freshly generated output. --------- +function assertNoDrift() { + const diff = run('git', ['diff', '--exit-code', '--', 'docs/api']); + const untracked = run('git', ['ls-files', '--others', '--exclude-standard', '--', 'docs/api']); + const hasUntracked = untracked.status === 0 && untracked.stdout.trim() !== ''; + if (diff.status !== 0 || hasUntracked) { + const detail = [diff.stdout, hasUntracked ? `untracked:\n${untracked.stdout}` : ''] + .filter(Boolean) + .join('\n'); + fail('committed docs/api differs from generated output; run `npm run docs` and commit', detail); + } +} + +// --- Step 4: internal relative links in docs/api must resolve. ---------------- +// External references are reported but never block: http(s) and protocol- +// relative URLs, site-absolute paths ("/en/..."), and JSDoc-authored links to +// non-generated companion docs (per TypeDoc's "will not be copied" warnings). +// A relative link pointing at another generated page that no longer exists is a +// broken cross-reference and fails the gate. +async function checkLinks(notCopied) { + const files = await walkMarkdown(docsDir); + const linkRe = /\]\(([^)]+)\)/g; + const broken = []; + let externalCount = 0; + for (const file of files) { + const content = await readFile(file, 'utf8'); + let match; + while ((match = linkRe.exec(content)) !== null) { + let target = match[1].trim(); + if (target.startsWith('<') && target.endsWith('>')) target = target.slice(1, -1); + if (target === '') continue; + // External / non-blocking: http(s), protocol-relative, site-absolute. + if (/^(https?:)?\/\//i.test(target) || target.startsWith('/')) { + externalCount += 1; + continue; + } + if (target.startsWith('#') || target.startsWith('mailto:')) continue; + const clean = target.split('#')[0].split('?')[0]; + if (clean === '') continue; + // External / non-blocking: authored references to non-generated companion docs. + if (notCopied.has(clean)) { + externalCount += 1; + continue; + } + const resolved = path.resolve(path.dirname(file), clean); + if (!existsSync(resolved)) { + broken.push(`${path.relative(repoRoot, file)} -> ${target}`); + } + } + } + if (broken.length) { + fail(`${broken.length} dangling internal link(s) in docs/api`, broken.join('\n')); + } + console.log(`docs-check: internal links OK; ${externalCount} external/non-generated link(s) reported (not blocking)`); +} + +// --- Step 5: extract README TypeScript snippets and type-check them. ---------- +function extractTsSnippets(readme) { + const lines = readme.split('\n'); + const snippets = []; + let current = null; + for (const line of lines) { + if (current === null) { + if (/^```ts\s*$/.test(line.trim())) current = []; + } else if (line.trim() === '```') { + snippets.push(current.join('\n')); + current = null; + } else { + current.push(line); + } + } + return snippets; +} + +async function checkReadmeSnippets() { + const readme = await readFile(readmePath, 'utf8'); + const snippets = extractTsSnippets(readme); + if (snippets.length === 0) { + console.log('docs-check: no README ts snippets to compile'); + return; + } + + await mkdir(scratchDir, { recursive: true }); + + // Ambient declarations for the illustrative identifiers the README uses + // without setup: the two clients (typed, so option shapes are still checked) + // plus assorted free variables and the Node builtins referenced by upload + // examples. Local declarations inside a snippet shadow these. This is an + // ambient script file (no import/export), so the declarations stay global. + // It keeps snippet compilation focused on import resolution, option shapes + // and syntax rather than on reconstructing full runnable programs. + const globals = `declare const ForwardClient: typeof import('qca-sdk').ForwardClient; +declare const ManagedClient: typeof import('qca-sdk').ManagedClient; +declare const client: any; +declare const forward: any; +declare const managed: any; +declare const session: any; +declare const stream: any; +declare const previousEventID: any; +declare const uploaded: any; +declare const params: any; +declare const process: any; +declare const fs: any; +declare module 'node:fs'; +`; + await writeFile(path.join(scratchDir, 'globals.d.ts'), globals); + + const files = []; + for (let i = 0; i < snippets.length; i += 1) { + const file = path.join(scratchDir, `snippet-${String(i).padStart(3, '0')}.mts`); + await writeFile(file, `${snippets[i]}\n`); + files.push(file); + } + + const tsconfig = { + compilerOptions: { + noEmit: true, + strict: true, + target: 'ES2022', + lib: ['ES2022', 'DOM', 'DOM.Iterable'], + module: 'Node16', + moduleResolution: 'Node16', + skipLibCheck: true, + baseUrl: repoRoot, + types: [], + paths: { + 'qca-sdk': ['src/index.ts'], + 'qca-sdk/forward': ['src/forward/index.ts'], + 'qca-sdk/managed': ['src/managed/index.ts'], + }, + }, + include: [ + path.join(scratchDir, 'globals.d.ts'), + path.join(scratchDir, 'snippet-*.mts'), + ], + }; + const tsconfigPath = path.join(scratchDir, 'tsconfig.docs-check.json'); + await writeFile(tsconfigPath, JSON.stringify(tsconfig, null, 2)); + + const tscBin = path.join(repoRoot, 'node_modules', 'typescript', 'bin', 'tsc'); + const result = run(process.execPath, [tscBin, '-p', tsconfigPath]); + if (result.status !== 0) { + fail( + `README ts snippet compilation failed (${snippets.length} snippet(s))`, + `${result.stdout || ''}${result.stderr || ''}`, + ); + } + console.log(`docs-check: ${snippets.length} README ts snippet(s) compiled`); +} + +async function main() { + await clearScratch(); + const notCopied = regenerate(); + assertNoDrift(); + await checkLinks(notCopied); + await checkReadmeSnippets(); + await clearScratch(); + console.log('docs-check: PASS'); +} + +await main(); From d91be1a30bf5ab0d8a905c7a94fe8f5fb83a0ff2 Mon Sep 17 00:00:00 2001 From: moonyue-w <300878504+moonyue-w@users.noreply.github.com> Date: Fri, 18 Sep 2026 16:44:43 +0800 Subject: [PATCH 3/3] ci(docs): wire docs-check into PR checks --- .github/workflows/ci.yml | 12 ++++++++++++ README.md | 4 ++++ 2 files changed, 16 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5835dac..858fa07 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -27,3 +27,15 @@ jobs: - run: npm run typecheck - run: npm test - run: npm pack --dry-run + + docs-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v7 + - uses: actions/setup-node@v7 + with: + node-version: '22.x' + cache: npm + - run: npm ci + - run: npm run build + - run: npm run docs:check diff --git a/README.md b/README.md index 85e4dd0..c65af61 100644 --- a/README.md +++ b/README.md @@ -340,6 +340,10 @@ Neither hook is applied to file downloads, which deliberately bypass the client Node.js 20.12 or later. The SDK relies only on the platform's `fetch`, `Request`, `Response`, `Headers`, `AbortController`, `Blob` and `File` — any runtime providing those, and a `fetch` you can inject if not, should work. Deno, Bun, Cloudflare Workers and Vercel Edge are not part of the test matrix. +## Documentation + +The API reference under `docs/api/` is generated from the source. Regenerate it with `make docs` (or `npm run docs`). To verify the committed reference is up to date and the README snippets still compile, run `make docs-check` (or `npm run docs:check`); CI runs the same gate on every pull request. + ## License Released under the [MIT License](LICENSE).