@opengeni/sdk 0.52.1 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1078 -33
- package/dist/accounts.d.ts +153 -0
- package/dist/accounts.js +307 -0
- package/dist/accounts.js.map +1 -0
- package/dist/adapters/express.d.ts +31 -0
- package/dist/adapters/express.js +87 -0
- package/dist/adapters/express.js.map +1 -0
- package/dist/adapters/hono.d.ts +16 -0
- package/dist/adapters/hono.js +8 -0
- package/dist/adapters/hono.js.map +1 -0
- package/dist/adapters/next.d.ts +29 -0
- package/dist/adapters/next.js +22 -0
- package/dist/adapters/next.js.map +1 -0
- package/dist/allowance-refusal.d.ts +2 -0
- package/dist/allowance-refusal.js +50 -0
- package/dist/allowance-refusal.js.map +1 -0
- package/dist/artifact-catalog.d.ts +31 -0
- package/dist/artifact-client.d.ts +23 -11
- package/dist/artifacts.d.ts +1 -1
- package/dist/artifacts.js +7 -5
- package/dist/automations-client.d.ts +17 -0
- package/dist/automations.d.ts +3 -0
- package/dist/automations.js +84 -0
- package/dist/automations.js.map +1 -0
- package/dist/browser.d.ts +11 -0
- package/dist/browser.js +47 -0
- package/dist/browser.js.map +1 -0
- package/dist/chat/fold.d.ts +75 -0
- package/dist/chat/handler.d.ts +41 -0
- package/dist/chat/http.d.ts +67 -0
- package/dist/chat/ids.d.ts +34 -0
- package/dist/chat/index.d.ts +9 -0
- package/dist/chat/index.js +1694 -0
- package/dist/chat/index.js.map +1 -0
- package/dist/chat/openai.d.ts +30 -0
- package/dist/chat/opengeni.d.ts +128 -0
- package/dist/chat/types.d.ts +207 -0
- package/dist/chat/vercel.d.ts +49 -0
- package/dist/chats.d.ts +8 -0
- package/dist/{chunk-KIHGPM7H.js → chunk-2UXZUCEZ.js} +309 -46
- package/dist/chunk-2UXZUCEZ.js.map +1 -0
- package/dist/chunk-4SMEOV3P.js +246 -0
- package/dist/chunk-4SMEOV3P.js.map +1 -0
- package/dist/{chunk-FHI4DFIG.js → chunk-AH5D5Q5V.js} +31 -35
- package/dist/chunk-AH5D5Q5V.js.map +1 -0
- package/dist/chunk-APXVSSSY.js +301 -0
- package/dist/chunk-APXVSSSY.js.map +1 -0
- package/dist/chunk-DUVIYER4.js +639 -0
- package/dist/chunk-DUVIYER4.js.map +1 -0
- package/dist/{chunk-ILQZR5N6.js → chunk-FG3OO5LM.js} +3484 -750
- package/dist/chunk-FG3OO5LM.js.map +1 -0
- package/dist/chunk-GZYZT22T.js +260 -0
- package/dist/chunk-GZYZT22T.js.map +1 -0
- package/dist/chunk-HMGADJGZ.js +150 -0
- package/dist/chunk-HMGADJGZ.js.map +1 -0
- package/dist/{chunk-DXDL7EEW.js → chunk-KWADQ227.js} +198 -114
- package/dist/chunk-KWADQ227.js.map +1 -0
- package/dist/chunk-LY2K6ELJ.js +126 -0
- package/dist/chunk-LY2K6ELJ.js.map +1 -0
- package/dist/chunk-MOTJYIYL.js +340 -0
- package/dist/chunk-MOTJYIYL.js.map +1 -0
- package/dist/{chunk-MZWTWOX6.js → chunk-NC57YMUO.js} +447 -3
- package/dist/chunk-NC57YMUO.js.map +1 -0
- package/dist/chunk-RWKB6YZG.js +1270 -0
- package/dist/chunk-RWKB6YZG.js.map +1 -0
- package/dist/chunk-U6CV2SXO.js +195 -0
- package/dist/chunk-U6CV2SXO.js.map +1 -0
- package/dist/chunk-UM4ZXXJR.js +9 -0
- package/dist/chunk-UM4ZXXJR.js.map +1 -0
- package/dist/chunk-V6GIY62B.js +229 -0
- package/dist/chunk-V6GIY62B.js.map +1 -0
- package/dist/chunk-WU6GQG25.js +268 -0
- package/dist/chunk-WU6GQG25.js.map +1 -0
- package/dist/{chunk-VWE2QIVO.js → chunk-XNG7YGR3.js} +23 -6
- package/dist/chunk-XNG7YGR3.js.map +1 -0
- package/dist/{chunk-FRJFNDIR.js → chunk-YIKA2QT4.js} +37 -2
- package/dist/chunk-YIKA2QT4.js.map +1 -0
- package/dist/chunk-ZKPY6YAJ.js +135 -0
- package/dist/chunk-ZKPY6YAJ.js.map +1 -0
- package/dist/client.d.ts +843 -107
- package/dist/codex-realtime-controller.d.ts +6 -0
- package/dist/codex-realtime-controller.js +2 -2
- package/dist/codex-realtime-v3.d.ts +13 -2
- package/dist/company-brain.d.ts +22 -0
- package/dist/company-profile.d.ts +14 -1
- package/dist/core.d.ts +9 -3
- package/dist/core.js +28 -9
- package/dist/deprecation.d.ts +47 -0
- package/dist/desktop.d.ts +8 -0
- package/dist/document-authority-client.d.ts +51 -0
- package/dist/document-authority.d.ts +2 -0
- package/dist/document-authority.js +12 -0
- package/dist/document-authority.js.map +1 -0
- package/dist/editable-artifacts/browser-session.d.ts +7 -3
- package/dist/editable-artifacts/controller.d.ts +4 -1
- package/dist/editable-artifacts/errors.d.ts +1 -1
- package/dist/editable-artifacts/http-live-transport.d.ts +6 -2
- package/dist/editable-artifacts/index.d.ts +2 -0
- package/dist/editable-artifacts/open-failure.d.ts +9 -0
- package/dist/editable-artifacts/types.d.ts +6 -3
- package/dist/editable-artifacts/worker/kernel-adapter.d.ts +1 -1
- package/dist/editable-artifacts-worker.js +44 -17
- package/dist/editable-artifacts-worker.js.map +1 -1
- package/dist/editable-artifacts.js +243 -124
- package/dist/editable-artifacts.js.map +1 -1
- package/dist/embedding-client.d.ts +129 -0
- package/dist/errors.d.ts +36 -1
- package/dist/feedback.d.ts +23 -0
- package/dist/gateway-realtime-transport.d.ts +1 -0
- package/dist/gateway-realtime-transport.js +5 -3
- package/dist/github-repositories.d.ts +10 -0
- package/dist/github-repositories.js +36 -0
- package/dist/github-repositories.js.map +1 -0
- package/dist/index.d.ts +61 -12
- package/dist/index.js +277 -126
- package/dist/index.js.map +1 -1
- package/dist/interaction-revision-stream.d.ts +11 -0
- package/dist/interaction.d.ts +687 -5
- package/dist/interaction.js +32 -1
- package/dist/knowledge.d.ts +7 -0
- package/dist/knowledge.js +20 -0
- package/dist/knowledge.js.map +1 -0
- package/dist/message-links.d.ts +68 -0
- package/dist/model-context.d.ts +68 -0
- package/dist/model-display.d.ts +2 -0
- package/dist/model-display.js +15 -0
- package/dist/model-display.js.map +1 -0
- package/dist/model-picker-order.d.ts +1 -0
- package/dist/model-picker-order.js +10 -0
- package/dist/model-picker-order.js.map +1 -0
- package/dist/organization-integration-policy.d.ts +26 -0
- package/dist/organization-integration-policy.js +26 -0
- package/dist/organization-integration-policy.js.map +1 -0
- package/dist/organization-private-session-settings.d.ts +6 -0
- package/dist/organization-private-session-settings.js +22 -0
- package/dist/organization-private-session-settings.js.map +1 -0
- package/dist/organization-user-setup.d.ts +8 -0
- package/dist/organization-user-setup.js +16 -0
- package/dist/organization-user-setup.js.map +1 -0
- package/dist/pr-review-client.d.ts +16 -0
- package/dist/pr-review.d.ts +4 -0
- package/dist/pr-review.js +62 -0
- package/dist/pr-review.js.map +1 -0
- package/dist/preference-registry.d.ts +9 -1
- package/dist/proxy.d.ts +7 -5
- package/dist/realtime.d.ts +6 -4
- package/dist/realtime.js +10 -6
- package/dist/realtime.js.map +1 -1
- package/dist/retained-artifacts.d.ts +5 -1
- package/dist/session-history-import.d.ts +22 -0
- package/dist/session-history-import.js +36 -0
- package/dist/session-history-import.js.map +1 -0
- package/dist/session-list-entries.d.ts +1 -0
- package/dist/session-list-entries.js +7 -0
- package/dist/session-list-entries.js.map +1 -0
- package/dist/session-message-search.d.ts +53 -0
- package/dist/session-proxy-client.d.ts +24 -0
- package/dist/session-proxy.d.ts +245 -0
- package/dist/session-proxy.js +24 -0
- package/dist/session-proxy.js.map +1 -0
- package/dist/session-titles.d.ts +2 -0
- package/dist/site-browser-entry.d.ts +1 -0
- package/dist/site-browser-runtime.gen.d.ts +1 -0
- package/dist/site-document.d.ts +5 -0
- package/dist/site-document.js +20 -0
- package/dist/site-document.js.map +1 -0
- package/dist/site-document.test.d.ts +1 -0
- package/dist/site-http.d.ts +16 -0
- package/dist/site-tool-bridge.d.ts +44 -0
- package/dist/site.d.ts +101 -0
- package/dist/site.js +49 -0
- package/dist/site.js.map +1 -0
- package/dist/skills.d.ts +75 -0
- package/dist/stream.d.ts +2 -0
- package/dist/tenant-workspaces.d.ts +47 -0
- package/dist/tenant-workspaces.js +8 -0
- package/dist/tenant-workspaces.js.map +1 -0
- package/dist/tool-auth.d.ts +87 -0
- package/dist/tool-auth.js +23 -0
- package/dist/tool-auth.js.map +1 -0
- package/dist/tool-display-metadata.d.ts +3 -0
- package/dist/tools-FXBLUWAE.js +12 -0
- package/dist/tools-FXBLUWAE.js.map +1 -0
- package/dist/tools.d.ts +61 -0
- package/dist/types.d.ts +3048 -406
- package/dist/usage-allowances.d.ts +36 -0
- package/dist/usage-allowances.js +80 -0
- package/dist/usage-allowances.js.map +1 -0
- package/dist/workspace-artifacts.d.ts +33 -5
- package/dist/workspace-instruction-policies.d.ts +24 -2
- package/dist/workspace-integrations.d.ts +74 -0
- package/dist/workspace-integrations.js +65 -0
- package/dist/workspace-integrations.js.map +1 -0
- package/dist/workspace-learning.d.ts +124 -0
- package/dist/workspace-live-stream.d.ts +14 -0
- package/dist/workspace-state.d.ts +8 -71
- package/package.json +108 -3
- package/src/accounts.ts +443 -0
- package/src/adapters/express.ts +136 -0
- package/src/adapters/hono.ts +18 -0
- package/src/adapters/next.ts +42 -0
- package/src/allowance-refusal.ts +5 -0
- package/src/artifact-catalog.ts +41 -0
- package/src/artifact-client.ts +43 -52
- package/src/artifacts.ts +7 -1
- package/src/automations-client.ts +124 -0
- package/src/automations.ts +15 -0
- package/src/browser.ts +54 -0
- package/src/chat/fold.ts +431 -0
- package/src/chat/handler.ts +240 -0
- package/src/chat/http.ts +257 -0
- package/src/chat/ids.ts +85 -0
- package/src/chat/index.ts +87 -0
- package/src/chat/openai.ts +439 -0
- package/src/chat/opengeni.ts +722 -0
- package/src/chat/types.ts +219 -0
- package/src/chat/vercel.ts +204 -0
- package/src/chats.ts +16 -0
- package/src/client.ts +5162 -792
- package/src/codex-realtime-controller.ts +260 -12
- package/src/codex-realtime-lifecycle.ts +1 -0
- package/src/codex-realtime-v3.ts +162 -31
- package/src/codex-realtime.ts +1 -1
- package/src/company-brain.ts +59 -0
- package/src/company-profile.ts +17 -1
- package/src/core.ts +23 -1
- package/src/deprecation.ts +149 -0
- package/src/desktop.ts +11 -1
- package/src/document-authority-client.ts +219 -0
- package/src/document-authority.ts +17 -0
- package/src/editable-artifacts/browser-session.ts +36 -22
- package/src/editable-artifacts/controller.ts +102 -47
- package/src/editable-artifacts/errors.ts +2 -0
- package/src/editable-artifacts/http-live-transport.ts +62 -37
- package/src/editable-artifacts/index.ts +6 -0
- package/src/editable-artifacts/open-failure.ts +79 -0
- package/src/editable-artifacts/storage.ts +31 -40
- package/src/editable-artifacts/types.ts +6 -3
- package/src/editable-artifacts/worker/kernel-adapter.ts +23 -7
- package/src/editable-artifacts/worker/runtime.ts +26 -13
- package/src/editable-artifacts/worker/wire-codec.ts +23 -5
- package/src/embedding-client.ts +519 -0
- package/src/errors.ts +185 -4
- package/src/feedback.ts +20 -0
- package/src/gateway-realtime-transport.ts +253 -110
- package/src/github-repositories.ts +60 -0
- package/src/index.ts +603 -54
- package/src/interaction-revision-stream.ts +117 -0
- package/src/interaction.ts +1367 -51
- package/src/knowledge.ts +72 -0
- package/src/message-links.ts +178 -0
- package/src/model-context.ts +112 -0
- package/src/model-display.ts +10 -0
- package/src/model-picker-order.ts +6 -0
- package/src/organization-integration-policy.ts +54 -0
- package/src/organization-private-session-settings.ts +33 -0
- package/src/organization-user-setup.ts +31 -0
- package/src/pr-review-client.ts +92 -0
- package/src/pr-review.ts +17 -0
- package/src/preference-registry.ts +11 -0
- package/src/proxy.ts +17 -6
- package/src/realtime.ts +15 -4
- package/src/retained-artifacts.ts +101 -0
- package/src/session-history-import.ts +84 -0
- package/src/session-list-entries.ts +1 -0
- package/src/session-message-search.ts +47 -0
- package/src/session-proxy-client.ts +64 -0
- package/src/session-proxy.ts +1473 -0
- package/src/session-titles.ts +10 -0
- package/src/site-browser-entry.ts +6 -0
- package/src/site-browser-runtime.gen.ts +2 -0
- package/src/site-document.test.ts +64 -0
- package/src/site-document.ts +18 -0
- package/src/site-http.ts +162 -0
- package/src/site-tool-bridge.ts +146 -0
- package/src/site.ts +585 -0
- package/src/skills.ts +69 -0
- package/src/sse.ts +8 -2
- package/src/stream.ts +38 -4
- package/src/tenant-workspaces.ts +148 -0
- package/src/tool-auth.ts +301 -0
- package/src/tool-display-metadata.ts +19 -0
- package/src/tools.ts +396 -0
- package/src/types.ts +3607 -493
- package/src/usage-allowances.ts +189 -0
- package/src/workspace-artifacts.ts +40 -6
- package/src/workspace-instruction-policies.ts +26 -1
- package/src/workspace-integrations.ts +402 -0
- package/src/workspace-learning.ts +138 -0
- package/src/workspace-live-stream.ts +137 -0
- package/src/workspace-state.ts +8 -82
- package/dist/chunk-DXDL7EEW.js.map +0 -1
- package/dist/chunk-FHI4DFIG.js.map +0 -1
- package/dist/chunk-FRJFNDIR.js.map +0 -1
- package/dist/chunk-ILQZR5N6.js.map +0 -1
- package/dist/chunk-KIHGPM7H.js.map +0 -1
- package/dist/chunk-MZWTWOX6.js.map +0 -1
- package/dist/chunk-V5F253OG.js +0 -116
- package/dist/chunk-V5F253OG.js.map +0 -1
- package/dist/chunk-VWE2QIVO.js.map +0 -1
package/dist/client.d.ts
CHANGED
|
@@ -1,12 +1,76 @@
|
|
|
1
|
+
import type { ClaudeSubscriptionAccountsResponse, ClaudeSubscriptionAccount, ClaudeSubscriptionOAuthStartRequest, ClaudeSubscriptionSetupTokenRequest, SubscriptionPoolSettings } from "@opengeni/contracts";
|
|
2
|
+
import type { ArtifactCatalogListOptions, ArtifactCatalogListResponse } from "./artifact-catalog.js";
|
|
3
|
+
import type { SessionMessageSearchRequest, SessionMessageSearchResponse, SessionMessagePreview, SessionMessagePreviewReference } from "./session-message-search.js";
|
|
4
|
+
import type { KnowledgeOriginalFileDownload, AgentLearningContext, AgentLearningSettingsRecord, AgentLearningOverrideRecord, SaveAgentLearningSettingsRequest, KnowledgeEntryListRequest, KnowledgeEntryListResponse, KnowledgeReviewBatchListRequest, KnowledgeReviewBatchListResponse, KnowledgeEntryRecord, KnowledgeEntrySaveRequest, KnowledgeEntryWriteReceipt, KnowledgeEntryReviewRequest, KnowledgeEntryBatchReviewRequest, KnowledgeEntryRestoreRequest, AgentInstructionReviewRequest, AgentInstructionReceipt, AgentInstructionReviewListResponse } from "./knowledge.js";
|
|
5
|
+
import type { RollbackWorkspaceArtifactRequest, SetWorkspaceArtifactStatusRequest, WorkspaceArtifactDetailResponse, WorkspaceArtifactListOptions, WorkspaceArtifactListResponse, WorkspaceArtifactMutationResponse } from "./workspace-artifacts.js";
|
|
6
|
+
import type { CreateFeedbackRequest, Feedback, FeedbackSubmissionResponse } from "./feedback.js";
|
|
7
|
+
import type { CreateWorkspaceWebhookRequest, CreateWorkspaceWebhookResponse, GetWorkspaceCredentialProviderResponse, ListWorkspaceWebhookDeliveriesResponse, ListWorkspaceWebhooksResponse, PutWorkspaceCredentialProviderRequest, PutWorkspaceCredentialProviderResponse, UpdateWorkspaceWebhookRequest, WorkspaceSandboxImages, WorkspaceWebhook, WorkspaceWebhookDelivery } from "./workspace-integrations.js";
|
|
8
|
+
import type { OpenGeniToolsFacade } from "./tools.js";
|
|
1
9
|
import { type SessionEventStreamTransport, type StreamSessionEventsOptions } from "./stream.js";
|
|
10
|
+
import type { SessionModelContextResponse } from "./model-context.js";
|
|
11
|
+
import { type OpenGeniDeprecationHandler } from "./deprecation.js";
|
|
12
|
+
import type { SkillRecord, SkillSummary, SkillWriteReceipt, SaveWorkspaceSkillRequest, RemoveWorkspaceSkillRequest, ApplyWorkspaceSkillRevisionRequest } from "./skills.js";
|
|
2
13
|
import { type WorkspaceControlStreamTransport } from "./workspace-control-stream.js";
|
|
3
|
-
import {
|
|
4
|
-
import
|
|
14
|
+
import { type WorkspaceInteractionRevisionStreamTransport } from "./interaction-revision-stream.js";
|
|
15
|
+
import { type WorkspaceLiveStreamOptions, type WorkspaceLiveStreamTransport } from "./workspace-live-stream.js";
|
|
16
|
+
import { OpenGeniInteractionClient, type AuthRun, type AuthRunListOptions, type AuthRunListResponse, type AuthRunMutationResponse, type AttachedBrowserDevice, type AttachedBrowserDeviceListOptions, type AttachedBrowserDeviceListResponse, type BrowserActionReceipt, type BrowserActionRequest, type BrowserScreenshotOptions, type BrowserClipboard, type BrowserDiagnosticBatch, type BrowserDomReadRequest, type BrowserDomReadResponse, type BrowserDiagnosticsOptions, type BrowserDownload, type BrowserDownloadListResponse, type BrowserDownloadSaveRequest, type BrowserDownloadSaveResponse, type BrowserIdentity, type BrowserIdentityListOptions, type BrowserIdentityListResponse, type BrowserIdentityMutationResponse, type BrowserObservation, type BrowserFrame, type BrowserOpenTargetRequest, type BrowserSession, type BrowserSessionAttachment, type BrowserSessionAttachmentRequest, type BrowserSessionHeartbeatResponse, type BrowserSessionLifecycleRequest, type BrowserSessionListResponse, type BrowserSessionMutationResponse, type BrowserTargetState, type BrowserTargetListResponse, type BrowserRevisionListResponse, type ComputerActionReceipt, type ComputerActionRequest, type ComputerClipboard, type ComputerFrame, type ComputerObservation, type ComputerSession, type ComputerSessionAttachment, type ComputerSessionAttachmentRequest, type ComputerSessionHeartbeatResponse, type ComputerSessionInputPosture, type ComputerSessionLifecycleRequest, type ComputerSessionListResponse, type ComputerSessionMutationResponse, type ComputerTargetListResponse, type CreateBrowserIdentityRequest, type CreateBrowserSessionRequest, type CreateComputerSessionRequest, type CreateInteractionInterventionRequest, type CreateNetworkRouteRequest, type CreateSiteAuthConnectionRequest, type ExternalAuthInteractiveRequest, type ExternalAuthInteractiveResponse, type ExternalAuthRunRequest, type ExternalAuthRunResponse, type InteractionIntervention, type InteractionInterventionListOptions, type InteractionInterventionListResponse, type InteractionInterventionMutationResponse, type NetworkRoute, type NetworkRouteListOptions, type NetworkRouteListResponse, type NetworkRouteMutationResponse, type ProtectedAuthFillRequest, type ProtectedAuthFillResponse, type PublishBrowserRevisionRequest, type PublishBrowserRevisionResponse, type ReportAuthRunRequest, type ResolveInteractionInterventionRequest, type SiteAuthConnection, type SiteAuthConnectionListOptions, type SiteAuthConnectionListResponse, type SiteAuthConnectionMutationResponse, type StartAuthRunRequest, type UpdateNetworkRouteRequest, type UpdateBrowserIdentityRequest, type UpdateSiteAuthConnectionRequest, type VerifyAuthRunRequest, type WorkspaceInteractionRevisionEvent } from "./interaction.js";
|
|
17
|
+
import type { AccessContext, ActivateCodexRealtimeConnectionRequest, AddWorkspaceMemberRequest, ApiKey, BillingEntitlementsResponse, CodexAccount, CodexAccountsResponse, SessionCodexAccountsResponse, CodexAppsUpdate, CodexRotationSettings, CodexOverviewResponse, CodexAllocatorUpdate, CodexConnectionStatus, CodexRealtimeWebrtcRequest, CodexRealtimeWebrtcResponse, GatewayRealtimeConnectRequest, GatewayRealtimeConnectResponse, CodexConnectPoll, CodexConnectStart, CodexUsage, CodexUsageMap, ModelConnectionAccessPolicy, ModelConnectionAccessResponse, SuperGrokAccount, SuperGrokAccountsResponse, SuperGrokAccountScope, SuperGrokAllocatorUpdate, SuperGrokConnectionStatus, SuperGrokConnectPoll, SuperGrokConnectStart, SuperGrokRotationSettings, BillingSummary, BillingUsageResponse, InsightsRange, WorkspaceInsightsResponse, BeginSessionRealtimeRequest, CapabilityCatalogItem, CapabilityCatalogResponse, ConnectorToolPermissionsResponse, UpdateConnectorToolPermissionsRequest, CapabilityInstallation, ApiIntegrationPreview, ApiIntegrationOAuthStartRequest, ApiIntegrationUninstallPreview, InstallApiIntegrationRequest, InstalledApiIntegration, IntegrationFacetMutationResult, IntegrationFacetRemovalResult, IntegrationInstanceFacetsResponse, ListIntegrationDefinitionsResponse, ListApiIntegrationsResponse, MutateIntegrationFacetRequest, PreviewApiIntegrationRequest, UninstallApiIntegrationRequest, UninstallApiIntegrationResult, UpsertIntegrationFacetRequest, PreviewPluginRequest, PluginPreview, InstallPluginRequest, InstalledPlugin, ListInstalledPluginsResponse, PluginUninstallPreview, UninstallPluginRequest, UninstallPluginResult, AddDocumentRequest, CreateKnowledgeDropRequest, MoveDocumentRequest, ClientConfig, WorkspaceModelAccessPolicy, WorkspaceModelCatalogResponse, WorkspaceGatewayCustomModel, WorkspaceGatewayCustomModelsResponse, CreateWorkspaceGatewayCustomModelRequest, DeleteWorkspaceGatewayCustomModelRequest, WorkspaceOpenRouterCustomModel, WorkspaceOpenRouterCustomModelsResponse, CreateWorkspaceOpenRouterCustomModelRequest, DeleteWorkspaceOpenRouterCustomModelRequest, OrganizationModelProviderKind, ClaudeSubscriptionUsage, ClaudeSubscriptionOAuthStartResponse, ClaudeSubscriptionOAuthCompleteRequest, ClaudeSubscriptionOAuthCompleteResponse, OrganizationModelProviderConnection, UpsertOrganizationModelProviderConnectionRequest, RevokeOrganizationModelProviderConnectionRequest, OrganizationProviderCustomModel, OrganizationProviderCustomModelsResponse, CreateOrganizationProviderCustomModelRequest, DeleteOrganizationProviderCustomModelRequest, WorkspaceRealtimeModelCatalogResponse, ClientSessionEventInput, UserMessageEventInput, CompactSessionContextResult, ConnectionMetadata, PersonalGitHubConnectionStatusResponse, PersonalGitHubDisconnectRequest, PersonalGitHubOAuthStartRequest, PersonalGitHubOAuthStartResponse, ListPersonalGitHubRepositoriesOptions, ListPersonalGitHubRepositoriesResponse, PersonalGitHubRepositorySelectionState, ReplacePersonalGitHubRepositorySelectionsRequest, VerifyPersonalGitHubRepositorySelectionsRequest, CreateApiKeyRequest, CreateApiKeyResponse, CreateOrganizationApiKeyRequest, OrganizationMcpConnection, OrganizationMcpConnectionList, OrganizationServiceAccount, ListOrganizationServiceAccountsResponse, CreateOrganizationServiceAccountRequest, UpdateOrganizationServiceAccountRequest, UpdateOrganizationMcpConnectionRequest, McpConnectionRequest, McpConnectionDecision, CreateCapabilityCatalogItemRequest, InstallSkillRequest, InstallLibrarySkillRequest, InstalledSkill, ListInstalledSkillsResponse, CreateBillingPortalRequest, CreateBillingPortalResponse, CreateCheckoutRequest, BillingCheckoutStatus, CreateCheckoutResponse, OpenGeniSlackBotInstallRequest, OpenGeniSlackBotInstallStart, SlackChannelRouteListResponse, SlackReactionChannelListResponse, UpdateSlackChannelRoutesRequest, FikenInstallRequest, FikenOAuthStartRequest, FikenOAuthStartResponse, CreateConnectionRequest, CreateDocumentBaseRequest, CreateFileUploadRequest, CreateFileUploadResponse, CreateGitHubAppManifestRequest, CreateGitHubAppManifestResponse, CreateScheduledTaskRequest, CreateSessionRequest, CreateSessionResponse, CreateVariableSetRequest, ResolveVariableSetAttachmentsRequest, ResolveVariableSetAttachmentsResponse, CreateRigRequest, CreateWorkspaceRequest, EnsureWorkspaceRequest, EnsureWorkspaceResponse, DeviceEnrollmentApproveRequest, DeviceEnrollmentApproveResponse, DeviceEnrollmentDenyResponse, DeviceEnrollmentLookupResponse, MintEnrollTokenResponse, EndSessionRealtimeRequest, DiscoverMcpCapabilitiesResponse, Document, DocumentBase, EnableCapabilityRequest, FileAsset, FileDownloadUrlResponse, GitHubActionPoliciesResponse, GitHubActionPolicyActorState, GitHubAppInfo, GitHubRepositoriesResponse, GoogleDriveBrowseResponse, GoogleDriveDisconnectRequest, SaveGoogleDriveIntegrationSourceRequest, GoogleDriveLifecycleActionRequest, ListOrganizationSessionsOptions, ListManagedOrganizationMembershipsResponse, ListUserResourceAuthoritiesOptions, ListUserResourceAuthoritiesResponse, UpdateGitHubActionPolicyRequest, RevokeUserResourceGrantResponse, ListOrganizationInvitationsPageResponse, ListOrganizationAdministrationMembersResponse, AcceptOrganizationInvitationRequest, AcceptOrganizationInvitationResponse, AcceptOrganizationRecoveryCustodyRequest, ConfigureOrganizationRecoveryPolicyRequest, CreateOrganizationInvitationRequest, CreateAdditionalOrganizationRequest, CreateAdditionalOrganizationResponse, CreateOrganizationRequest, CreateOrganizationResponse, CreateOrganizationWorkspaceRequest, OrganizationInvitation, OrganizationAdministrationOverview, OrganizationMember, OrganizationRecoveryMutationResponse, OrganizationRecoveryOperationCommandRequest, OrganizationRecoveryOverview, OrganizationSessionListResponse, OrganizationWorkspaceAccess, OrganizationWorkspaceAccessMember, OrganizationRetentionPolicy, OrganizationSummary, RevokeOrganizationInvitationRequest, RevokeOrganizationWorkspaceMemberRequest, RevokeOrganizationWorkspaceMemberResponse, PutOrganizationWorkspaceMemberRequest, UpdateOrganizationMemberRequest, UpdateOrganizationNameRequest, DisableOrganizationRecoveryPolicyRequest, StartOrganizationRecoveryOperationRequest, UpdateOrganizationWorkspaceRequest, UpdateOrganizationRetentionPolicyRequest, MachinesResponse, MetricSample, RemoveEnrollmentRequest, RemoveEnrollmentResponse, MachineOperationPolicy, UpdateMachineOperationPolicyRequest, UpdateMachineAgentResponse, SwapActiveSandboxRequest, SwapActiveSandboxResponse, PrepareSlackUserLinkAccessRequest, SlackUserLinkAccessMutationRequest, SlackUserLinkAccessRequest, ApproveSlackUserLinkAccessRequest, RetainedScreenshotDownload, RetainedScreenshotDownloadOptions, RetainedArtifactDownload, RetainedArtifactDownloadOptions, RetainedArtifactReference, RetainedArtifactContent, RetainedArtifactContentOptions, RetainedArtifactMetadata, UpdateVideoGenerationPolicyRequest, VideoArtifactPlaybackSource, VideoGenerationOperationSummary, VideoGenerationPolicy, WorkspaceVideoGenerationSettings, PreviewSkillImportRequest, ScheduledTask, ScheduledTaskAccessAttention, ScheduledTaskRun, ForkSessionRequest, ForkSessionResponse, Session, SessionStatus, WorkClaimSubjectType, SessionBackgroundCommandListResponse, CancelSessionBackgroundCommandResult, SessionListResponse, SessionListEntryResponse, SessionTenancyCreateCapabilities, AgentTopologyPageResponse, UpdateSessionChannelRequest, UpdateSessionAttentionRequest, UpdateSessionArchiveRequest, UpdateSessionPinRequest, UpdateSessionVisibilityRequest, UpdateSessionVisibilityResponse, SessionScopeSubjectId, SessionEvent, SessionEventCompactResult, SessionEventCompactResultOptions, SessionEventListOptions, SessionEventPage, SessionGoal, SessionGoalRevision, ListSessionGoalRevisionsOptions, ListSessionGoalRevisionsResponse, RejectSessionGoalRevisionRequest, RejectSessionGoalRevisionResponse, RollbackSessionGoalRevisionRequest, SessionHumanInputRequest, SessionLineageResponse, SessionRealtimeMutationResponse, SyncSessionRealtimeLedgerRequest, SyncSessionRealtimeLedgerResponse, RenewSessionRealtimeRequest, UpdateSessionMcpApprovalPolicyRequest, UpdateSessionMcpApprovalPolicyResponse, SessionQueueSnapshot, SessionQueueMutationResponse, SessionCommandReceipt, SessionPromptRouting, ComposerDraft, DeleteSessionQueueItemRequest, EditSessionQueueItemRequest, MoveSessionQueueItemRequest, NewSessionDraft, SaveComposerDraftRequest, SubmitComposerDraftRequest, SubmitComposerDraftResponse, SaveNewSessionDraftRequest, SteerSessionQueueItemRequest, SessionControlResponse, SessionRetryRequest, SandboxRecoveryProjection, SandboxRecoveryRequest, SandboxRecoveryResponse, SessionRetryResponse, WorkspaceInferenceControlResponse, WorkspaceControlEvent, SessionTurn, SubmitHumanInputResponseRequest, SessionCapabilities, AttachViewerRequest, AttachViewerResponse, AcknowledgeStreamRequest, AcknowledgeStreamResponse, ViewerHeartbeatRequest, ViewerHeartbeatResponse, FsListRequest, FsListResponse, FsListBatchRequest, FsListBatchResponse, FsReadRequest, FsReadResponse, PublishSandboxFileArtifactRequest, SandboxFileArtifactReceipt, FsWriteRequest, FsWriteResponse, FsDeleteRequest, FsDeleteResponse, FsMoveRequest, FsMoveResponse, FsMkdirRequest, FsMkdirResponse, GitStatusRequest, GitStatusResponse, GitDiffRequest, GitDiffResponse, GitReadBatchRequest, GitReadBatchResponse, GitLogRequest, GitLogResponse, GitShowRequest, GitShowResponse, GetWorkspaceCaptureResponse, GetWorkspaceCaptureFileResponse, TerminalExecRequest, TerminalExecResponse, PtyOpenRequest, PtyOpenResponse, PtyWriteRequest, PtyResizeRequest, PtyCloseRequest, TranscribeAudioResponse, TranscriptionRecordingListResponse, TranscriptionRecordingResponse, UploadTranscriptionRecordingChunkResponse, UpdateConnectionRequest, RefreshScheduledTaskAccessRequest, UpdateScheduledTaskRequest, UpdateSessionGoalRequest, ApplySessionGoalRevisionRequest, UpdateSessionRequest, UpdateSessionVariableSetsRequest, UpdateSessionToolPolicyRequest, UpdateSessionAgentRequest, UpdateVariableSetRequest, UpdateRigRequest, UpdateWorkspaceMemberRequest, UpdateWorkspaceModelAccessPolicyRequest, UpdateWorkspaceRequest, UpdateWorkspaceSettingsRequest, SetWorkspaceDefaultRigRequest, UploadFileInput, VariableSet, VariableSetSecret, VariableSetVariableMetadata, Channel, CreateChannelRequest, ReorderChannelsRequest, UpdateChannelRequest, Rig, RigVersion, RigChange, ProposeRigChangeRequest, WorkspaceMember, WorkspaceMemberCandidate, Workspace, SlackInstallationBinding, OAuthStartRequest, OAuthStartResponse, SocialConnection, SocialOAuthStartRequest, SkillImportPreview, SkillUninstallPreview, UninstallSkillRequest, UninstallSkillResult } from "./types.js";
|
|
5
18
|
import type { ActivateWorkspaceInstructionPolicyRequest, CreateWorkspaceInstructionPolicyDraftRequest, CreateWorkspaceInstructionPolicyOnboardingProposalRequest, ImportLegacyWorkspaceInstructionPolicyDraftRequest, RollbackWorkspaceInstructionPolicyRequest, WorkspaceInstructionPolicyActivationResponse, WorkspaceInstructionPolicyDiffRequest, WorkspaceInstructionPolicyDiffResponse, WorkspaceInstructionPolicyListOptions, WorkspaceInstructionPolicyListResponse, WorkspaceInstructionPolicyOnboardingProposal, WorkspaceInstructionPolicyOnboardingProposalListOptions, WorkspaceInstructionPolicyOnboardingProposalListResponse, WorkspaceInstructionPolicyRevision } from "./workspace-instruction-policies.js";
|
|
6
|
-
import type {
|
|
19
|
+
import type { GovernedLearningActivationUndoReceipt, WorkspaceLearningHistoryOptions, WorkspaceLearningHistoryResponse } from "./workspace-learning.js";
|
|
20
|
+
import type { ActivateCompanyProfileRevisionRequest, CompanyProfileAgentPolicy, CompanyProfileDiffRequest, CompanyProfileDiffResponse, CompanyProfileListOptions, CompanyProfileListResponse, CompanyProfileMutationResponse, CompanyProfileRevision, RollbackCompanyProfileRequest, UpdateCompanyProfileRequest, UpdateCompanyProfileAgentPolicyRequest } from "./company-profile.js";
|
|
7
21
|
import type { WorkspaceStateExportResponse, WorkspaceStateGetOptions, WorkspaceStateResponse } from "./workspace-state.js";
|
|
8
22
|
import type { ActivatePreferenceRegistryRevisionRequest, ChangePreferenceRegistryScopeRequest, CorrectPreferenceRegistryRequest, CreatePreferenceRegistryProposalRequest, DeactivatePreferenceRegistryRequest, PreferenceRegistryDetailResponse, PreferenceRegistryFullContent, PreferenceRegistryListOptions, PreferenceRegistryListResponse, PreferenceRegistryMutationResponse, PreferenceRegistryRecord, PreferenceRegistrySnapshot, RejectPreferenceRegistryProposalRequest, SupersedePreferenceRegistryRequest } from "./preference-registry.js";
|
|
9
|
-
export type
|
|
23
|
+
export type SessionListPageOptions = {
|
|
24
|
+
/** Complete content-free totals for an authorized root page. */
|
|
25
|
+
includeTotals?: boolean;
|
|
26
|
+
/** Filter attention rows before pagination. */
|
|
27
|
+
needsYouOnly?: boolean;
|
|
28
|
+
/** Created through this Site. In a Site-bound client, "current" resolves to its own Site. */
|
|
29
|
+
originSiteId?: string;
|
|
30
|
+
limit?: number;
|
|
31
|
+
parentSessionId?: string | null;
|
|
32
|
+
/** Only sessions carrying this exact opaque end-user label. */
|
|
33
|
+
scopeSubjectId?: SessionScopeSubjectId;
|
|
34
|
+
cursor?: string;
|
|
35
|
+
search?: string;
|
|
36
|
+
/** Restrict rows to one workspace project; null selects unfiled rows. */
|
|
37
|
+
channelId?: string | null;
|
|
38
|
+
/** Restrict rows to the exact frozen session creator identity. */
|
|
39
|
+
createdBy?: {
|
|
40
|
+
kind: "subject" | "service";
|
|
41
|
+
subjectId: string;
|
|
42
|
+
};
|
|
43
|
+
/** Inclusive ISO-8601 activity lower bound. */
|
|
44
|
+
updatedFrom?: string;
|
|
45
|
+
/** Exclusive ISO-8601 activity upper bound. */
|
|
46
|
+
updatedBefore?: string;
|
|
47
|
+
/** Inclusive ISO-8601 creation lower bound. */
|
|
48
|
+
createdFrom?: string;
|
|
49
|
+
/** Exclusive ISO-8601 creation upper bound. */
|
|
50
|
+
createdBefore?: string;
|
|
51
|
+
/** Return only the complete personal pinned projection. */
|
|
52
|
+
pinsOnly?: boolean;
|
|
53
|
+
/** Skip pinned details when the pinned section is loaded separately. Defaults to true. */
|
|
54
|
+
includePinned?: boolean;
|
|
55
|
+
/** Return archived root chats instead of the active session list. */
|
|
56
|
+
archivedOnly?: boolean;
|
|
57
|
+
sortBy?: "updatedAt" | "createdAt" | "name";
|
|
58
|
+
archiveStatus?: "active" | "archived" | "all";
|
|
59
|
+
/** Stop this caller's finite page read when its owning route is abandoned. */
|
|
60
|
+
signal?: AbortSignal | undefined;
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Web-standard fetch response accepted by the SDK.
|
|
64
|
+
*
|
|
65
|
+
* The project global `Response` type includes Bun's non-standard `textStream()`
|
|
66
|
+
* method and the newer `bytes()` method. Fetch implementations such as Expo do
|
|
67
|
+
* not necessarily provide either member, and the SDK does not use them, so
|
|
68
|
+
* they must not be part of the adapter boundary.
|
|
69
|
+
*/
|
|
70
|
+
export type FetchResponse = Omit<Response, "bytes" | "clone" | "textStream"> & {
|
|
71
|
+
clone(): FetchResponse;
|
|
72
|
+
};
|
|
73
|
+
export type FetchLike = (input: string | URL | Request, init?: RequestInit) => Promise<FetchResponse>;
|
|
10
74
|
export type WorkspaceControlEventPage = {
|
|
11
75
|
events: WorkspaceControlEvent[];
|
|
12
76
|
bytes: number;
|
|
@@ -18,39 +82,85 @@ export type OpenGeniClientOptions = {
|
|
|
18
82
|
baseUrl: string;
|
|
19
83
|
/** OpenGeni API key, sent as `Authorization: Bearer <apiKey>`. */
|
|
20
84
|
apiKey?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Receives a notice (once per route per client) when the API advertises a
|
|
87
|
+
* `Deprecation`/`Sunset` header on a response. Defaults to a one-time
|
|
88
|
+
* `console.warn` per route; pass `false` to silence notices.
|
|
89
|
+
*/
|
|
90
|
+
onDeprecation?: OpenGeniDeprecationHandler | false | undefined;
|
|
21
91
|
/** Extra headers (static or computed per request) merged into every call. */
|
|
22
92
|
headers?: Record<string, string> | (() => Record<string, string>);
|
|
23
93
|
/** Custom fetch implementation. Defaults to the global `fetch`. */
|
|
24
94
|
fetch?: FetchLike;
|
|
95
|
+
/**
|
|
96
|
+
* Optional causal clock for shared session projection GETs. The selected
|
|
97
|
+
* request generation is retained for observers that join after launch.
|
|
98
|
+
*/
|
|
99
|
+
beginSharedRead?: (() => number) | undefined;
|
|
100
|
+
/** Positive deadline for interactive session commands. Defaults to 15 seconds. */
|
|
101
|
+
sessionCommandTimeoutMs?: number;
|
|
102
|
+
/**
|
|
103
|
+
* How this client treats an API that advertises a different
|
|
104
|
+
* `x-opengeni-api-contract` revision.
|
|
105
|
+
*
|
|
106
|
+
* - `"strict"`: fail with `OpenGeniApiContractMismatchError` so a browser
|
|
107
|
+
* page served alongside the API can reload onto the matching bundle.
|
|
108
|
+
* - `"compatible"`: keep working. Within a major release train the API is
|
|
109
|
+
* additive (see the compatibility policy), and the API admits bearer
|
|
110
|
+
* (API key / delegated token) mutations from older SDK revisions, so a
|
|
111
|
+
* backend pinned to an older SDK is not broken by every deployment.
|
|
112
|
+
*
|
|
113
|
+
* Defaults to `"strict"` in a browser client without an `apiKey`, and to
|
|
114
|
+
* `"compatible"` everywhere else.
|
|
115
|
+
*/
|
|
116
|
+
apiContract?: "strict" | "compatible" | undefined;
|
|
25
117
|
};
|
|
26
118
|
/** Per-request cancellation for operations whose caller owns an AbortSignal. */
|
|
27
119
|
export type OpenGeniRequestOptions = {
|
|
28
120
|
signal?: AbortSignal | undefined;
|
|
121
|
+
timeoutMs?: number | undefined;
|
|
122
|
+
/** Opt-in void response handling for focused helpers using the shared transport. */
|
|
123
|
+
responseType?: "json" | "void";
|
|
29
124
|
};
|
|
30
|
-
export type
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
125
|
+
export type SharedSessionReadOptions = {
|
|
126
|
+
/**
|
|
127
|
+
* Observe the selected shared network GET's actual start. A caller joining
|
|
128
|
+
* an already-started request receives its retained generation when the
|
|
129
|
+
* client has a `beginSharedRead` clock.
|
|
130
|
+
*/
|
|
131
|
+
onRequestStart?: ((readGeneration?: number) => void) | undefined;
|
|
132
|
+
/**
|
|
133
|
+
* Stop this caller's interest in the shared read. The native request is
|
|
134
|
+
* aborted only after every caller that joined the same generation has
|
|
135
|
+
* stopped waiting for it.
|
|
136
|
+
*/
|
|
137
|
+
signal?: AbortSignal | undefined;
|
|
138
|
+
};
|
|
139
|
+
export type GetSessionOptions = SharedSessionReadOptions & {
|
|
140
|
+
/**
|
|
141
|
+
* Require a network read generation that starts no earlier than this call.
|
|
142
|
+
* Concurrent callers targeting the same successor generation still share it.
|
|
143
|
+
*/
|
|
144
|
+
fresh?: boolean;
|
|
145
|
+
};
|
|
146
|
+
export type GetSessionLineageOptions = SharedSessionReadOptions;
|
|
147
|
+
/** Follow-up prompt fields accepted by both queue and Steer. Session tools are updated separately. */
|
|
148
|
+
export type SendMessageInput = UserMessageEventInput["payload"] & {
|
|
40
149
|
clientEventId?: string;
|
|
41
|
-
controlEtag?: string;
|
|
42
|
-
expectedDraftRevision?: number;
|
|
43
|
-
mcpCredentialUpdates?: SessionMcpCredentialUpdateInput[];
|
|
44
150
|
};
|
|
45
151
|
export type SteerMessageResult = {
|
|
46
152
|
/** The accepted `user.message` event. */
|
|
47
153
|
accepted: SessionEvent;
|
|
48
154
|
/** The exact turn created for this message in the same server transaction. */
|
|
49
155
|
turn: SessionTurn;
|
|
156
|
+
/** Durable proof that this exact operation committed. */
|
|
157
|
+
receipt: SessionCommandReceipt;
|
|
158
|
+
/** Server-owned destination at admission time. */
|
|
159
|
+
routing: SessionPromptRouting;
|
|
50
160
|
/** Number of live attempts durably asked to stop by this atomic Steer. */
|
|
51
|
-
interruptionCount
|
|
161
|
+
interruptionCount: number;
|
|
52
162
|
/** True when this response came from the command's immutable idempotency receipt. */
|
|
53
|
-
replay
|
|
163
|
+
replay: boolean;
|
|
54
164
|
};
|
|
55
165
|
export type TranscribeAudioInput = {
|
|
56
166
|
audio: Blob | File | Uint8Array;
|
|
@@ -77,19 +187,22 @@ export type FinalizeTranscriptionRecordingInput = {
|
|
|
77
187
|
totalDurationMilliseconds: number;
|
|
78
188
|
signal?: AbortSignal | undefined;
|
|
79
189
|
};
|
|
80
|
-
/**
|
|
81
|
-
* Typed client for the OpenGeni public API. Framework-agnostic: only needs
|
|
82
|
-
* WHATWG `fetch` + streams, so it runs in Node 18+, Bun, Deno, browsers, and
|
|
83
|
-
* edge runtimes.
|
|
84
|
-
*/
|
|
85
190
|
export declare class OpenGeniClient {
|
|
191
|
+
protected externalActorHeader?: string;
|
|
192
|
+
protected serviceInitiatorHeader?: string | undefined;
|
|
193
|
+
protected serviceContextHeader?: string | undefined;
|
|
86
194
|
private readonly baseUrl;
|
|
87
|
-
|
|
195
|
+
protected readonly options: OpenGeniClientOptions;
|
|
88
196
|
private readonly fetchImpl;
|
|
89
|
-
private readonly
|
|
90
|
-
private readonly
|
|
197
|
+
private readonly sessionCommandTimeoutMs;
|
|
198
|
+
private readonly apiContractStrict;
|
|
199
|
+
private readonly active;
|
|
200
|
+
private readonly generations;
|
|
201
|
+
private readonly queued;
|
|
91
202
|
/** Resource-oriented Browser/Computer facade over this exact authenticated client. */
|
|
92
203
|
readonly interaction: OpenGeniInteractionClient;
|
|
204
|
+
/** Dynamic typed tool facade backed by the canonical workspace gateway. */
|
|
205
|
+
readonly tools: OpenGeniToolsFacade;
|
|
93
206
|
constructor(options: OpenGeniClientOptions);
|
|
94
207
|
/** Make one finalization attempt for a recording; callers may retry retained audio. */
|
|
95
208
|
transcribeAudio(workspaceId: string, input: TranscribeAudioInput): Promise<TranscribeAudioResponse>;
|
|
@@ -109,45 +222,126 @@ export declare class OpenGeniClient {
|
|
|
109
222
|
signal?: AbortSignal | undefined;
|
|
110
223
|
}): Promise<TranscriptionRecordingResponse>;
|
|
111
224
|
createSession(workspaceId: string, request: CreateSessionRequest): Promise<CreateSessionResponse>;
|
|
112
|
-
getNewSessionDraft(workspaceId: string): Promise<NewSessionDraft>;
|
|
225
|
+
getNewSessionDraft(workspaceId: string, options?: OpenGeniRequestOptions): Promise<NewSessionDraft>;
|
|
113
226
|
saveNewSessionDraft(workspaceId: string, request: SaveNewSessionDraftRequest): Promise<NewSessionDraft>;
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
227
|
+
/** The workspace's HTTP credential provider, or null when none is configured. */
|
|
228
|
+
getWorkspaceCredentialProvider(workspaceId: string): Promise<GetWorkspaceCredentialProviderResponse>;
|
|
229
|
+
/**
|
|
230
|
+
* Create or update the workspace credential provider. The signing secret is
|
|
231
|
+
* returned only when the provider is first created; store it then.
|
|
232
|
+
*/
|
|
233
|
+
putWorkspaceCredentialProvider(workspaceId: string, request: PutWorkspaceCredentialProviderRequest): Promise<PutWorkspaceCredentialProviderResponse>;
|
|
234
|
+
deleteWorkspaceCredentialProvider(workspaceId: string): Promise<void>;
|
|
235
|
+
listWorkspaceWebhooks(workspaceId: string): Promise<ListWorkspaceWebhooksResponse>;
|
|
236
|
+
/** Create a webhook. The signing secret is returned only in this response. */
|
|
237
|
+
createWorkspaceWebhook(workspaceId: string, request: CreateWorkspaceWebhookRequest): Promise<CreateWorkspaceWebhookResponse>;
|
|
238
|
+
updateWorkspaceWebhook(workspaceId: string, webhookId: string, request: UpdateWorkspaceWebhookRequest): Promise<WorkspaceWebhook>;
|
|
239
|
+
deleteWorkspaceWebhook(workspaceId: string, webhookId: string): Promise<void>;
|
|
240
|
+
listWorkspaceWebhookDeliveries(workspaceId: string, webhookId: string, options?: {
|
|
241
|
+
limit?: number;
|
|
242
|
+
}): Promise<ListWorkspaceWebhookDeliveriesResponse>;
|
|
243
|
+
/** Queue a delivered or failed delivery again with a fresh attempt budget. */
|
|
244
|
+
redeliverWorkspaceWebhookDelivery(workspaceId: string, webhookId: string, deliveryId: string): Promise<WorkspaceWebhookDelivery>;
|
|
245
|
+
/** Images this deployment lets a workspace choose as its default sandbox image. */
|
|
246
|
+
listWorkspaceSandboxImages(workspaceId: string): Promise<WorkspaceSandboxImages>;
|
|
247
|
+
/** Submit general feedback or a session/turn rating. Retain the key when retrying. */
|
|
248
|
+
createFeedback(workspaceId: string, request: CreateFeedbackRequest): Promise<FeedbackSubmissionResponse>;
|
|
249
|
+
/** Only this principal's submissions. No session filter means general feedback only. */
|
|
250
|
+
listOwnFeedback(workspaceId: string, options?: {
|
|
251
|
+
sessionId?: string;
|
|
252
|
+
limit?: number;
|
|
253
|
+
includeTurns?: boolean;
|
|
254
|
+
}): Promise<{
|
|
255
|
+
feedback: Feedback[];
|
|
256
|
+
}>;
|
|
257
|
+
getSession(workspaceId: string, sessionId: string, options?: GetSessionOptions): Promise<Session>;
|
|
258
|
+
/** Exact model-visible prefix captured from the latest provider request. */
|
|
259
|
+
getSessionModelContext(workspaceId: string, sessionId: string): Promise<SessionModelContextResponse>;
|
|
117
260
|
updateSession(workspaceId: string, sessionId: string, request: UpdateSessionRequest): Promise<Session>;
|
|
261
|
+
/** Replace the complete ordered Variable Set selection at a quiescent turn boundary. */
|
|
262
|
+
updateSessionVariableSets(workspaceId: string, sessionId: string, request: UpdateSessionVariableSetsRequest): Promise<Session>;
|
|
263
|
+
/** Whether this exact authenticated principal may atomically create a private session. */
|
|
264
|
+
getSessionTenancyCreateCapabilities(workspaceId: string): Promise<SessionTenancyCreateCapabilities>;
|
|
265
|
+
/** Change an owned, fully quiescent session between private and workspace visibility. */
|
|
266
|
+
updateSessionVisibility(workspaceId: string, sessionId: string, request: UpdateSessionVisibilityRequest): Promise<UpdateSessionVisibilityResponse>;
|
|
267
|
+
/** Create an independent same-workspace fork with explicit destination visibility. */
|
|
268
|
+
forkSession(workspaceId: string, sessionId: string, request: ForkSessionRequest): Promise<ForkSessionResponse>;
|
|
118
269
|
/** Replace the durable tool policy or explicitly adopt workspace defaults. */
|
|
119
270
|
updateSessionToolPolicy(workspaceId: string, sessionId: string, request: UpdateSessionToolPolicyRequest): Promise<Session>;
|
|
271
|
+
/**
|
|
272
|
+
* Replace the session's agent configuration (capabilities, identity,
|
|
273
|
+
* instructions alias, renderer). Omitted fields keep their current values.
|
|
274
|
+
* Uses the tool-policy version (409 when stale) and applies from the next
|
|
275
|
+
* turn. A legacy session converts from its current effective state.
|
|
276
|
+
*/
|
|
277
|
+
updateSessionAgent(workspaceId: string, sessionId: string, request: UpdateSessionAgentRequest): Promise<Session>;
|
|
120
278
|
/**
|
|
121
279
|
* Replace one attached MCP server's approval policy. The change is captured
|
|
122
280
|
* by the next claimed attempt; already-claimed work keeps its immutable
|
|
123
281
|
* policy snapshot.
|
|
124
282
|
*/
|
|
125
283
|
updateSessionMcpApprovalPolicy(workspaceId: string, sessionId: string, serverId: string, request: UpdateSessionMcpApprovalPolicyRequest): Promise<UpdateSessionMcpApprovalPolicyResponse>;
|
|
284
|
+
/** Search durable visible user/assistant text, including unloaded history.
|
|
285
|
+
* Pages may be empty with hasMore=true. Never fall back to title search on
|
|
286
|
+
* older servers. Use listEventPage before/after the returned sequence for context.
|
|
287
|
+
*/
|
|
288
|
+
searchSessionMessages(workspaceId: string, request: SessionMessageSearchRequest, options?: OpenGeniRequestOptions): Promise<SessionMessageSearchResponse>;
|
|
289
|
+
/** Read one selected search result's complete visible text when <=12,000
|
|
290
|
+
* UTF-16 units. Stale, duplicate or non-message references fail with 404.
|
|
291
|
+
* The response never includes audit payload fields such as modelContext.
|
|
292
|
+
*/
|
|
293
|
+
getSessionMessagePreview(workspaceId: string, sessionId: string, reference: SessionMessagePreviewReference, options?: OpenGeniRequestOptions): Promise<SessionMessagePreview>;
|
|
126
294
|
listSessions(workspaceId: string, options?: {
|
|
295
|
+
originSiteId?: string;
|
|
127
296
|
limit?: number;
|
|
128
297
|
parentSessionId?: string | null;
|
|
129
298
|
search?: string;
|
|
299
|
+
/** Only sessions carrying this exact opaque end-user label. */
|
|
300
|
+
scopeSubjectId?: SessionScopeSubjectId;
|
|
130
301
|
}): Promise<Session[]>;
|
|
302
|
+
/** Running and stopping commands only; settled results remain in session history. */
|
|
303
|
+
listSessionBackgroundCommands(workspaceId: string, sessionId: string, options?: OpenGeniRequestOptions): Promise<SessionBackgroundCommandListResponse>;
|
|
304
|
+
cancelSessionBackgroundCommand(workspaceId: string, sessionId: string, commandId: string): Promise<CancelSessionBackgroundCommandResult>;
|
|
131
305
|
/** Pin-aware ordinary-session page with a stable keyset cursor. */
|
|
132
|
-
listSessionPage(workspaceId: string, options?:
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
search?: string;
|
|
137
|
-
/** Return only the complete personal pinned projection. */
|
|
138
|
-
pinsOnly?: boolean;
|
|
139
|
-
}): Promise<SessionListResponse>;
|
|
306
|
+
listSessionPage(workspaceId: string, options?: SessionListPageOptions): Promise<SessionListResponse>;
|
|
307
|
+
/** Compact rail records; safely projects full pages from older APIs. */
|
|
308
|
+
listSessionSummaryPage(workspaceId: string, options?: SessionListPageOptions): Promise<SessionListEntryResponse>;
|
|
309
|
+
private requestSessionPage;
|
|
140
310
|
/** Compact, bounded workspace agent hierarchy page. */
|
|
141
311
|
listAgentTopology(workspaceId: string, options?: {
|
|
142
312
|
limit?: number;
|
|
143
313
|
parentSessionId?: string | null;
|
|
314
|
+
rootSessionId?: string;
|
|
144
315
|
cursor?: string;
|
|
316
|
+
query?: string;
|
|
317
|
+
/** @deprecated use query. */
|
|
145
318
|
search?: string;
|
|
319
|
+
statuses?: SessionStatus[];
|
|
320
|
+
activeOnly?: boolean;
|
|
321
|
+
recentHours?: number;
|
|
322
|
+
subject?: {
|
|
323
|
+
namespace: string;
|
|
324
|
+
type: WorkClaimSubjectType;
|
|
325
|
+
canonicalKey: string;
|
|
326
|
+
};
|
|
327
|
+
claimLimit?: number;
|
|
146
328
|
}): Promise<AgentTopologyPageResponse>;
|
|
147
329
|
/** Set this authenticated member's personal workspace pin for a session. */
|
|
148
330
|
updateSessionPin(workspaceId: string, sessionId: string, request: UpdateSessionPinRequest): Promise<Session>;
|
|
149
|
-
|
|
150
|
-
|
|
331
|
+
/** Set this authenticated member's explicit read/actively-working state. */
|
|
332
|
+
updateSessionAttention(workspaceId: string, sessionId: string, request: UpdateSessionAttentionRequest): Promise<Session>;
|
|
333
|
+
/** Archive or restore this authenticated member's root chat. */
|
|
334
|
+
updateSessionArchive(workspaceId: string, sessionId: string, request: UpdateSessionArchiveRequest): Promise<Session>;
|
|
335
|
+
/** Permanently delete one quiescent root session and its full descendant tree. */
|
|
336
|
+
deleteSession(workspaceId: string, sessionId: string): Promise<{
|
|
337
|
+
deletedSessionCount: number;
|
|
338
|
+
}>;
|
|
339
|
+
getSessionLineage(workspaceId: string, sessionId: string, options?: GetSessionLineageOptions): Promise<SessionLineageResponse>;
|
|
340
|
+
private sharedRead;
|
|
341
|
+
private queueRead;
|
|
342
|
+
private launchRead;
|
|
343
|
+
private consumeSharedRead;
|
|
344
|
+
private observeRead;
|
|
151
345
|
/** Negotiate one server-mediated connected-Codex GPT-Live V3 WebRTC call. */
|
|
152
346
|
negotiateCodexRealtimeWebrtc(workspaceId: string, sessionId: string, request: CodexRealtimeWebrtcRequest, options?: {
|
|
153
347
|
signal?: AbortSignal | undefined;
|
|
@@ -156,6 +350,10 @@ export declare class OpenGeniClient {
|
|
|
156
350
|
negotiateGatewayRealtime(workspaceId: string, sessionId: string, request: GatewayRealtimeConnectRequest, options?: {
|
|
157
351
|
signal?: AbortSignal | undefined;
|
|
158
352
|
}): Promise<GatewayRealtimeConnectResponse>;
|
|
353
|
+
/** Mint a short-lived browser token from a connected SuperGrok account. */
|
|
354
|
+
negotiateXaiSubscriptionRealtime(workspaceId: string, sessionId: string, request: GatewayRealtimeConnectRequest, options?: {
|
|
355
|
+
signal?: AbortSignal | undefined;
|
|
356
|
+
}): Promise<GatewayRealtimeConnectResponse>;
|
|
159
357
|
/** Promote a negotiated connection only after its browser data channel is ready. */
|
|
160
358
|
activateCodexRealtimeConnection(workspaceId: string, sessionId: string, realtimeId: string, connectionId: string, request: ActivateCodexRealtimeConnectionRequest, options?: {
|
|
161
359
|
signal?: AbortSignal | undefined;
|
|
@@ -171,9 +369,10 @@ export declare class OpenGeniClient {
|
|
|
171
369
|
listTurns(workspaceId: string, sessionId: string, options?: {
|
|
172
370
|
limit?: number;
|
|
173
371
|
latestStarted?: boolean;
|
|
372
|
+
signal?: AbortSignal | undefined;
|
|
174
373
|
}): Promise<SessionTurn[]>;
|
|
175
374
|
/** Newest turn that durably emitted `turn.started`, or null before any admission. */
|
|
176
|
-
getLatestStartedTurn(workspaceId: string, sessionId: string): Promise<SessionTurn | null>;
|
|
375
|
+
getLatestStartedTurn(workspaceId: string, sessionId: string, options?: OpenGeniRequestOptions): Promise<SessionTurn | null>;
|
|
177
376
|
/**
|
|
178
377
|
* List the workspace's machines (the Machines dashboard). Each enrolled
|
|
179
378
|
* selfhosted machine carries its derived state + latest metrics +
|
|
@@ -184,6 +383,13 @@ export declare class OpenGeniClient {
|
|
|
184
383
|
sessionId?: string;
|
|
185
384
|
signal?: AbortSignal;
|
|
186
385
|
}): Promise<MachinesResponse>;
|
|
386
|
+
/** Ask one authoritative Connected Machine runner to drain accepted work and
|
|
387
|
+
* install the exact signed version promoted for its channel. Progress is read
|
|
388
|
+
* from `listMachines`; completion requires the successor build identity. */
|
|
389
|
+
updateMachineAgent(workspaceId: string, enrollmentId: string): Promise<UpdateMachineAgentResponse>;
|
|
390
|
+
/** Revision-fenced update of a Connected Machine's optional command memory
|
|
391
|
+
* policy. Null byte limits preserve unrestricted machine access. */
|
|
392
|
+
updateMachineOperationPolicy(workspaceId: string, enrollmentId: string, request: UpdateMachineOperationPolicyRequest): Promise<MachineOperationPolicy>;
|
|
187
393
|
/**
|
|
188
394
|
* Read the downsampled (~1/min) metrics series for ONE machine over a time
|
|
189
395
|
* window (default 1h). The samples are oldest-first (a left-to-right chart).
|
|
@@ -194,8 +400,9 @@ export declare class OpenGeniClient {
|
|
|
194
400
|
/**
|
|
195
401
|
* Remove one connected self-hosted machine enrollment. The control-plane
|
|
196
402
|
* operation works while the agent is offline, revokes future reconnects,
|
|
197
|
-
* retains history, and
|
|
198
|
-
*
|
|
403
|
+
* retains history, and atomically detaches idle dependent sessions (a
|
|
404
|
+
* machine-home session becomes `backend:none`). Active turns, live leases,
|
|
405
|
+
* and recovery work remain typed blockers. `idempotencyKey` is replay-safe.
|
|
199
406
|
*/
|
|
200
407
|
removeEnrollment(workspaceId: string, enrollmentId: string, request?: RemoveEnrollmentRequest): Promise<RemoveEnrollmentResponse>;
|
|
201
408
|
/**
|
|
@@ -213,10 +420,7 @@ export declare class OpenGeniClient {
|
|
|
213
420
|
* is the authoritative screen-control consent (whole-machine is mandatory/implicit).
|
|
214
421
|
* Lands an enrollment + a selfhosted sandbox and unblocks the agent's poll.
|
|
215
422
|
*/
|
|
216
|
-
approveDeviceEnrollment(workspaceId: string, request:
|
|
217
|
-
userCode: string;
|
|
218
|
-
allowScreenControl?: boolean;
|
|
219
|
-
}): Promise<DeviceEnrollmentApproveResponse>;
|
|
423
|
+
approveDeviceEnrollment(workspaceId: string, request: DeviceEnrollmentApproveRequest): Promise<DeviceEnrollmentApproveResponse>;
|
|
220
424
|
/** Deny a pending device-enrollment flow (the explicit "no" at the approve page). */
|
|
221
425
|
denyDeviceEnrollment(workspaceId: string, request: {
|
|
222
426
|
userCode: string;
|
|
@@ -241,8 +445,15 @@ export declare class OpenGeniClient {
|
|
|
241
445
|
swapActiveSandbox(workspaceId: string, sessionId: string, request: SwapActiveSandboxRequest): Promise<SwapActiveSandboxResponse>;
|
|
242
446
|
listScheduledTasks(workspaceId: string, options?: {
|
|
243
447
|
limit?: number;
|
|
448
|
+
offset?: number;
|
|
449
|
+
sessionId?: string;
|
|
244
450
|
}): Promise<ScheduledTask[]>;
|
|
245
451
|
getScheduledTask(workspaceId: string, taskId: string): Promise<ScheduledTask>;
|
|
452
|
+
/**
|
|
453
|
+
* Channels a person may choose as a scheduled task's fixed Slack destination:
|
|
454
|
+
* active, non-shared channels the selected OpenGeni bot already belongs to.
|
|
455
|
+
*/
|
|
456
|
+
listScheduledTaskSlackChannels(workspaceId: string, connectionId: string, cursor?: string): Promise<SlackReactionChannelListResponse>;
|
|
246
457
|
/**
|
|
247
458
|
* Return the events from one bounded page. With no cursor, this uses the safe
|
|
248
459
|
* semantic monitoring tail; pass explicit forensic options and a cursor for
|
|
@@ -299,8 +510,15 @@ export declare class OpenGeniClient {
|
|
|
299
510
|
editQueueItem(workspaceId: string, sessionId: string, turnId: string, request: EditSessionQueueItemRequest): Promise<SessionQueueMutationResponse>;
|
|
300
511
|
steerQueueItem(workspaceId: string, sessionId: string, turnId: string, request: SteerSessionQueueItemRequest): Promise<SessionQueueMutationResponse>;
|
|
301
512
|
deleteQueueItem(workspaceId: string, sessionId: string, turnId: string, request: DeleteSessionQueueItemRequest): Promise<SessionQueueMutationResponse>;
|
|
302
|
-
getComposerDraft(workspaceId: string, sessionId: string): Promise<ComposerDraft>;
|
|
513
|
+
getComposerDraft(workspaceId: string, sessionId: string, options?: OpenGeniRequestOptions): Promise<ComposerDraft>;
|
|
303
514
|
saveComposerDraft(workspaceId: string, sessionId: string, request: SaveComposerDraftRequest): Promise<ComposerDraft>;
|
|
515
|
+
submitComposerDraft(workspaceId: string, sessionId: string, request: SubmitComposerDraftRequest): Promise<SubmitComposerDraftResponse>;
|
|
516
|
+
/** Inspect bounded checkpoint recovery eligibility without changing session state. */
|
|
517
|
+
getSandboxRecovery(workspaceId: string, sessionId: string): Promise<SandboxRecoveryProjection>;
|
|
518
|
+
/** Restore only the explicitly selected checkpoint; never retry a command. */
|
|
519
|
+
recoverSandbox(workspaceId: string, sessionId: string, request: SandboxRecoveryRequest): Promise<SandboxRecoveryResponse>;
|
|
520
|
+
/** Retry the exact failed turn. Keep clientEventId unchanged on transport retries. */
|
|
521
|
+
retrySession(workspaceId: string, sessionId: string, request: SessionRetryRequest): Promise<SessionRetryResponse>;
|
|
304
522
|
controlSession(workspaceId: string, sessionId: string, request: {
|
|
305
523
|
action: "pause" | "resume" | "cancel";
|
|
306
524
|
reason?: string;
|
|
@@ -322,6 +540,9 @@ export declare class OpenGeniClient {
|
|
|
322
540
|
clientEventId?: string;
|
|
323
541
|
expectedControlEtag?: string;
|
|
324
542
|
}): Promise<SessionControlResponse>;
|
|
543
|
+
setWorkspacePauseTimer(workspaceId: string, request: import("./types.js").WorkspacePauseTimerRequest): Promise<{
|
|
544
|
+
ok: boolean;
|
|
545
|
+
}>;
|
|
325
546
|
setWorkspaceInferenceState(workspaceId: string, request: {
|
|
326
547
|
action: "pause" | "resume";
|
|
327
548
|
reason?: string;
|
|
@@ -338,6 +559,17 @@ export declare class OpenGeniClient {
|
|
|
338
559
|
limit?: number;
|
|
339
560
|
}): Promise<WorkspaceControlEventPage>;
|
|
340
561
|
streamWorkspaceControlEvents(workspaceId: string, options?: StreamSessionEventsOptions): AsyncGenerator<WorkspaceControlEvent, void, void>;
|
|
562
|
+
/**
|
|
563
|
+
* Multiplex workspace control and interaction invalidations over one HTTP
|
|
564
|
+
* connection while retaining an independent durable cursor for each domain.
|
|
565
|
+
*/
|
|
566
|
+
streamWorkspaceLiveEvents(workspaceId: string, options?: WorkspaceLiveStreamOptions): AsyncGenerator<import("./workspace-live-stream.js").WorkspaceLiveEvent, void, void>;
|
|
567
|
+
workspaceLiveStreamTransport(workspaceId: string): WorkspaceLiveStreamTransport;
|
|
568
|
+
openWorkspaceLiveEventStream(workspaceId: string, options?: {
|
|
569
|
+
controlAfter?: number;
|
|
570
|
+
interactionAfter?: number;
|
|
571
|
+
signal?: AbortSignal;
|
|
572
|
+
}): Promise<ReadableStream<Uint8Array>>;
|
|
341
573
|
workspaceControlStreamTransport(workspaceId: string): WorkspaceControlStreamTransport;
|
|
342
574
|
openWorkspaceControlEventStream(workspaceId: string, options?: {
|
|
343
575
|
after?: number;
|
|
@@ -349,8 +581,13 @@ export declare class OpenGeniClient {
|
|
|
349
581
|
*/
|
|
350
582
|
steerMessage(workspaceId: string, sessionId: string, message: string | SendMessageInput): Promise<SteerMessageResult>;
|
|
351
583
|
/** The session's goal. 404s when the session never had one. */
|
|
352
|
-
getGoal(workspaceId: string, sessionId: string): Promise<SessionGoal>;
|
|
584
|
+
getGoal(workspaceId: string, sessionId: string, options?: SharedSessionReadOptions): Promise<SessionGoal>;
|
|
353
585
|
updateGoal(workspaceId: string, sessionId: string, request: UpdateSessionGoalRequest): Promise<SessionGoal>;
|
|
586
|
+
listGoalRevisions(workspaceId: string, sessionId: string): Promise<SessionGoalRevision[]>;
|
|
587
|
+
listGoalRevisionPage(workspaceId: string, sessionId: string, options?: ListSessionGoalRevisionsOptions): Promise<ListSessionGoalRevisionsResponse>;
|
|
588
|
+
rejectGoalRevision(workspaceId: string, sessionId: string, revisionId: string, request: RejectSessionGoalRevisionRequest): Promise<RejectSessionGoalRevisionResponse>;
|
|
589
|
+
rollbackGoalRevision(workspaceId: string, sessionId: string, revisionId: string, request: RollbackSessionGoalRevisionRequest): Promise<SessionGoal>;
|
|
590
|
+
applyGoalRevision(workspaceId: string, sessionId: string, revisionId: string, request: ApplySessionGoalRevisionRequest): Promise<SessionGoal>;
|
|
354
591
|
deleteGoal(workspaceId: string, sessionId: string): Promise<void>;
|
|
355
592
|
/** Pause the goal loop: the session stops self-continuing until resumed. */
|
|
356
593
|
pauseGoal(workspaceId: string, sessionId: string, options?: {
|
|
@@ -374,6 +611,8 @@ export declare class OpenGeniClient {
|
|
|
374
611
|
fsListBatch(workspaceId: string, sessionId: string, request: FsListBatchRequest, options?: OpenGeniRequestOptions): Promise<FsListBatchResponse>;
|
|
375
612
|
/** FileSystem: read a file (text or base64; binary-safe, size-capped). */
|
|
376
613
|
fsRead(workspaceId: string, sessionId: string, request: FsReadRequest, options?: OpenGeniRequestOptions): Promise<FsReadResponse>;
|
|
614
|
+
/** Publish one exact sandbox file into permanent workspace artifact storage. */
|
|
615
|
+
publishSandboxFileArtifact(workspaceId: string, sessionId: string, request: PublishSandboxFileArtifactRequest, options?: OpenGeniRequestOptions): Promise<SandboxFileArtifactReceipt>;
|
|
377
616
|
/** FileSystem: write a file (last-writer-wins; emits fs.changed). */
|
|
378
617
|
fsWrite(workspaceId: string, sessionId: string, request: FsWriteRequest): Promise<FsWriteResponse>;
|
|
379
618
|
/** FileSystem: delete a path (emits fs.changed). */
|
|
@@ -436,22 +675,56 @@ export declare class OpenGeniClient {
|
|
|
436
675
|
heartbeatViewer(workspaceId: string, sessionId: string, viewerId: string, request: ViewerHeartbeatRequest): Promise<ViewerHeartbeatResponse>;
|
|
437
676
|
/** Detach a viewer (delete this holder; idempotent delete-my-row). */
|
|
438
677
|
detachViewer(workspaceId: string, sessionId: string, viewerId: string): Promise<void>;
|
|
678
|
+
streamWorkspaceInteractionRevisions(workspaceId: string, options?: StreamSessionEventsOptions): AsyncGenerator<WorkspaceInteractionRevisionEvent, void, void>;
|
|
679
|
+
workspaceInteractionRevisionStreamTransport(workspaceId: string): WorkspaceInteractionRevisionStreamTransport;
|
|
680
|
+
openWorkspaceInteractionRevisionStream(workspaceId: string, options?: {
|
|
681
|
+
after?: number;
|
|
682
|
+
signal?: AbortSignal;
|
|
683
|
+
}): Promise<ReadableStream<Uint8Array>>;
|
|
684
|
+
listNetworkRoutes(workspaceId: string, options?: NetworkRouteListOptions): Promise<NetworkRouteListResponse>;
|
|
685
|
+
getNetworkRoute(workspaceId: string, networkRouteId: string, options?: OpenGeniRequestOptions): Promise<NetworkRoute>;
|
|
686
|
+
createNetworkRoute(workspaceId: string, request: CreateNetworkRouteRequest, options?: OpenGeniRequestOptions): Promise<NetworkRouteMutationResponse>;
|
|
687
|
+
updateNetworkRoute(workspaceId: string, networkRouteId: string, request: UpdateNetworkRouteRequest, options?: OpenGeniRequestOptions): Promise<NetworkRouteMutationResponse>;
|
|
688
|
+
listSiteAuthConnections(workspaceId: string, options?: SiteAuthConnectionListOptions): Promise<SiteAuthConnectionListResponse>;
|
|
689
|
+
getSiteAuthConnection(workspaceId: string, siteAuthConnectionId: string, options?: OpenGeniRequestOptions): Promise<SiteAuthConnection>;
|
|
690
|
+
createSiteAuthConnection(workspaceId: string, request: CreateSiteAuthConnectionRequest, options?: OpenGeniRequestOptions): Promise<SiteAuthConnectionMutationResponse>;
|
|
691
|
+
updateSiteAuthConnection(workspaceId: string, siteAuthConnectionId: string, request: UpdateSiteAuthConnectionRequest, options?: OpenGeniRequestOptions): Promise<SiteAuthConnectionMutationResponse>;
|
|
692
|
+
listAuthRuns(workspaceId: string, options?: AuthRunListOptions): Promise<AuthRunListResponse>;
|
|
693
|
+
getAuthRun(workspaceId: string, authRunId: string, options?: OpenGeniRequestOptions): Promise<AuthRun>;
|
|
694
|
+
startBrowserAuthRun(workspaceId: string, browserSessionId: string, request: StartAuthRunRequest, options?: OpenGeniRequestOptions): Promise<AuthRunMutationResponse>;
|
|
695
|
+
reportBrowserAuthRun(workspaceId: string, browserSessionId: string, authRunId: string, request: ReportAuthRunRequest, options?: OpenGeniRequestOptions): Promise<AuthRunMutationResponse>;
|
|
696
|
+
protectedBrowserAuthFill(workspaceId: string, browserSessionId: string, authRunId: string, request: ProtectedAuthFillRequest, options?: OpenGeniRequestOptions): Promise<ProtectedAuthFillResponse>;
|
|
697
|
+
advanceExternalBrowserAuthRun(workspaceId: string, browserSessionId: string, authRunId: string, request: ExternalAuthRunRequest, options?: OpenGeniRequestOptions): Promise<ExternalAuthRunResponse>;
|
|
698
|
+
openExternalBrowserAuthFlow(workspaceId: string, browserSessionId: string, authRunId: string, request: ExternalAuthInteractiveRequest, options?: OpenGeniRequestOptions): Promise<ExternalAuthInteractiveResponse>;
|
|
699
|
+
verifyBrowserAuthRun(workspaceId: string, browserSessionId: string, authRunId: string, request: VerifyAuthRunRequest, options?: OpenGeniRequestOptions): Promise<AuthRunMutationResponse>;
|
|
700
|
+
listInteractionInterventions(workspaceId: string, options?: InteractionInterventionListOptions): Promise<InteractionInterventionListResponse>;
|
|
701
|
+
getInteractionIntervention(workspaceId: string, interventionId: string, options?: OpenGeniRequestOptions): Promise<InteractionIntervention>;
|
|
702
|
+
createInteractionIntervention(workspaceId: string, request: CreateInteractionInterventionRequest, options?: OpenGeniRequestOptions): Promise<InteractionInterventionMutationResponse>;
|
|
703
|
+
resolveInteractionIntervention(workspaceId: string, interventionId: string, request: ResolveInteractionInterventionRequest, options?: OpenGeniRequestOptions): Promise<InteractionInterventionMutationResponse>;
|
|
439
704
|
listAttachedBrowsers(workspaceId: string, options?: AttachedBrowserDeviceListOptions): Promise<AttachedBrowserDeviceListResponse>;
|
|
440
705
|
getAttachedBrowser(workspaceId: string, deviceId: string, options?: OpenGeniRequestOptions): Promise<AttachedBrowserDevice>;
|
|
441
706
|
listBrowserIdentities(workspaceId: string, options?: BrowserIdentityListOptions): Promise<BrowserIdentityListResponse>;
|
|
442
707
|
getBrowserIdentity(workspaceId: string, identityId: string, options?: OpenGeniRequestOptions): Promise<BrowserIdentity>;
|
|
443
708
|
createBrowserIdentity(workspaceId: string, request: CreateBrowserIdentityRequest, options?: OpenGeniRequestOptions): Promise<BrowserIdentityMutationResponse>;
|
|
709
|
+
updateBrowserIdentity(workspaceId: string, identityId: string, request: UpdateBrowserIdentityRequest, options?: OpenGeniRequestOptions): Promise<BrowserIdentityMutationResponse>;
|
|
444
710
|
listBrowserRevisions(workspaceId: string, identityId: string, options?: OpenGeniRequestOptions): Promise<BrowserRevisionListResponse>;
|
|
445
711
|
/** Workspace-wide BrowserSession inventory. Associations express relevance,
|
|
446
712
|
* not access: peers and child agents intentionally remain discoverable. */
|
|
447
713
|
listBrowserSessions(workspaceId: string, options?: OpenGeniRequestOptions): Promise<BrowserSessionListResponse>;
|
|
448
714
|
getBrowserSession(workspaceId: string, browserSessionId: string, options?: OpenGeniRequestOptions): Promise<BrowserSession>;
|
|
715
|
+
readBrowserClipboard(workspaceId: string, browserSessionId: string, options?: OpenGeniRequestOptions): Promise<BrowserClipboard>;
|
|
716
|
+
listBrowserDownloads(workspaceId: string, browserSessionId: string, options?: OpenGeniRequestOptions): Promise<BrowserDownloadListResponse>;
|
|
717
|
+
getBrowserDownload(workspaceId: string, browserSessionId: string, downloadId: string, options?: OpenGeniRequestOptions): Promise<BrowserDownload>;
|
|
718
|
+
saveBrowserDownload(workspaceId: string, browserSessionId: string, downloadId: string, request: BrowserDownloadSaveRequest, options?: OpenGeniRequestOptions): Promise<BrowserDownloadSaveResponse>;
|
|
449
719
|
createBrowserSession(workspaceId: string, request: CreateBrowserSessionRequest, options?: OpenGeniRequestOptions): Promise<BrowserSessionMutationResponse>;
|
|
450
720
|
listBrowserTargets(workspaceId: string, browserSessionId: string, options?: OpenGeniRequestOptions): Promise<BrowserTargetListResponse>;
|
|
451
|
-
openBrowserTarget(workspaceId: string, browserSessionId: string, request?: BrowserOpenTargetRequest, options?: OpenGeniRequestOptions): Promise<
|
|
452
|
-
selectBrowserTarget(workspaceId: string, browserSessionId: string, targetId: string, options?: OpenGeniRequestOptions): Promise<
|
|
721
|
+
openBrowserTarget(workspaceId: string, browserSessionId: string, request?: BrowserOpenTargetRequest, options?: OpenGeniRequestOptions): Promise<BrowserObservation>;
|
|
722
|
+
selectBrowserTarget(workspaceId: string, browserSessionId: string, targetId: string, options?: OpenGeniRequestOptions): Promise<BrowserObservation>;
|
|
723
|
+
captureBrowserTarget(workspaceId: string, browserSessionId: string, targetId: string, options?: OpenGeniRequestOptions, captureOptions?: BrowserScreenshotOptions): Promise<BrowserFrame>;
|
|
453
724
|
closeBrowserTarget(workspaceId: string, browserSessionId: string, targetId: string, options?: OpenGeniRequestOptions): Promise<BrowserTargetListResponse>;
|
|
454
725
|
observeBrowserTarget(workspaceId: string, browserSessionId: string, targetId: string, options?: OpenGeniRequestOptions): Promise<BrowserObservation>;
|
|
726
|
+
getBrowserTargetState(workspaceId: string, browserSessionId: string, targetId: string, options?: OpenGeniRequestOptions): Promise<BrowserTargetState>;
|
|
727
|
+
readBrowserDom(workspaceId: string, browserSessionId: string, targetId: string, request: BrowserDomReadRequest, options?: OpenGeniRequestOptions): Promise<BrowserDomReadResponse>;
|
|
455
728
|
actInBrowser(workspaceId: string, browserSessionId: string, request: BrowserActionRequest, options?: OpenGeniRequestOptions): Promise<BrowserActionReceipt>;
|
|
456
729
|
getBrowserActionReceipt(workspaceId: string, browserSessionId: string, operationId: string, options?: OpenGeniRequestOptions): Promise<BrowserActionReceipt>;
|
|
457
730
|
listBrowserDiagnostics(workspaceId: string, browserSessionId: string, targetId: string, options?: BrowserDiagnosticsOptions): Promise<BrowserDiagnosticBatch>;
|
|
@@ -465,9 +738,12 @@ export declare class OpenGeniClient {
|
|
|
465
738
|
* relevance, not access; peer sessions intentionally remain discoverable. */
|
|
466
739
|
listComputerSessions(workspaceId: string, options?: OpenGeniRequestOptions): Promise<ComputerSessionListResponse>;
|
|
467
740
|
getComputerSession(workspaceId: string, computerSessionId: string, options?: OpenGeniRequestOptions): Promise<ComputerSession>;
|
|
741
|
+
readComputerClipboard(workspaceId: string, computerSessionId: string, options?: OpenGeniRequestOptions): Promise<ComputerClipboard>;
|
|
742
|
+
getComputerInputPosture(workspaceId: string, computerSessionId: string, options?: OpenGeniRequestOptions): Promise<ComputerSessionInputPosture>;
|
|
468
743
|
createComputerSession(workspaceId: string, request: CreateComputerSessionRequest, options?: OpenGeniRequestOptions): Promise<ComputerSessionMutationResponse>;
|
|
469
744
|
listComputerTargets(workspaceId: string, computerSessionId: string, options?: OpenGeniRequestOptions): Promise<ComputerTargetListResponse>;
|
|
470
745
|
observeComputerTarget(workspaceId: string, computerSessionId: string, targetId: string, options?: OpenGeniRequestOptions): Promise<ComputerObservation>;
|
|
746
|
+
captureComputerTarget(workspaceId: string, computerSessionId: string, targetId: string, options?: OpenGeniRequestOptions): Promise<ComputerFrame>;
|
|
471
747
|
actInComputer(workspaceId: string, computerSessionId: string, request: ComputerActionRequest, options?: OpenGeniRequestOptions): Promise<ComputerActionReceipt>;
|
|
472
748
|
getComputerActionReceipt(workspaceId: string, computerSessionId: string, operationId: string, options?: OpenGeniRequestOptions): Promise<ComputerActionReceipt>;
|
|
473
749
|
attachComputerSession(workspaceId: string, computerSessionId: string, request: ComputerSessionAttachmentRequest, options?: OpenGeniRequestOptions): Promise<ComputerSessionAttachment>;
|
|
@@ -479,16 +755,199 @@ export declare class OpenGeniClient {
|
|
|
479
755
|
* reasoning efforts, MCP servers, file-upload limits, and how the client is
|
|
480
756
|
* expected to authenticate. Drives a composer's model picker without prior
|
|
481
757
|
* knowledge of the host setup; safe to call before any auth is established.
|
|
758
|
+
* Authenticated calls resolve the caller's default workspace, or the exact
|
|
759
|
+
* `workspaceId` option, using the same selection rules as fresh session create.
|
|
482
760
|
*/
|
|
483
|
-
getClientConfig(
|
|
761
|
+
getClientConfig(options?: OpenGeniRequestOptions & {
|
|
762
|
+
workspaceId?: string;
|
|
763
|
+
}): Promise<ClientConfig>;
|
|
484
764
|
/** Authenticated model definitions plus workspace-specific selectability. */
|
|
485
|
-
getWorkspaceModelCatalog(workspaceId: string): Promise<WorkspaceModelCatalogResponse>;
|
|
765
|
+
getWorkspaceModelCatalog(workspaceId: string, options?: OpenGeniRequestOptions): Promise<WorkspaceModelCatalogResponse>;
|
|
766
|
+
/** List workspace-owned unpinned Vercel AI Gateway model slugs. */
|
|
767
|
+
listWorkspaceGatewayCustomModels(workspaceId: string): Promise<WorkspaceGatewayCustomModelsResponse>;
|
|
768
|
+
/** Add one exact upstream Vercel AI Gateway slug. */
|
|
769
|
+
createWorkspaceGatewayCustomModel(workspaceId: string, request: CreateWorkspaceGatewayCustomModelRequest): Promise<WorkspaceGatewayCustomModel>;
|
|
770
|
+
/** Remove one workspace custom Gateway model by its stable row id. */
|
|
771
|
+
deleteWorkspaceGatewayCustomModel(workspaceId: string, customModelId: string, request: DeleteWorkspaceGatewayCustomModelRequest): Promise<void>;
|
|
772
|
+
/** List workspace-owned unpinned OpenRouter model slugs. */
|
|
773
|
+
listWorkspaceOpenRouterCustomModels(workspaceId: string): Promise<WorkspaceOpenRouterCustomModelsResponse>;
|
|
774
|
+
/** Add one exact upstream OpenRouter slug. */
|
|
775
|
+
createWorkspaceOpenRouterCustomModel(workspaceId: string, request: CreateWorkspaceOpenRouterCustomModelRequest): Promise<WorkspaceOpenRouterCustomModel>;
|
|
776
|
+
/** Remove one workspace custom OpenRouter model by its stable row id. */
|
|
777
|
+
deleteWorkspaceOpenRouterCustomModel(workspaceId: string, customModelId: string, request: DeleteWorkspaceOpenRouterCustomModelRequest): Promise<void>;
|
|
778
|
+
/** Read metadata for one organization-owned model-provider connection. */
|
|
779
|
+
getWorkspaceClaudeSubscriptionUsage(workspaceId: string): Promise<ClaudeSubscriptionUsage>;
|
|
780
|
+
listClaudeSubscriptionAccounts(workspaceId: string): Promise<ClaudeSubscriptionAccountsResponse>;
|
|
781
|
+
activateClaudeSubscriptionAccount(workspaceId: string, accountId: string): Promise<{
|
|
782
|
+
activated: boolean;
|
|
783
|
+
accountId: string;
|
|
784
|
+
}>;
|
|
785
|
+
setClaudeSubscriptionRotationSettings(workspaceId: string, request: {
|
|
786
|
+
rotationEnabled: boolean;
|
|
787
|
+
}): Promise<SubscriptionPoolSettings>;
|
|
788
|
+
setClaudeSubscriptionAccountAllocator(workspaceId: string, accountId: string, request: {
|
|
789
|
+
enabled: boolean;
|
|
790
|
+
expectedVersion: number;
|
|
791
|
+
}): Promise<unknown>;
|
|
792
|
+
renameClaudeSubscriptionAccount(workspaceId: string, accountId: string, label: string | null): Promise<ClaudeSubscriptionAccount>;
|
|
793
|
+
disconnectClaudeSubscriptionAccount(workspaceId: string, accountId: string): Promise<unknown>;
|
|
794
|
+
getClaudeSubscriptionAccountUsage(workspaceId: string, accountId: string): Promise<ClaudeSubscriptionUsage>;
|
|
795
|
+
refreshClaudeSubscriptionAccountUsage(workspaceId: string, accountId: string): Promise<ClaudeSubscriptionUsage>;
|
|
796
|
+
listOrganizationClaudeSubscriptionAccounts(organizationId: string): Promise<ClaudeSubscriptionAccountsResponse>;
|
|
797
|
+
activateOrganizationClaudeSubscriptionAccount(organizationId: string, accountId: string): Promise<{
|
|
798
|
+
updated: boolean;
|
|
799
|
+
}>;
|
|
800
|
+
setOrganizationClaudeSubscriptionRotationSettings(organizationId: string, request: {
|
|
801
|
+
rotationEnabled: boolean;
|
|
802
|
+
}): Promise<SubscriptionPoolSettings>;
|
|
803
|
+
setOrganizationClaudeSubscriptionAccountAllocator(organizationId: string, accountId: string, request: {
|
|
804
|
+
enabled: boolean;
|
|
805
|
+
expectedVersion: number;
|
|
806
|
+
}): Promise<unknown>;
|
|
807
|
+
renameOrganizationClaudeSubscriptionAccount(organizationId: string, accountId: string, label: string | null): Promise<{
|
|
808
|
+
updated: boolean;
|
|
809
|
+
}>;
|
|
810
|
+
disconnectOrganizationClaudeSubscriptionAccount(organizationId: string, accountId: string): Promise<unknown>;
|
|
811
|
+
getOrganizationClaudeSubscriptionAccountUsage(organizationId: string, accountId: string): Promise<ClaudeSubscriptionUsage>;
|
|
812
|
+
refreshOrganizationClaudeSubscriptionAccountUsage(organizationId: string, accountId: string): Promise<ClaudeSubscriptionUsage>;
|
|
813
|
+
connectClaudeSubscriptionSetupToken(workspaceId: string, request: Omit<ClaudeSubscriptionSetupTokenRequest, "scope"> & {
|
|
814
|
+
scope?: "workspace" | "user";
|
|
815
|
+
}): Promise<ClaudeSubscriptionOAuthCompleteResponse>;
|
|
816
|
+
connectOrganizationClaudeSubscriptionSetupToken(organizationId: string, request: Omit<ClaudeSubscriptionSetupTokenRequest, "scope">): Promise<ClaudeSubscriptionOAuthCompleteResponse>;
|
|
817
|
+
/** Sign in with model and profile access; no inference request is made. */
|
|
818
|
+
startWorkspaceClaudeSubscriptionOAuth(workspaceId: string, request?: Partial<ClaudeSubscriptionOAuthStartRequest>): Promise<ClaudeSubscriptionOAuthStartResponse>;
|
|
819
|
+
completeWorkspaceClaudeSubscriptionOAuth(workspaceId: string, request: ClaudeSubscriptionOAuthCompleteRequest): Promise<ClaudeSubscriptionOAuthCompleteResponse>;
|
|
820
|
+
startOrganizationClaudeSubscriptionOAuth(organizationId: string, request?: Pick<ClaudeSubscriptionOAuthStartRequest, "reconnectAccountId">): Promise<ClaudeSubscriptionOAuthStartResponse>;
|
|
821
|
+
completeOrganizationClaudeSubscriptionOAuth(organizationId: string, request: ClaudeSubscriptionOAuthCompleteRequest): Promise<ClaudeSubscriptionOAuthCompleteResponse>;
|
|
822
|
+
refreshWorkspaceClaudeSubscriptionUsage(workspaceId: string): Promise<ClaudeSubscriptionUsage>;
|
|
823
|
+
getOrganizationClaudeSubscriptionUsage(organizationId: string): Promise<ClaudeSubscriptionUsage>;
|
|
824
|
+
refreshOrganizationClaudeSubscriptionUsage(organizationId: string): Promise<ClaudeSubscriptionUsage>;
|
|
825
|
+
/** Read metadata for one organization-owned model-provider connection. */
|
|
826
|
+
getOrganizationModelProviderConnection(organizationId: string, providerKind: OrganizationModelProviderKind): Promise<OrganizationModelProviderConnection | null>;
|
|
827
|
+
/** Connect or rotate one organization-owned provider credential. */
|
|
828
|
+
upsertOrganizationModelProviderConnection(organizationId: string, providerKind: OrganizationModelProviderKind, request: UpsertOrganizationModelProviderConnectionRequest): Promise<OrganizationModelProviderConnection>;
|
|
829
|
+
/** Revoke one organization-owned provider credential. */
|
|
830
|
+
revokeOrganizationModelProviderConnection(organizationId: string, providerKind: OrganizationModelProviderKind, request: RevokeOrganizationModelProviderConnectionRequest): Promise<OrganizationModelProviderConnection>;
|
|
831
|
+
/** List workspace-owned Claude model slugs. */
|
|
832
|
+
listWorkspaceClaudeCustomModels(workspaceId: string, providerKind: "anthropic" | "claude_subscription"): Promise<WorkspaceGatewayCustomModelsResponse>;
|
|
833
|
+
/** Add an immutable workspace-owned Claude model generation. */
|
|
834
|
+
createWorkspaceClaudeCustomModel(workspaceId: string, providerKind: "anthropic" | "claude_subscription", request: CreateWorkspaceGatewayCustomModelRequest): Promise<WorkspaceGatewayCustomModel>;
|
|
835
|
+
/** Retire a workspace-owned Claude model generation. */
|
|
836
|
+
deleteWorkspaceClaudeCustomModel(workspaceId: string, providerKind: "anthropic" | "claude_subscription", customModelId: string, request: DeleteWorkspaceGatewayCustomModelRequest): Promise<void>;
|
|
837
|
+
/** List organization-owned exact upstream model slugs. */
|
|
838
|
+
listOrganizationProviderCustomModels(organizationId: string, providerKind: OrganizationModelProviderKind): Promise<OrganizationProviderCustomModelsResponse>;
|
|
839
|
+
/** Add one organization-owned exact upstream model slug. */
|
|
840
|
+
createOrganizationProviderCustomModel(organizationId: string, providerKind: OrganizationModelProviderKind, request: CreateOrganizationProviderCustomModelRequest): Promise<OrganizationProviderCustomModel>;
|
|
841
|
+
/** Retire one organization-owned custom model. */
|
|
842
|
+
deleteOrganizationProviderCustomModel(organizationId: string, providerKind: OrganizationModelProviderKind, customModelId: string, request: DeleteOrganizationProviderCustomModelRequest): Promise<OrganizationProviderCustomModel>;
|
|
843
|
+
/** Read the workspace's hard provider/model allowlist. */
|
|
844
|
+
getWorkspaceModelAccessPolicy(workspaceId: string): Promise<WorkspaceModelAccessPolicy>;
|
|
845
|
+
/** Fully replace the workspace's hard provider/model allowlist. */
|
|
846
|
+
updateWorkspaceModelAccessPolicy(workspaceId: string, request: UpdateWorkspaceModelAccessPolicyRequest): Promise<WorkspaceModelAccessPolicy>;
|
|
486
847
|
/** Authenticated realtime voice models and credential readiness. */
|
|
487
|
-
getWorkspaceRealtimeModelCatalog(workspaceId: string): Promise<WorkspaceRealtimeModelCatalogResponse>;
|
|
488
|
-
/**
|
|
848
|
+
getWorkspaceRealtimeModelCatalog(workspaceId: string, options?: OpenGeniRequestOptions): Promise<WorkspaceRealtimeModelCatalogResponse>;
|
|
849
|
+
/**
|
|
850
|
+
* The caller's subject, grants, defaults, and optional direct API-key authority.
|
|
851
|
+
* `credential.effectiveWorkspacePermissions` expands workspace admin only for
|
|
852
|
+
* legacy keys; explicit policies retain exactly their selected grants. Full
|
|
853
|
+
* organization keys can provision shared workspaces, external members, and
|
|
854
|
+
* `asUser` sessions; user requests additionally need live membership.
|
|
855
|
+
* Organization-key scope excludes Personal workspaces. Neither key kind bypasses
|
|
856
|
+
* session visibility or the explicit `secrets:read` permission requirement. Credential
|
|
857
|
+
* metadata is omitted for `asUser`/external actors, humans, delegated tokens,
|
|
858
|
+
* other caller contexts, and older servers.
|
|
859
|
+
*/
|
|
489
860
|
getAccessContext(): Promise<AccessContext>;
|
|
861
|
+
/** Active organization memberships proven by the current managed-human session. */
|
|
862
|
+
listOrganizationMemberships(): Promise<ListManagedOrganizationMembershipsResponse>;
|
|
863
|
+
/** Bounded owner-only personal-resource authority page for one exact resource kind. */
|
|
864
|
+
listUserResourceAuthorities(workspaceId: string, options: ListUserResourceAuthoritiesOptions): Promise<ListUserResourceAuthoritiesResponse>;
|
|
865
|
+
/** Revoke an owner grant through the exact workspace it targets. */
|
|
866
|
+
revokeUserResourceGrant(workspaceId: string, grantId: string): Promise<RevokeUserResourceGrantResponse>;
|
|
867
|
+
/** Create a new organization owned by the current managed human. */
|
|
868
|
+
createOrganization(request: CreateOrganizationRequest): Promise<CreateOrganizationResponse>;
|
|
869
|
+
/** Create another organization owned by the current managed human. */
|
|
870
|
+
createAdditionalOrganization(request: CreateAdditionalOrganizationRequest): Promise<CreateAdditionalOrganizationResponse>;
|
|
871
|
+
/** Pending and historical invitations addressed to the current managed human. */
|
|
872
|
+
listOrganizationInvitations(options?: {
|
|
873
|
+
cursor?: string;
|
|
874
|
+
limit?: number;
|
|
875
|
+
}): Promise<ListOrganizationInvitationsPageResponse>;
|
|
876
|
+
/** Admin-only deterministic page of invitations for one organization. */
|
|
877
|
+
listOrganizationInvitationsForOrganization(organizationId: string, options?: {
|
|
878
|
+
cursor?: string;
|
|
879
|
+
limit?: number;
|
|
880
|
+
}): Promise<ListOrganizationInvitationsPageResponse>;
|
|
881
|
+
createOrganizationInvitation(organizationId: string, request: CreateOrganizationInvitationRequest): Promise<OrganizationInvitation>;
|
|
882
|
+
acceptOrganizationInvitation(invitationId: string, request: AcceptOrganizationInvitationRequest): Promise<AcceptOrganizationInvitationResponse>;
|
|
883
|
+
revokeOrganizationInvitation(organizationId: string, invitationId: string, request: RevokeOrganizationInvitationRequest): Promise<OrganizationInvitation>;
|
|
884
|
+
listOrganizationAdministrationMembers(organizationId: string): Promise<ListOrganizationAdministrationMembersResponse>;
|
|
885
|
+
/** @deprecated Use listOrganizationAdministrationMembers for its privacy-safe projection. */
|
|
886
|
+
listOrganizationMembers(organizationId: string): Promise<ListOrganizationAdministrationMembersResponse>;
|
|
887
|
+
/** Canonical organization identity and every non-personal workspace access roster. */
|
|
888
|
+
getOrganizationAdministrationOverview(organizationId: string): Promise<OrganizationAdministrationOverview>;
|
|
889
|
+
/** Create a shared workspace and grant its creator explicit workspace-admin access. */
|
|
890
|
+
createOrganizationWorkspace(organizationId: string, request: CreateOrganizationWorkspaceRequest): Promise<OrganizationWorkspaceAccess>;
|
|
891
|
+
/** Rename one shared workspace under an exact optimistic-concurrency fence. */
|
|
892
|
+
updateOrganizationWorkspace(organizationId: string, workspaceId: string, request: UpdateOrganizationWorkspaceRequest): Promise<OrganizationWorkspaceAccess>;
|
|
893
|
+
updateOrganizationWorkspaceSettings(organizationId: string, workspaceId: string, request: UpdateWorkspaceSettingsRequest): Promise<Workspace>;
|
|
894
|
+
/**
|
|
895
|
+
* Delete an organization (shared) workspace. Accepts an organization owner
|
|
896
|
+
* session or an organization API key with `workspace:admin` (for tenant
|
|
897
|
+
* offboarding); never deletes a Personal workspace. 409 until quiescent.
|
|
898
|
+
*/
|
|
899
|
+
deleteOrganizationWorkspace(organizationId: string, workspaceId: string): Promise<void>;
|
|
900
|
+
putOrganizationWorkspaceMember(organizationId: string, workspaceId: string, membershipId: string, request: PutOrganizationWorkspaceMemberRequest): Promise<OrganizationWorkspaceAccessMember>;
|
|
901
|
+
revokeOrganizationWorkspaceMember(organizationId: string, workspaceId: string, membershipId: string, request: RevokeOrganizationWorkspaceMemberRequest): Promise<RevokeOrganizationWorkspaceMemberResponse>;
|
|
902
|
+
/** Rename the organization under an exact optimistic-concurrency fence. */
|
|
903
|
+
updateOrganizationName(organizationId: string, request: UpdateOrganizationNameRequest): Promise<OrganizationSummary>;
|
|
904
|
+
updateOrganizationMember(organizationId: string, membershipId: string, request: UpdateOrganizationMemberRequest): Promise<OrganizationMember>;
|
|
905
|
+
getOrganizationRetentionPolicy(organizationId: string): Promise<OrganizationRetentionPolicy>;
|
|
906
|
+
updateOrganizationRetentionPolicy(organizationId: string, request: UpdateOrganizationRetentionPolicyRequest): Promise<OrganizationRetentionPolicy>;
|
|
907
|
+
getOrganizationRecovery(organizationId: string): Promise<OrganizationRecoveryOverview>;
|
|
908
|
+
configureOrganizationRecoveryPolicy(organizationId: string, request: ConfigureOrganizationRecoveryPolicyRequest): Promise<OrganizationRecoveryMutationResponse>;
|
|
909
|
+
acceptOrganizationRecoveryCustody(organizationId: string, request: AcceptOrganizationRecoveryCustodyRequest): Promise<OrganizationRecoveryMutationResponse>;
|
|
910
|
+
disableOrganizationRecoveryPolicy(organizationId: string, request: DisableOrganizationRecoveryPolicyRequest): Promise<OrganizationRecoveryMutationResponse>;
|
|
911
|
+
startOrganizationRecoveryOperation(organizationId: string, request: StartOrganizationRecoveryOperationRequest): Promise<OrganizationRecoveryMutationResponse>;
|
|
912
|
+
approveOrganizationRecoveryOperation(organizationId: string, recoveryOperationId: string, request: OrganizationRecoveryOperationCommandRequest): Promise<OrganizationRecoveryMutationResponse>;
|
|
913
|
+
cancelOrganizationRecoveryOperation(organizationId: string, recoveryOperationId: string, request: OrganizationRecoveryOperationCommandRequest): Promise<OrganizationRecoveryMutationResponse>;
|
|
914
|
+
executeOrganizationRecoveryOperation(organizationId: string, recoveryOperationId: string, request: OrganizationRecoveryOperationCommandRequest): Promise<OrganizationRecoveryMutationResponse>;
|
|
915
|
+
searchPublicSkills(workspaceId: string, query: string): Promise<{
|
|
916
|
+
provider: "skills_sh";
|
|
917
|
+
query: string;
|
|
918
|
+
items: Array<{
|
|
919
|
+
id: string;
|
|
920
|
+
name: string;
|
|
921
|
+
source: string;
|
|
922
|
+
skillId: string;
|
|
923
|
+
url: string;
|
|
924
|
+
installs: number;
|
|
925
|
+
}>;
|
|
926
|
+
nextCursor: null;
|
|
927
|
+
}>;
|
|
490
928
|
listWorkspaces(): Promise<Workspace[]>;
|
|
929
|
+
/** Uses this client's fixed actor and standard contract/error/abort handling.
|
|
930
|
+
* Disconnect revokes OpenGeni connection access, not upstream provider consent. */
|
|
931
|
+
connectTransport(): import("@opengeni/connect").ConnectTransport;
|
|
932
|
+
/** Browse first-party Atlassian sources without choosing or starting sync. */
|
|
933
|
+
browseAtlassianSources(workspaceId: string, connectionId: string): Promise<import("@opengeni/contracts/atlassian").AtlassianBrowseResponse>;
|
|
934
|
+
saveAtlassianSources(workspaceId: string, connectionId: string, request: import("@opengeni/contracts/atlassian").SaveAtlassianSourcesRequest): Promise<import("./types.js").ConnectionResponse>;
|
|
935
|
+
setAtlassianLifecycle(workspaceId: string, connectionId: string, request: import("@opengeni/contracts/atlassian").AtlassianLifecycleActionRequest): Promise<import("./types.js").ConnectionResponse>;
|
|
936
|
+
/** Begin durable setup. Completion requirements are provider-specific. */
|
|
937
|
+
beginConnect(workspaceId: string, request: {
|
|
938
|
+
providerId: string;
|
|
939
|
+
ownership: "personal" | "workspace";
|
|
940
|
+
returnUrl: string;
|
|
941
|
+
idempotencyKey: string;
|
|
942
|
+
reconnectAccountId?: string;
|
|
943
|
+
installationTarget?: import("@opengeni/contracts/connect").ConnectInstallationTarget;
|
|
944
|
+
}): Promise<import("@opengeni/contracts/connect").ConnectAttempt>;
|
|
491
945
|
createWorkspace(request: CreateWorkspaceRequest): Promise<Workspace>;
|
|
946
|
+
/**
|
|
947
|
+
* Create an organization workspace once for a stable external tenant
|
|
948
|
+
* identity, or return the existing workspace without overwriting it.
|
|
949
|
+
*/
|
|
950
|
+
ensureWorkspace(request: EnsureWorkspaceRequest): Promise<EnsureWorkspaceResponse>;
|
|
492
951
|
getWorkspace(workspaceId: string): Promise<Workspace>;
|
|
493
952
|
/** Read-time, secret-safe inventory of policy heads and visible workspace knowledge. */
|
|
494
953
|
getWorkspaceState(workspaceId: string, options?: WorkspaceStateGetOptions): Promise<WorkspaceStateResponse>;
|
|
@@ -497,8 +956,13 @@ export declare class OpenGeniClient {
|
|
|
497
956
|
updateWorkspace(workspaceId: string, request: UpdateWorkspaceRequest): Promise<Workspace>;
|
|
498
957
|
/** Inspect immutable instruction-policy history, active heads, and activation audit evidence. */
|
|
499
958
|
listWorkspaceInstructionPolicies(workspaceId: string, options?: WorkspaceInstructionPolicyListOptions): Promise<WorkspaceInstructionPolicyListResponse>;
|
|
959
|
+
/** Inspect the bounded, permission-filtered governed-learning timeline. */
|
|
960
|
+
getWorkspaceLearningHistory(workspaceId: string, options?: WorkspaceLearningHistoryOptions): Promise<WorkspaceLearningHistoryResponse>;
|
|
961
|
+
undoGovernedLearningActivation(workspaceId: string, activationReceiptId: string, request?: {
|
|
962
|
+
operationId?: string;
|
|
963
|
+
}): Promise<GovernedLearningActivationUndoReceipt>;
|
|
500
964
|
getWorkspaceInstructionPolicyRevision(workspaceId: string, revisionId: string): Promise<WorkspaceInstructionPolicyRevision>;
|
|
501
|
-
createWorkspaceInstructionPolicyDraft(workspaceId: string, request: CreateWorkspaceInstructionPolicyDraftRequest): Promise<WorkspaceInstructionPolicyRevision>;
|
|
965
|
+
createWorkspaceInstructionPolicyDraft(workspaceId: string, request: CreateWorkspaceInstructionPolicyDraftRequest, options?: OpenGeniRequestOptions): Promise<WorkspaceInstructionPolicyRevision>;
|
|
502
966
|
/** List the newest immutable onboarding proposals and their inactive policy drafts. */
|
|
503
967
|
listWorkspaceInstructionPolicyOnboardingProposals(workspaceId: string, options?: WorkspaceInstructionPolicyOnboardingProposalListOptions): Promise<WorkspaceInstructionPolicyOnboardingProposalListResponse>;
|
|
504
968
|
/** Create one draft-only proposal against an exact active-policy baseline. */
|
|
@@ -506,11 +970,13 @@ export declare class OpenGeniClient {
|
|
|
506
970
|
/** Import the stored legacy workspace override as an inactive charter draft. */
|
|
507
971
|
importLegacyWorkspaceInstructionPolicyDraft(workspaceId: string, request?: ImportLegacyWorkspaceInstructionPolicyDraftRequest): Promise<WorkspaceInstructionPolicyRevision>;
|
|
508
972
|
diffWorkspaceInstructionPolicyRevisions(workspaceId: string, request: WorkspaceInstructionPolicyDiffRequest): Promise<WorkspaceInstructionPolicyDiffResponse>;
|
|
509
|
-
activateWorkspaceInstructionPolicyRevision(workspaceId: string, revisionId: string, request: ActivateWorkspaceInstructionPolicyRequest): Promise<WorkspaceInstructionPolicyActivationResponse>;
|
|
973
|
+
activateWorkspaceInstructionPolicyRevision(workspaceId: string, revisionId: string, request: ActivateWorkspaceInstructionPolicyRequest, options?: OpenGeniRequestOptions): Promise<WorkspaceInstructionPolicyActivationResponse>;
|
|
510
974
|
rollbackWorkspaceInstructionPolicyRevision(workspaceId: string, request: RollbackWorkspaceInstructionPolicyRequest): Promise<WorkspaceInstructionPolicyActivationResponse>;
|
|
511
975
|
/** Read the current organization profile plus immutable revision and activation history. */
|
|
512
976
|
listCompanyProfile(workspaceId: string, options?: CompanyProfileListOptions): Promise<CompanyProfileListResponse>;
|
|
513
977
|
getCompanyProfileRevision(workspaceId: string, revisionId: string): Promise<CompanyProfileRevision>;
|
|
978
|
+
getCompanyProfileAgentPolicy(workspaceId: string): Promise<CompanyProfileAgentPolicy>;
|
|
979
|
+
updateCompanyProfileAgentPolicy(workspaceId: string, request: UpdateCompanyProfileAgentPolicyRequest): Promise<CompanyProfileAgentPolicy>;
|
|
514
980
|
updateCompanyProfile(workspaceId: string, request: UpdateCompanyProfileRequest): Promise<CompanyProfileMutationResponse>;
|
|
515
981
|
diffCompanyProfileRevisions(workspaceId: string, request: CompanyProfileDiffRequest): Promise<CompanyProfileDiffResponse>;
|
|
516
982
|
activateCompanyProfileRevision(workspaceId: string, revisionId: string, request: ActivateCompanyProfileRevisionRequest): Promise<CompanyProfileMutationResponse>;
|
|
@@ -533,9 +999,10 @@ export declare class OpenGeniClient {
|
|
|
533
999
|
deleteWorkspace(workspaceId: string): Promise<void>;
|
|
534
1000
|
/** The workspace's members (user + api_key subjects). */
|
|
535
1001
|
listWorkspaceMembers(workspaceId: string): Promise<WorkspaceMember[]>;
|
|
1002
|
+
/** Active organization members who can be added to this workspace. */
|
|
1003
|
+
listWorkspaceMemberCandidates(workspaceId: string): Promise<WorkspaceMemberCandidate[]>;
|
|
536
1004
|
/**
|
|
537
|
-
* Add
|
|
538
|
-
* exists (email invites for unknown users are deferred).
|
|
1005
|
+
* Add one active member selected from the workspace candidate inventory.
|
|
539
1006
|
*/
|
|
540
1007
|
addWorkspaceMember(workspaceId: string, request: AddWorkspaceMemberRequest): Promise<WorkspaceMember>;
|
|
541
1008
|
updateWorkspaceMember(workspaceId: string, subjectId: string, request: UpdateWorkspaceMemberRequest): Promise<WorkspaceMember>;
|
|
@@ -568,7 +1035,17 @@ export declare class OpenGeniClient {
|
|
|
568
1035
|
listScheduledTaskRuns(workspaceId: string, taskId: string, options?: {
|
|
569
1036
|
limit?: number;
|
|
570
1037
|
}): Promise<ScheduledTaskRun[]>;
|
|
1038
|
+
/**
|
|
1039
|
+
* Re-freeze a task's connectors, connector accounts and OpenGeni tool policy
|
|
1040
|
+
* with the signed-in caller's current authority. Pass the `executionDigest`
|
|
1041
|
+
* of the task whose `policyDrift` was reviewed; a changed task returns 409.
|
|
1042
|
+
*/
|
|
1043
|
+
refreshScheduledTaskAccess(workspaceId: string, taskId: string, request: RefreshScheduledTaskAccessRequest): Promise<ScheduledTask>;
|
|
1044
|
+
/** Schedules the caller can act on whose latest run could not use a connector. */
|
|
1045
|
+
listScheduledTaskAccessAttention(workspaceId: string): Promise<ScheduledTaskAccessAttention[]>;
|
|
571
1046
|
listVariableSets(workspaceId: string): Promise<VariableSet[]>;
|
|
1047
|
+
/** Resolve only caller-supplied attachment ids without enumerating the catalog. */
|
|
1048
|
+
resolveVariableSetAttachments(workspaceId: string, request: ResolveVariableSetAttachmentsRequest): Promise<ResolveVariableSetAttachmentsResponse>;
|
|
572
1049
|
createVariableSet(workspaceId: string, request: CreateVariableSetRequest): Promise<VariableSet>;
|
|
573
1050
|
getVariableSet(workspaceId: string, variableSetId: string): Promise<VariableSet>;
|
|
574
1051
|
getVariableSetVariable(workspaceId: string, variableSetId: string, name: string): Promise<VariableSetSecret>;
|
|
@@ -577,6 +1054,13 @@ export declare class OpenGeniClient {
|
|
|
577
1054
|
/** Create or rotate a variable. Generic reads never return its value. */
|
|
578
1055
|
setVariableSetVariable(workspaceId: string, variableSetId: string, name: string, value: string): Promise<VariableSetVariableMetadata>;
|
|
579
1056
|
deleteVariableSetVariable(workspaceId: string, variableSetId: string, name: string): Promise<void>;
|
|
1057
|
+
listChannels(workspaceId: string): Promise<Channel[]>;
|
|
1058
|
+
createChannel(workspaceId: string, request: CreateChannelRequest): Promise<Channel>;
|
|
1059
|
+
updateChannel(workspaceId: string, channelId: string, request: UpdateChannelRequest): Promise<Channel>;
|
|
1060
|
+
reorderChannels(workspaceId: string, request: ReorderChannelsRequest): Promise<Channel[]>;
|
|
1061
|
+
deleteChannel(workspaceId: string, channelId: string): Promise<void>;
|
|
1062
|
+
/** Re-file a session into a channel (null = back to the unfiled inbox). */
|
|
1063
|
+
updateSessionChannel(workspaceId: string, sessionId: string, request: UpdateSessionChannelRequest): Promise<Session>;
|
|
580
1064
|
listRigs(workspaceId: string): Promise<Rig[]>;
|
|
581
1065
|
createRig(workspaceId: string, request: CreateRigRequest): Promise<Rig>;
|
|
582
1066
|
getRig(workspaceId: string, rigId: string): Promise<Rig>;
|
|
@@ -634,7 +1118,10 @@ export declare class OpenGeniClient {
|
|
|
634
1118
|
* -> complete. Returns the ready `FileAsset`.
|
|
635
1119
|
*/
|
|
636
1120
|
uploadFile(workspaceId: string, input: UploadFileInput): Promise<FileAsset>;
|
|
637
|
-
|
|
1121
|
+
listFiles(workspaceId: string, options?: import("./types.js").FileListRequest): Promise<import("./types.js").FileListResponse>;
|
|
1122
|
+
getFile(workspaceId: string, fileId: string, options?: OpenGeniRequestOptions & {
|
|
1123
|
+
sessionId?: string | undefined;
|
|
1124
|
+
}): Promise<FileAsset>;
|
|
638
1125
|
/** Read provider-neutral retained evidence metadata; never returns a storage location. */
|
|
639
1126
|
getRetainedArtifact(workspaceId: string, artifactId: string): Promise<RetainedArtifactMetadata>;
|
|
640
1127
|
/**
|
|
@@ -644,16 +1131,18 @@ export declare class OpenGeniClient {
|
|
|
644
1131
|
getRetainedArtifactContent(workspaceId: string, artifactId: string, options?: RetainedArtifactContentOptions): Promise<RetainedArtifactContent>;
|
|
645
1132
|
getSessionRetainedArtifact(workspaceId: string, sessionId: string, artifactId: string): Promise<RetainedArtifactMetadata>;
|
|
646
1133
|
getSessionRetainedArtifactContent(workspaceId: string, sessionId: string, artifactId: string, options?: RetainedArtifactContentOptions): Promise<RetainedArtifactContent>;
|
|
647
|
-
/** Assemble one permanent
|
|
1134
|
+
/** Assemble one permanent image or file artifact from bounded authenticated ranges. */
|
|
648
1135
|
downloadRetainedArtifact(workspaceId: string, artifact: RetainedArtifactReference, options?: RetainedArtifactDownloadOptions): Promise<RetainedArtifactDownload>;
|
|
649
|
-
/** Mint a short-lived, zero-copy browser source for a validated
|
|
1136
|
+
/** Mint a short-lived, zero-copy browser source for a validated workspace artifact. */
|
|
650
1137
|
createRetainedArtifactDownloadUrl(workspaceId: string, artifact: RetainedArtifactReference, options?: OpenGeniRequestOptions): Promise<FileDownloadUrlResponse>;
|
|
651
1138
|
/** Assemble one retained screenshot from bounded authenticated API ranges. */
|
|
652
1139
|
downloadRetainedScreenshot(workspaceId: string, sessionId: string, artifactId: string, options?: RetainedScreenshotDownloadOptions): Promise<RetainedScreenshotDownload>;
|
|
653
1140
|
private downloadRetainedArtifactBytes;
|
|
654
1141
|
private getRetainedArtifactContentAtPath;
|
|
655
1142
|
/** Mint a short-lived signed download URL for a ready file. */
|
|
656
|
-
createFileDownloadUrl(workspaceId: string, fileId: string, options?: OpenGeniRequestOptions
|
|
1143
|
+
createFileDownloadUrl(workspaceId: string, fileId: string, options?: OpenGeniRequestOptions & {
|
|
1144
|
+
sessionId?: string | undefined;
|
|
1145
|
+
}): Promise<FileDownloadUrlResponse>;
|
|
657
1146
|
/** Read the effective workspace policy and executable Seedance capabilities. */
|
|
658
1147
|
getVideoGenerationSettings(workspaceId: string, options?: OpenGeniRequestOptions): Promise<WorkspaceVideoGenerationSettings>;
|
|
659
1148
|
/** Replace the enabled video models/default under optimistic policy revision control. */
|
|
@@ -663,11 +1152,12 @@ export declare class OpenGeniClient {
|
|
|
663
1152
|
/** Mint a short-lived zero-copy URL for native Range-based video playback. */
|
|
664
1153
|
createVideoArtifactPlaybackSource(workspaceId: string, artifactId: string, options?: OpenGeniRequestOptions): Promise<VideoArtifactPlaybackSource>;
|
|
665
1154
|
createDocumentBase(workspaceId: string, request: CreateDocumentBaseRequest): Promise<DocumentBase>;
|
|
666
|
-
listDocumentBases(workspaceId: string): Promise<DocumentBase[]>;
|
|
667
1155
|
getDocumentBase(workspaceId: string, baseId: string): Promise<DocumentBase>;
|
|
668
1156
|
/** Index an uploaded file into the base. The file must be `ready`. */
|
|
669
1157
|
addDocument(workspaceId: string, baseId: string, request: AddDocumentRequest): Promise<Document>;
|
|
670
1158
|
listDocuments(workspaceId: string, baseId: string): Promise<Document[]>;
|
|
1159
|
+
/** Read the immutable source file through the Document's effective authority. */
|
|
1160
|
+
getDocumentOriginalFile(workspaceId: string, documentId: string): Promise<FileAsset>;
|
|
671
1161
|
/**
|
|
672
1162
|
* Drop raw text or an already-uploaded file into the workspace's Default
|
|
673
1163
|
* base. When curation is enabled, it may name, summarize, categorize, and
|
|
@@ -680,58 +1170,100 @@ export declare class OpenGeniClient {
|
|
|
680
1170
|
* targetBaseId, applies the document's stored curation suggestion.
|
|
681
1171
|
*/
|
|
682
1172
|
moveDocument(workspaceId: string, documentId: string, request?: MoveDocumentRequest): Promise<Document>;
|
|
683
|
-
/** Retry indexing for a failed document. */
|
|
684
|
-
reindexDocument(workspaceId: string, baseId: string, documentId: string): Promise<Document>;
|
|
685
1173
|
/**
|
|
686
1174
|
* Delete a document from a base. Removes the document row and its indexed
|
|
687
1175
|
* chunks while leaving the uploaded file asset available for other uses.
|
|
688
1176
|
*/
|
|
689
1177
|
deleteDocument(workspaceId: string, baseId: string, documentId: string): Promise<void>;
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
/**
|
|
697
|
-
|
|
1178
|
+
/** Unified retained sources, findings and groups. Only published entries are returned by default. */
|
|
1179
|
+
listKnowledgeEntries(workspaceId: string, request?: KnowledgeEntryListRequest): Promise<KnowledgeEntryListResponse>;
|
|
1180
|
+
getKnowledgeEntry(workspaceId: string, entryId: string, options?: {
|
|
1181
|
+
revisionId?: string;
|
|
1182
|
+
view?: "published" | "needs_review" | "archived" | "rejected";
|
|
1183
|
+
}): Promise<KnowledgeEntryRecord>;
|
|
1184
|
+
/** Open the original file associated with an accessible retained source revision. */
|
|
1185
|
+
createKnowledgeFileDownloadUrl(workspaceId: string, entryId: string, revisionId?: string): Promise<KnowledgeOriginalFileDownload>;
|
|
1186
|
+
saveKnowledgeEntry(workspaceId: string, request: KnowledgeEntrySaveRequest): Promise<KnowledgeEntryWriteReceipt>;
|
|
1187
|
+
reviewKnowledgeEntry(workspaceId: string, request: KnowledgeEntryReviewRequest): Promise<KnowledgeEntryWriteReceipt>;
|
|
1188
|
+
listKnowledgeReviewBatches(workspaceId: string, options?: KnowledgeReviewBatchListRequest): Promise<KnowledgeReviewBatchListResponse>;
|
|
1189
|
+
/** Atomically review up to 100 selected entries, including their pending dependencies. */
|
|
1190
|
+
reviewKnowledgeEntries(workspaceId: string, request: KnowledgeEntryBatchReviewRequest): Promise<{
|
|
1191
|
+
receipts: KnowledgeEntryWriteReceipt[];
|
|
1192
|
+
}>;
|
|
1193
|
+
listKnowledgeEntryHistory(workspaceId: string, entryId: string, beforeRevision?: number): Promise<{
|
|
1194
|
+
entries: KnowledgeEntryListResponse["entries"];
|
|
1195
|
+
beforeRevision: number | null;
|
|
1196
|
+
}>;
|
|
1197
|
+
restoreKnowledgeEntry(workspaceId: string, request: KnowledgeEntryRestoreRequest): Promise<KnowledgeEntryWriteReceipt>;
|
|
1198
|
+
archiveKnowledgeEntry(workspaceId: string, entryId: string, request: {
|
|
1199
|
+
operationId: string;
|
|
1200
|
+
expectedVersion: number;
|
|
1201
|
+
}): Promise<KnowledgeEntryWriteReceipt>;
|
|
1202
|
+
getAgentLearningSettings(workspaceId: string, scope: "workspace" | "personal" | "context", source?: AgentLearningContext): Promise<AgentLearningSettingsRecord>;
|
|
1203
|
+
saveAgentLearningSettings(workspaceId: string, request: SaveAgentLearningSettingsRequest): Promise<AgentLearningSettingsRecord>;
|
|
1204
|
+
listAgentLearningOverrides(workspaceId: string, scope: "workspace" | "personal"): Promise<AgentLearningOverrideRecord[]>;
|
|
1205
|
+
reviewAgentInstruction(workspaceId: string, request: AgentInstructionReviewRequest): Promise<AgentInstructionReceipt>;
|
|
1206
|
+
listAgentInstructionReviews(workspaceId: string, cursor?: string): Promise<AgentInstructionReviewListResponse>;
|
|
698
1207
|
/** Deep-merge a settings patch into the workspace (preserves unknown keys). */
|
|
699
1208
|
updateWorkspaceSettings(workspaceId: string, request: UpdateWorkspaceSettingsRequest): Promise<Workspace>;
|
|
700
1209
|
setWorkspaceDefaultRig(workspaceId: string, request: SetWorkspaceDefaultRigRequest): Promise<Workspace>;
|
|
701
|
-
/** Built-in + registered packs, with the workspace's installations. */
|
|
702
|
-
listPacks(workspaceId: string): Promise<ListPacksResponse>;
|
|
703
|
-
/** Register (or replace) a workspace-scoped pack from a manifest. */
|
|
704
|
-
registerPack(workspaceId: string, manifest: RegisterCapabilityPackRequest): Promise<WorkspaceRegisteredPack>;
|
|
705
|
-
getPack(workspaceId: string, packId: string): Promise<GetPackResponse>;
|
|
706
|
-
enablePack(workspaceId: string, packId: string, request?: EnablePackRequest): Promise<PackInstallation>;
|
|
707
1210
|
/** Resolve pinned components, Variable Set, and Rig requirements before installation. */
|
|
708
|
-
previewPackInstallation(workspaceId: string, packId: string, request?: PreviewPackInstallationRequest): Promise<PackInstallationPreview>;
|
|
709
|
-
/** Install, update, or repair a Pack from an exact previewed manifest. */
|
|
710
|
-
installPack(workspaceId: string, packId: string, request: InstallPackRequest): Promise<PackInstallation>;
|
|
711
|
-
/** Preview which Pack-owned components will be retained by other owners. */
|
|
712
|
-
previewPackUninstall(workspaceId: string, packId: string): Promise<PackUninstallPreview>;
|
|
713
|
-
/** Safely release Pack ownership and disable only now-ownerless components. */
|
|
714
|
-
uninstallPack(workspaceId: string, packId: string, request: UninstallPackRequest): Promise<UninstallPackResult>;
|
|
715
|
-
/** Unregister a workspace-scoped pack (built-in packs cannot be deleted). */
|
|
716
|
-
deletePack(workspaceId: string, packId: string): Promise<void>;
|
|
717
|
-
listPackInstallations(workspaceId: string): Promise<PackInstallation[]>;
|
|
718
1211
|
listCapabilities(workspaceId: string): Promise<CapabilityCatalogResponse>;
|
|
719
1212
|
/** Add a manual capability catalog item (e.g. a remote MCP server). */
|
|
720
1213
|
createCapability(workspaceId: string, request: CreateCapabilityCatalogItemRequest): Promise<CapabilityCatalogItem>;
|
|
1214
|
+
getConnectorToolPermissions(workspaceId: string, capabilityId: string, options?: {
|
|
1215
|
+
signal?: AbortSignal;
|
|
1216
|
+
}): Promise<ConnectorToolPermissionsResponse>;
|
|
1217
|
+
updateConnectorToolPermissions(workspaceId: string, capabilityId: string, request: UpdateConnectorToolPermissionsRequest, options?: {
|
|
1218
|
+
signal?: AbortSignal;
|
|
1219
|
+
}): Promise<{
|
|
1220
|
+
saved: boolean;
|
|
1221
|
+
}>;
|
|
721
1222
|
enableCapability(workspaceId: string, capabilityId: string, request?: EnableCapabilityRequest): Promise<CapabilityInstallation>;
|
|
722
1223
|
disableCapability(workspaceId: string, capabilityId: string): Promise<CapabilityInstallation>;
|
|
1224
|
+
/** Read-only, permission-filtered workspace or session output discovery. */
|
|
1225
|
+
listArtifactCatalog(workspaceId: string, options?: ArtifactCatalogListOptions & {
|
|
1226
|
+
signal?: AbortSignal;
|
|
1227
|
+
}): Promise<ArtifactCatalogListResponse>;
|
|
1228
|
+
listWorkspaceArtifacts(workspaceId: string, options?: WorkspaceArtifactListOptions & {
|
|
1229
|
+
signal?: AbortSignal;
|
|
1230
|
+
}): Promise<WorkspaceArtifactListResponse>;
|
|
1231
|
+
getWorkspaceArtifact(workspaceId: string, artifactId: string, options?: {
|
|
1232
|
+
signal?: AbortSignal;
|
|
1233
|
+
}): Promise<WorkspaceArtifactDetailResponse>;
|
|
1234
|
+
/** Display-only HTML delivery: do not download the retained source bundle to render a Site. */
|
|
1235
|
+
getWorkspaceArtifactHtml(workspaceId: string, artifactId: string, options: {
|
|
1236
|
+
versionId: string;
|
|
1237
|
+
signal?: AbortSignal;
|
|
1238
|
+
}): Promise<string>;
|
|
1239
|
+
rollbackWorkspaceArtifact(workspaceId: string, artifactId: string, request: RollbackWorkspaceArtifactRequest, options?: {
|
|
1240
|
+
signal?: AbortSignal;
|
|
1241
|
+
}): Promise<WorkspaceArtifactMutationResponse>;
|
|
1242
|
+
setWorkspaceArtifactStatus(workspaceId: string, artifactId: string, request: SetWorkspaceArtifactStatusRequest, options?: {
|
|
1243
|
+
signal?: AbortSignal;
|
|
1244
|
+
}): Promise<WorkspaceArtifactMutationResponse>;
|
|
723
1245
|
/** Search the official MCP registry for installable capabilities. */
|
|
724
1246
|
discoverMcpCapabilities(workspaceId: string, options?: {
|
|
725
1247
|
query?: string;
|
|
726
1248
|
limit?: number;
|
|
727
1249
|
}): Promise<DiscoverMcpCapabilitiesResponse>;
|
|
1250
|
+
discoverPlugins(workspaceId: string, options?: {
|
|
1251
|
+
id?: string;
|
|
1252
|
+
query?: string;
|
|
1253
|
+
provider?: string;
|
|
1254
|
+
offset?: number;
|
|
1255
|
+
}): Promise<import("@opengeni/contracts").PluginDiscoveryPage>;
|
|
1256
|
+
inspectMcpAuthentication(workspaceId: string, url: string): Promise<{
|
|
1257
|
+
kind: "oauth2" | "none" | "unknown";
|
|
1258
|
+
message?: string;
|
|
1259
|
+
}>;
|
|
728
1260
|
/** List installed protocol-neutral OpenAPI and GraphQL Integrations. */
|
|
729
1261
|
listApiIntegrations(workspaceId: string): Promise<ListApiIntegrationsResponse>;
|
|
730
|
-
/** List curated provider
|
|
731
|
-
|
|
1262
|
+
/** List curated provider definitions without exposing deployment OAuth credentials. */
|
|
1263
|
+
listIntegrationDefinitions(workspaceId: string): Promise<ListIntegrationDefinitionsResponse>;
|
|
732
1264
|
/** Detect and compile an Integration without mutating workspace state. */
|
|
733
1265
|
previewApiIntegration(workspaceId: string, request: PreviewApiIntegrationRequest): Promise<ApiIntegrationPreview>;
|
|
734
|
-
/** Start a signed PKCE OAuth flow for a built-in Google or Microsoft
|
|
1266
|
+
/** Start a signed PKCE OAuth flow for a built-in Google or Microsoft definition. */
|
|
735
1267
|
startApiIntegrationOAuth(workspaceId: string, request: ApiIntegrationOAuthStartRequest): Promise<OAuthStartResponse>;
|
|
736
1268
|
/** Install only the exact immutable revision and digest accepted in preview. */
|
|
737
1269
|
installApiIntegration(workspaceId: string, request: InstallApiIntegrationRequest): Promise<InstalledApiIntegration>;
|
|
@@ -739,21 +1271,22 @@ export declare class OpenGeniClient {
|
|
|
739
1271
|
/** Remove one Integration instance without deleting its Connection or sibling instances. */
|
|
740
1272
|
uninstallApiIntegration(workspaceId: string, capabilityId: string, instanceKey: string, request: UninstallApiIntegrationRequest): Promise<UninstallApiIntegrationResult>;
|
|
741
1273
|
/** List immutable provider facets and their exact per-account bindings. */
|
|
742
|
-
|
|
743
|
-
/** Configure or OCC-update one adapter-owned
|
|
744
|
-
|
|
1274
|
+
listIntegrationFacets(workspaceId: string, capabilityId: string, instanceKey: string): Promise<IntegrationInstanceFacetsResponse>;
|
|
1275
|
+
/** Configure or OCC-update one adapter-owned facet on an Integration instance. */
|
|
1276
|
+
configureIntegrationFacet(workspaceId: string, capabilityId: string, instanceKey: string, facetKey: string, request: UpsertIntegrationFacetRequest): Promise<IntegrationFacetMutationResult>;
|
|
745
1277
|
/** Browse source metadata through one exact Google Drive Integration instance. */
|
|
746
|
-
|
|
1278
|
+
browseGoogleDriveFacetSource(workspaceId: string, capabilityId: string, instanceKey: string, facetKey: string, options?: {
|
|
747
1279
|
parentId?: string | undefined;
|
|
748
1280
|
pageToken?: string | undefined;
|
|
749
1281
|
}): Promise<GoogleDriveBrowseResponse>;
|
|
750
1282
|
/** Verify and bind document sources to one exact Google Drive Integration instance. */
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
private
|
|
1283
|
+
saveGoogleDriveFacetSource(workspaceId: string, capabilityId: string, instanceKey: string, facetKey: string, request: SaveGoogleDriveIntegrationSourceRequest): Promise<IntegrationFacetMutationResult>;
|
|
1284
|
+
pauseIntegrationFacet(workspaceId: string, capabilityId: string, instanceKey: string, facetKey: string, request: MutateIntegrationFacetRequest): Promise<IntegrationFacetMutationResult>;
|
|
1285
|
+
resumeIntegrationFacet(workspaceId: string, capabilityId: string, instanceKey: string, facetKey: string, request: MutateIntegrationFacetRequest): Promise<IntegrationFacetMutationResult>;
|
|
1286
|
+
removeIntegrationFacet(workspaceId: string, capabilityId: string, instanceKey: string, facetKey: string, request: MutateIntegrationFacetRequest): Promise<IntegrationFacetRemovalResult>;
|
|
1287
|
+
private mutateIntegrationFacetLifecycle;
|
|
756
1288
|
previewPlugin(workspaceId: string, request: PreviewPluginRequest): Promise<PluginPreview>;
|
|
1289
|
+
getInstalledPluginDetails(workspaceId: string, pluginKey: string): Promise<import("@opengeni/contracts").PluginDiscoveryItem>;
|
|
757
1290
|
listInstalledPlugins(workspaceId: string): Promise<ListInstalledPluginsResponse>;
|
|
758
1291
|
installPlugin(workspaceId: string, request: InstallPluginRequest): Promise<InstalledPlugin>;
|
|
759
1292
|
previewPluginUninstall(workspaceId: string, pluginKey: string): Promise<PluginUninstallPreview>;
|
|
@@ -762,16 +1295,64 @@ export declare class OpenGeniClient {
|
|
|
762
1295
|
previewSkillImport(workspaceId: string, request: PreviewSkillImportRequest): Promise<SkillImportPreview>;
|
|
763
1296
|
/** Install only the exact commit and full-content digest accepted during preview. */
|
|
764
1297
|
installSkill(workspaceId: string, request: InstallSkillRequest): Promise<InstalledSkill>;
|
|
1298
|
+
/** List Skills from the authoritative Plugin/Skill-Facet installation ledger. */
|
|
1299
|
+
listInstalledSkills(workspaceId: string): Promise<ListInstalledSkillsResponse>;
|
|
1300
|
+
/** Shared authored/installed catalog metadata. File bodies are read on demand. */
|
|
1301
|
+
listWorkspaceSkills(workspaceId: string, options?: {
|
|
1302
|
+
cursor?: string;
|
|
1303
|
+
limit?: number;
|
|
1304
|
+
sessionId?: string;
|
|
1305
|
+
}): Promise<{
|
|
1306
|
+
skills: SkillSummary[];
|
|
1307
|
+
nextCursor: string | null;
|
|
1308
|
+
}>;
|
|
1309
|
+
readWorkspaceSkill(workspaceId: string, skillId: string, revisionId?: string): Promise<SkillRecord>;
|
|
1310
|
+
saveWorkspaceSkill(workspaceId: string, request: SaveWorkspaceSkillRequest): Promise<SkillWriteReceipt>;
|
|
1311
|
+
/** Permanently remove a personal/workspace Skill and all its saved revisions. */
|
|
1312
|
+
removeWorkspaceSkill(workspaceId: string, skillId: string, request: RemoveWorkspaceSkillRequest): Promise<SkillWriteReceipt>;
|
|
1313
|
+
approveWorkspaceSkill(workspaceId: string, skillId: string, request: ApplyWorkspaceSkillRevisionRequest): Promise<SkillWriteReceipt>;
|
|
1314
|
+
restoreWorkspaceSkill(workspaceId: string, skillId: string, request: ApplyWorkspaceSkillRevisionRequest): Promise<SkillWriteReceipt>;
|
|
1315
|
+
rejectWorkspaceSkill(workspaceId: string, skillId: string, request: ApplyWorkspaceSkillRevisionRequest): Promise<SkillWriteReceipt>;
|
|
1316
|
+
/** Install one exact reviewed curated-library Skill through the Skill domain. */
|
|
1317
|
+
installLibrarySkill(workspaceId: string, libraryId: string, request: InstallLibrarySkillRequest): Promise<InstalledSkill>;
|
|
765
1318
|
previewSkillUninstall(workspaceId: string, capabilityId: string): Promise<SkillUninstallPreview>;
|
|
766
1319
|
/** Remove the direct owner under an optimistic installation-version fence. */
|
|
767
1320
|
uninstallSkill(workspaceId: string, capabilityId: string, request: UninstallSkillRequest): Promise<UninstallSkillResult>;
|
|
1321
|
+
/** This authenticated user's accounts across the organization, plus current-workspace shared accounts.
|
|
1322
|
+
* Inactive accounts are opt-in for settings display; execution pickers keep the active default. */
|
|
1323
|
+
listOwnConnectionAccounts(workspaceId: string, options?: {
|
|
1324
|
+
includeInactive?: boolean;
|
|
1325
|
+
}): Promise<ConnectionMetadata[]>;
|
|
768
1326
|
listConnections(workspaceId: string): Promise<ConnectionMetadata[]>;
|
|
1327
|
+
/** Secret-free status for the caller's exact personal GitHub connection. */
|
|
1328
|
+
personalGitHubStatus(workspaceId: string): Promise<PersonalGitHubConnectionStatusResponse>;
|
|
1329
|
+
/** Start the dedicated personal GitHub authorization-code + PKCE flow. */
|
|
1330
|
+
startPersonalGitHubOAuth(workspaceId: string, request?: Omit<PersonalGitHubOAuthStartRequest, "connectionId">): Promise<PersonalGitHubOAuthStartResponse>;
|
|
1331
|
+
/** Re-authorize one exact personal GitHub Connection generation in place. */
|
|
1332
|
+
reconnectPersonalGitHub(workspaceId: string, connectionId: string, request?: Omit<PersonalGitHubOAuthStartRequest, "connectionId">): Promise<PersonalGitHubOAuthStartResponse>;
|
|
1333
|
+
/** Revoke one exact generation through an idempotent owner-only disconnect. */
|
|
1334
|
+
disconnectPersonalGitHub(workspaceId: string, connectionId: string, request: PersonalGitHubDisconnectRequest): Promise<ConnectionMetadata>;
|
|
1335
|
+
/** Browse one bounded page of repositories visible to one exact owner connection. */
|
|
1336
|
+
listPersonalGitHubRepositories(workspaceId: string, connectionId: string, options?: ListPersonalGitHubRepositoriesOptions): Promise<ListPersonalGitHubRepositoriesResponse>;
|
|
1337
|
+
/** Atomically replace the exact owner connection's selected repository set. */
|
|
1338
|
+
replacePersonalGitHubRepositorySelections(workspaceId: string, connectionId: string, request: ReplacePersonalGitHubRepositorySelectionsRequest): Promise<PersonalGitHubRepositorySelectionState>;
|
|
1339
|
+
/** Revalidate every selected repository without accepting provider URLs from the caller. */
|
|
1340
|
+
verifyPersonalGitHubRepositorySelections(workspaceId: string, connectionId: string, request: VerifyPersonalGitHubRepositorySelectionsRequest): Promise<PersonalGitHubRepositorySelectionState>;
|
|
769
1341
|
/** List the secret-free Slack team -> OpenGeni tenant routing authority. */
|
|
770
1342
|
listSlackInstallationBindings(workspaceId: string): Promise<SlackInstallationBinding[]>;
|
|
771
1343
|
createConnection(workspaceId: string, request: CreateConnectionRequest): Promise<ConnectionMetadata>;
|
|
1344
|
+
/**
|
|
1345
|
+
* Verify a pasted Fiken personal API token and store it as the
|
|
1346
|
+
* workspace-shared Fiken connection (or rewrite an existing one in place).
|
|
1347
|
+
*/
|
|
1348
|
+
installFikenConnection(workspaceId: string, request: FikenInstallRequest): Promise<ConnectionMetadata>;
|
|
1349
|
+
/** Start the Fiken OAuth flow for the workspace-shared Fiken connection. */
|
|
1350
|
+
startFikenOAuth(workspaceId: string, request?: FikenOAuthStartRequest): Promise<FikenOAuthStartResponse>;
|
|
772
1351
|
/** Start the public Slack installation flow for the workspace-shared OpenGeni bot. */
|
|
773
1352
|
startOpenGeniSlackBotInstall(workspaceId: string, request?: OpenGeniSlackBotInstallRequest): Promise<OpenGeniSlackBotInstallStart>;
|
|
774
1353
|
listOpenGeniSlackReactionChannels(workspaceId: string, connectionId: string, cursor?: string): Promise<SlackReactionChannelListResponse>;
|
|
1354
|
+
listOpenGeniSlackChannelRoutes(workspaceId: string, connectionId: string): Promise<SlackChannelRouteListResponse>;
|
|
1355
|
+
updateOpenGeniSlackChannelRoutes(workspaceId: string, request: UpdateSlackChannelRoutesRequest): Promise<void>;
|
|
775
1356
|
updateConnection(workspaceId: string, connectionId: string, request: UpdateConnectionRequest): Promise<ConnectionMetadata>;
|
|
776
1357
|
deleteConnection(workspaceId: string, connectionId: string): Promise<ConnectionMetadata>;
|
|
777
1358
|
disconnectGoogleDriveConnection(workspaceId: string, connectionId: string, request: GoogleDriveDisconnectRequest): Promise<ConnectionMetadata>;
|
|
@@ -790,6 +1371,9 @@ export declare class OpenGeniClient {
|
|
|
790
1371
|
disconnectSocialConnection(workspaceId: string, connectionId: string): Promise<SocialConnection>;
|
|
791
1372
|
/** Public, immutably-cached URL for a catalog item's logo, or null when the item has none. */
|
|
792
1373
|
catalogAssetUrl(logoAssetPath: string | null): string | null;
|
|
1374
|
+
/** Read a passive catalog mark through this client's authenticated transport.
|
|
1375
|
+
* Useful when an embedding backend protects even public upstream assets. */
|
|
1376
|
+
downloadCatalogAsset(logoAssetPath: string, options?: OpenGeniRequestOptions): Promise<Blob>;
|
|
793
1377
|
/** GitHub App server configuration plus truthful workspace binding status. */
|
|
794
1378
|
getGitHubApp(workspaceId: string, options?: {
|
|
795
1379
|
returnPath?: string;
|
|
@@ -797,6 +1381,10 @@ export declare class OpenGeniClient {
|
|
|
797
1381
|
/** Build the GitHub owner-consent entry URL for fresh workspace-bound state. */
|
|
798
1382
|
githubConnectUrl(workspaceId: string, state: string): string;
|
|
799
1383
|
listGitHubRepositories(workspaceId: string): Promise<GitHubRepositoriesResponse>;
|
|
1384
|
+
/** Effective confirmation policy for each GitHub identity available to this caller. */
|
|
1385
|
+
getGitHubActionPolicies(workspaceId: string): Promise<GitHubActionPoliciesResponse>;
|
|
1386
|
+
/** Change one GitHub action group without broadening review or merge policy. */
|
|
1387
|
+
updateGitHubActionPolicy(workspaceId: string, request: UpdateGitHubActionPolicyRequest): Promise<GitHubActionPolicyActorState>;
|
|
800
1388
|
/** Re-sync the installation's repository list from GitHub. */
|
|
801
1389
|
syncGitHubRepositories(workspaceId: string): Promise<GitHubRepositoriesResponse>;
|
|
802
1390
|
/** Remove one workspace binding without uninstalling the GitHub App itself. */
|
|
@@ -808,9 +1396,69 @@ export declare class OpenGeniClient {
|
|
|
808
1396
|
createApiKey(workspaceId: string, request: CreateApiKeyRequest): Promise<CreateApiKeyResponse>;
|
|
809
1397
|
/** Revoke an API key. Returns the revoked key. */
|
|
810
1398
|
deleteApiKey(workspaceId: string, apiKeyId: string): Promise<ApiKey>;
|
|
1399
|
+
listOrganizationApiKeys(organizationId: string): Promise<ApiKey[]>;
|
|
1400
|
+
/** The returned `token` is shown once; only its prefix is stored. */
|
|
1401
|
+
createOrganizationApiKey(organizationId: string, request: CreateOrganizationApiKeyRequest): Promise<CreateApiKeyResponse>;
|
|
1402
|
+
/** Revoke an organization-scoped API key. Returns the revoked key. */
|
|
1403
|
+
deleteOrganizationApiKey(organizationId: string, apiKeyId: string): Promise<ApiKey>;
|
|
1404
|
+
/**
|
|
1405
|
+
* Agents people connected to the organization MCP server (`/v1/mcp`).
|
|
1406
|
+
* Everyone sees their own; owners and admins see everyone's. Browser only:
|
|
1407
|
+
* keys and agents are refused, so an agent can't widen its own access.
|
|
1408
|
+
*/
|
|
1409
|
+
listOrganizationMcpConnections(organizationId: string): Promise<OrganizationMcpConnectionList>;
|
|
1410
|
+
/** Change what a connected agent can do and where; its next request uses it. Only its person. */
|
|
1411
|
+
updateOrganizationMcpConnection(organizationId: string, connectionId: string, request: UpdateOrganizationMcpConnectionRequest): Promise<OrganizationMcpConnection>;
|
|
1412
|
+
/** Disconnect an agent: every token it holds is refused from now on. */
|
|
1413
|
+
deleteOrganizationMcpConnection(organizationId: string, connectionId: string): Promise<void>;
|
|
1414
|
+
/** Service accounts: organization identities with no person behind them. */
|
|
1415
|
+
listOrganizationServiceAccounts(organizationId: string): Promise<ListOrganizationServiceAccountsResponse>;
|
|
1416
|
+
getOrganizationServiceAccount(organizationId: string, serviceAccountId: string): Promise<OrganizationServiceAccount>;
|
|
1417
|
+
/** Create a service account; give it keys with `createOrganizationApiKey({ serviceAccountId })`. */
|
|
1418
|
+
createOrganizationServiceAccount(organizationId: string, request: CreateOrganizationServiceAccountRequest): Promise<OrganizationServiceAccount>;
|
|
1419
|
+
/** Rename it or change its role; making it a member narrows its keys at once. */
|
|
1420
|
+
updateOrganizationServiceAccount(organizationId: string, serviceAccountId: string, request: UpdateOrganizationServiceAccountRequest): Promise<OrganizationServiceAccount>;
|
|
1421
|
+
/** Delete a service account; every key it holds is revoked at once. */
|
|
1422
|
+
deleteOrganizationServiceAccount(organizationId: string, serviceAccountId: string): Promise<void>;
|
|
1423
|
+
/** The pending sign-in an agent started; read by the web app's sign-in page. */
|
|
1424
|
+
getMcpConnectionRequest(requestToken: string): Promise<McpConnectionRequest>;
|
|
1425
|
+
/** Allow or deny an agent's sign-in. Returns where to send the browser next. */
|
|
1426
|
+
answerMcpConnectionRequest(requestToken: string, decision: McpConnectionDecision): Promise<{
|
|
1427
|
+
redirectTo: string;
|
|
1428
|
+
}>;
|
|
1429
|
+
/**
|
|
1430
|
+
* One page of sessions across every shared workspace of the organization the
|
|
1431
|
+
* caller may read within its live workspace scope (an organization API key or
|
|
1432
|
+
* organization owner). Each row carries its `workspaceId`; read events,
|
|
1433
|
+
* history, and files through the ordinary workspace methods. Personal
|
|
1434
|
+
* workspaces are never included and private sessions stay invisible.
|
|
1435
|
+
*/
|
|
1436
|
+
listOrganizationSessions(organizationId: string, options?: ListOrganizationSessionsOptions): Promise<OrganizationSessionListResponse>;
|
|
1437
|
+
/**
|
|
1438
|
+
* Every session `listOrganizationSessions` would return, following
|
|
1439
|
+
* `nextCursor` page by page until the organization is exhausted. A page may
|
|
1440
|
+
* be shorter than `limit` while more pages remain, so callers must not treat
|
|
1441
|
+
* a short page as the end.
|
|
1442
|
+
*/
|
|
1443
|
+
iterateOrganizationSessions(organizationId: string, options?: Omit<ListOrganizationSessionsOptions, "cursor">): AsyncGenerator<Session, void, undefined>;
|
|
811
1444
|
getBilling(options?: {
|
|
812
1445
|
accountId?: string;
|
|
813
1446
|
}): Promise<BillingSummary>;
|
|
1447
|
+
getOrganizationUsageSummary(options: {
|
|
1448
|
+
accountId: string;
|
|
1449
|
+
period?: import("@opengeni/contracts").OrganizationUsagePeriod;
|
|
1450
|
+
}, requestOptions?: OpenGeniRequestOptions): Promise<import("@opengeni/contracts").OrganizationUsageSummary>;
|
|
1451
|
+
getOrganizationModelUsage(options: {
|
|
1452
|
+
accountId: string;
|
|
1453
|
+
period?: import("@opengeni/contracts").OrganizationUsagePeriod;
|
|
1454
|
+
afterWorkspaceId?: string;
|
|
1455
|
+
}, requestOptions?: OpenGeniRequestOptions): Promise<import("@opengeni/contracts/organization-model-usage").OrganizationModelUsage>;
|
|
1456
|
+
getOrganizationUsageWorkspacePage(options: {
|
|
1457
|
+
accountId: string;
|
|
1458
|
+
period?: import("@opengeni/contracts").OrganizationUsagePeriod;
|
|
1459
|
+
until: string;
|
|
1460
|
+
afterWorkspaceId?: string;
|
|
1461
|
+
}, requestOptions?: OpenGeniRequestOptions): Promise<import("@opengeni/contracts").OrganizationUsageWorkspacePage>;
|
|
814
1462
|
getBillingUsage(options?: {
|
|
815
1463
|
accountId?: string;
|
|
816
1464
|
workspaceId?: string;
|
|
@@ -819,12 +1467,39 @@ export declare class OpenGeniClient {
|
|
|
819
1467
|
range?: InsightsRange;
|
|
820
1468
|
provider?: string;
|
|
821
1469
|
model?: string;
|
|
1470
|
+
rootSessionId?: string;
|
|
1471
|
+
sessionId?: string;
|
|
1472
|
+
signal?: AbortSignal;
|
|
822
1473
|
}): Promise<WorkspaceInsightsResponse>;
|
|
823
1474
|
getBillingEntitlements(options?: {
|
|
824
1475
|
accountId?: string;
|
|
825
1476
|
}): Promise<BillingEntitlementsResponse>;
|
|
826
1477
|
/** Start a Stripe checkout for prepaid credits. */
|
|
827
1478
|
createBillingCheckout(request: CreateCheckoutRequest): Promise<CreateCheckoutResponse>;
|
|
1479
|
+
/**
|
|
1480
|
+
* Where one checkout stands, and whether its credits reached the balance.
|
|
1481
|
+
* Poll it after the customer returns from Stripe Checkout.
|
|
1482
|
+
*/
|
|
1483
|
+
getBillingCheckout(checkoutSessionId: string, options?: {
|
|
1484
|
+
accountId?: string;
|
|
1485
|
+
}): Promise<BillingCheckoutStatus>;
|
|
1486
|
+
/** Open Stripe's hosted portal for invoices and payment information. */
|
|
1487
|
+
createBillingPortalSession(request?: CreateBillingPortalRequest): Promise<CreateBillingPortalResponse>;
|
|
1488
|
+
/** The URL of an API path on this client's base (relative when the base is relative). */
|
|
1489
|
+
apiUrl(path: string): string;
|
|
1490
|
+
/**
|
|
1491
|
+
* A client of the same class that adds `headers` to every request, keeping
|
|
1492
|
+
* this client's base URL, fetch, credentials, and actor attribution. Used to
|
|
1493
|
+
* scope a surface (for example an artifact viewer) to one host context.
|
|
1494
|
+
*/
|
|
1495
|
+
withHeaders(headers: Readonly<Record<string, string>>): this;
|
|
1496
|
+
/**
|
|
1497
|
+
* Fetch an absolute URL under this client's base URL through its fetch and
|
|
1498
|
+
* headers. For transports the SDK builds itself (the editable-artifact live
|
|
1499
|
+
* transport), so host authentication stays in one place. A URL outside the
|
|
1500
|
+
* base is refused: credentials never leave the configured API.
|
|
1501
|
+
*/
|
|
1502
|
+
fetchApi(input: string | URL, init?: RequestInit): Promise<Response>;
|
|
828
1503
|
private headers;
|
|
829
1504
|
private url;
|
|
830
1505
|
/** Connection state + the codex models the workspace may select (empty until connected). */
|
|
@@ -849,6 +1524,8 @@ export declare class OpenGeniClient {
|
|
|
849
1524
|
}>;
|
|
850
1525
|
/** List every connected Codex account + the workspace active pointer + settings. */
|
|
851
1526
|
listCodexAccounts(workspaceId: string): Promise<CodexAccountsResponse>;
|
|
1527
|
+
/** Session-authorized retry choices plus the current accepted account. */
|
|
1528
|
+
listSessionCodexAccounts(workspaceId: string, sessionId: string): Promise<SessionCodexAccountsResponse>;
|
|
852
1529
|
/** Switch the workspace ACTIVE Codex account (the one unpinned sessions use). */
|
|
853
1530
|
activateCodexAccount(workspaceId: string, accountId: string): Promise<{
|
|
854
1531
|
activated: boolean;
|
|
@@ -876,14 +1553,73 @@ export declare class OpenGeniClient {
|
|
|
876
1553
|
}>;
|
|
877
1554
|
/** Rename a Codex account (label only in P1). */
|
|
878
1555
|
renameCodexAccount(workspaceId: string, accountId: string, label: string | null): Promise<CodexAccount>;
|
|
879
|
-
/** Pin
|
|
1556
|
+
/** Pin/unpin a Codex account. Overrides a capacity-blocked turn; otherwise applies next turn. */
|
|
880
1557
|
pinSessionCodexAccount(workspaceId: string, sessionId: string, target: string): Promise<{
|
|
881
1558
|
pinned: string;
|
|
1559
|
+
appliedTo?: "waiting_turn" | "next_turn";
|
|
1560
|
+
}>;
|
|
1561
|
+
/** Organization subscription management requires an administrator browser session. */
|
|
1562
|
+
getModelConnectionAccess(target: {
|
|
1563
|
+
scope: "organizations" | "workspaces";
|
|
1564
|
+
scopeId: string;
|
|
1565
|
+
kind: "codex" | "supergrok" | "vercel_gateway" | "openrouter" | "anthropic" | "claude_subscription";
|
|
1566
|
+
connectionId: string;
|
|
1567
|
+
}): Promise<ModelConnectionAccessResponse>;
|
|
1568
|
+
updateModelConnectionAccess(target: {
|
|
1569
|
+
scope: "organizations" | "workspaces";
|
|
1570
|
+
scopeId: string;
|
|
1571
|
+
kind: "codex" | "supergrok" | "vercel_gateway" | "openrouter" | "anthropic" | "claude_subscription";
|
|
1572
|
+
connectionId: string;
|
|
1573
|
+
}, policy: ModelConnectionAccessPolicy): Promise<ModelConnectionAccessPolicy>;
|
|
1574
|
+
listOrganizationSuperGrokAccounts(organizationId: string): Promise<SuperGrokAccountsResponse>;
|
|
1575
|
+
organizationSupergrokConnectStart(organizationId: string): Promise<SuperGrokConnectStart>;
|
|
1576
|
+
organizationSupergrokConnectPoll(organizationId: string, state: string): Promise<SuperGrokConnectPoll>;
|
|
1577
|
+
activateOrganizationSuperGrokAccount(organizationId: string, accountId: string): Promise<{
|
|
1578
|
+
updated: boolean;
|
|
1579
|
+
}>;
|
|
1580
|
+
setOrganizationSuperGrokRotationSettings(organizationId: string, patch: {
|
|
1581
|
+
rotationEnabled: boolean;
|
|
1582
|
+
}): Promise<SuperGrokRotationSettings>;
|
|
1583
|
+
setOrganizationSuperGrokAccountAllocator(organizationId: string, accountId: string, input: {
|
|
1584
|
+
enabled: boolean;
|
|
1585
|
+
expectedVersion: number;
|
|
1586
|
+
}): Promise<{
|
|
1587
|
+
updated: boolean;
|
|
882
1588
|
}>;
|
|
1589
|
+
renameOrganizationSuperGrokAccount(organizationId: string, accountId: string, label: string | null): Promise<{
|
|
1590
|
+
updated: boolean;
|
|
1591
|
+
}>;
|
|
1592
|
+
disconnectOrganizationSuperGrokAccount(organizationId: string, accountId: string): Promise<{
|
|
1593
|
+
disconnected: boolean;
|
|
1594
|
+
}>;
|
|
1595
|
+
supergrokStatus(workspaceId: string): Promise<SuperGrokConnectionStatus>;
|
|
1596
|
+
supergrokConnectStart(workspaceId: string, scope?: Exclude<SuperGrokAccountScope, "organization">): Promise<SuperGrokConnectStart>;
|
|
1597
|
+
supergrokConnectPoll(workspaceId: string, state: string): Promise<SuperGrokConnectPoll>;
|
|
1598
|
+
listSuperGrokAccounts(workspaceId: string): Promise<SuperGrokAccountsResponse>;
|
|
1599
|
+
activateSuperGrokAccount(workspaceId: string, accountId: string): Promise<{
|
|
1600
|
+
activated: boolean;
|
|
1601
|
+
accountId: string;
|
|
1602
|
+
}>;
|
|
1603
|
+
setSuperGrokRotationSettings(workspaceId: string, patch: {
|
|
1604
|
+
rotationEnabled: boolean;
|
|
1605
|
+
}): Promise<SuperGrokRotationSettings>;
|
|
1606
|
+
setSuperGrokAccountAllocator(workspaceId: string, accountId: string, input: {
|
|
1607
|
+
enabled: boolean;
|
|
1608
|
+
expectedVersion: number;
|
|
1609
|
+
}): Promise<SuperGrokAllocatorUpdate>;
|
|
1610
|
+
renameSuperGrokAccount(workspaceId: string, accountId: string, label: string | null): Promise<SuperGrokAccount>;
|
|
1611
|
+
disconnectSuperGrokAccount(workspaceId: string, accountId: string): Promise<{
|
|
1612
|
+
disconnected: boolean;
|
|
1613
|
+
newActiveId: string | null;
|
|
1614
|
+
}>;
|
|
1615
|
+
/** Contract-checked JSON transport shared by opt-in typed SDK clients. */
|
|
1616
|
+
private requestSessionCommand;
|
|
883
1617
|
/** Contract-checked JSON transport shared by opt-in typed SDK clients. */
|
|
884
1618
|
requestJson<T>(method: string, path: string, body?: unknown, query?: Record<string, string>, options?: OpenGeniRequestOptions): Promise<T>;
|
|
885
1619
|
/** Authenticated, contract-checked response for bounded streaming downloads. */
|
|
886
|
-
protected requestResponse(method: string, path: string, query?: Record<string, string>, options?: OpenGeniRequestOptions
|
|
887
|
-
|
|
888
|
-
|
|
1620
|
+
protected requestResponse(method: string, path: string, query?: Record<string, string>, options?: OpenGeniRequestOptions & {
|
|
1621
|
+
accept?: string;
|
|
1622
|
+
}): Promise<FetchResponse>;
|
|
1623
|
+
/** Contract-checked transport shared by opt-in typed SDK clients for 204 responses. */
|
|
1624
|
+
requestVoid(method: string, path: string, body?: unknown): Promise<void>;
|
|
889
1625
|
}
|