@agent-commons/sdk 0.4.0 → 0.6.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/dist/index.d.ts CHANGED
@@ -51,12 +51,34 @@ interface Agent {
51
51
  isLiaison?: boolean;
52
52
  externalUrl?: string;
53
53
  createdAt: string;
54
+ isDefault?: boolean;
55
+ isSystemManaged?: boolean;
56
+ copilotAccessMode?: "full" | "scoped" | "confirm" | null;
57
+ copilotScopes?: string[];
54
58
  runtimeType?: AgentRuntimeType;
55
59
  runtimeVersion?: string | null;
56
60
  runtimeStatus?: AgentRuntimeStatus;
57
61
  runtimeConfig?: AgentRuntimeConfig;
58
62
  runtimeCapabilities?: Record<string, boolean>;
59
63
  }
64
+ interface CopilotChange {
65
+ changeId: string;
66
+ agentId: string;
67
+ ownerUserId: string;
68
+ scope: string;
69
+ resourceType: string;
70
+ resourceId?: string | null;
71
+ action: "create" | "update" | "delete";
72
+ status: "pending" | "applied" | "rejected" | "reverted";
73
+ title: string;
74
+ description?: string | null;
75
+ before?: unknown;
76
+ after?: unknown;
77
+ diff?: unknown;
78
+ createdAt: string;
79
+ reviewedAt?: string | null;
80
+ appliedAt?: string | null;
81
+ }
60
82
  /** Agent computers are durable. Runtime pods may be replaced, but this identity persists. */
61
83
  type AgentComputerLifecycle = "persistent";
62
84
  type ComputerPersistence = AgentComputerLifecycle;
@@ -305,6 +327,22 @@ interface CreateAgentParams {
305
327
  runtimeVersion?: string;
306
328
  runtimeConfig?: AgentRuntimeConfig;
307
329
  }
330
+ interface GenerateImageParams {
331
+ prompt: string;
332
+ n?: number;
333
+ size?: "1024x1024" | "1024x1536" | "1536x1024" | "auto";
334
+ quality?: "low" | "medium" | "high" | "auto";
335
+ sessionId?: string;
336
+ /** Stable caller-provided identifier used to make capability billing idempotent. */
337
+ operationId?: string;
338
+ }
339
+ interface GeneratedImageAsset {
340
+ fileId: string;
341
+ name: string;
342
+ url?: string;
343
+ prompt: string;
344
+ model: string;
345
+ }
308
346
  interface Session {
309
347
  sessionId: string;
310
348
  agentId: string;
@@ -409,6 +447,11 @@ interface WorkflowNode {
409
447
  id: string;
410
448
  type: WorkflowNodeType | string;
411
449
  toolId?: string;
450
+ toolName?: string;
451
+ agentId?: string;
452
+ agentAvatar?: string;
453
+ workflowId?: string;
454
+ label?: string;
412
455
  position?: {
413
456
  x: number;
414
457
  y: number;
@@ -423,6 +466,9 @@ interface WorkflowEdge {
423
466
  sourceHandle?: string;
424
467
  targetHandle?: string;
425
468
  mapping?: Record<string, string>;
469
+ /** Runtime target types used for dynamic (`any`) values and safe coercion. */
470
+ targetTypes?: Record<string, string>;
471
+ mappingMode?: "exact" | "dynamic" | "coerce";
426
472
  }
427
473
  interface WorkflowExecution {
428
474
  executionId: string;
@@ -431,7 +477,11 @@ interface WorkflowExecution {
431
477
  startedAt?: string;
432
478
  completedAt?: string;
433
479
  outputData?: any;
480
+ /** Alias returned by the immediate execute/status REST response. */
481
+ result?: any;
434
482
  nodeResults?: Record<string, any>;
483
+ /** Alias returned by the immediate execute/status REST response. */
484
+ stepResults?: Record<string, any>;
435
485
  errorMessage?: string;
436
486
  currentNode?: string;
437
487
  /** Set when status is 'awaiting_approval' */
@@ -547,13 +597,16 @@ interface ToolKey {
547
597
  }
548
598
  interface CreateToolKeyParams {
549
599
  toolId?: string;
550
- ownerId: string;
551
- ownerType: "user" | "agent";
600
+ /** @deprecated Ownership is derived from the authenticated principal. */
601
+ ownerId?: string;
602
+ /** @deprecated Ownership is derived from the authenticated principal. */
603
+ ownerType?: "user" | "agent";
552
604
  keyName: string;
553
605
  value: string;
554
606
  displayName?: string;
555
607
  description?: string;
556
- keyType?: string;
608
+ keyType?: "api-key" | "bearer-token" | "oauth-token" | "secret";
609
+ expiresAt?: string;
557
610
  }
558
611
  interface ToolPermission {
559
612
  id: string;
@@ -679,6 +732,13 @@ interface McpPrompt {
679
732
  interface CommonsClientConfig {
680
733
  /** Defaults to the unified Commons API platform. */
681
734
  baseUrl?: string;
735
+ /** Commons Identity origin used for developer projects and project API keys. */
736
+ identityUrl?: string;
737
+ /**
738
+ * Commons account session or OAuth access token for Commons Identity.
739
+ * This is distinct from `apiKey`, which authenticates platform API calls.
740
+ */
741
+ identityToken?: string;
682
742
  apiKey?: string;
683
743
  initiator?: string;
684
744
  /** Fetch implementation — defaults to global fetch */
@@ -704,6 +764,19 @@ interface Skill {
704
764
  sourceUrl?: string | null;
705
765
  createdAt: string;
706
766
  updatedAt: string;
767
+ assignedAgents?: SkillAgentAssignment[];
768
+ }
769
+ interface SkillAgentAssignment {
770
+ assignmentId: string;
771
+ agentId: string;
772
+ agentName: string;
773
+ agentAvatar?: string | null;
774
+ isDefault: boolean;
775
+ isEnabled: boolean;
776
+ }
777
+ interface AgentSkill extends Skill {
778
+ assignmentId?: string | null;
779
+ assigned: boolean;
707
780
  }
708
781
  interface SkillIndex {
709
782
  skillId: string;
@@ -729,6 +802,71 @@ interface CreateSkillParams {
729
802
  source?: string;
730
803
  sourceUrl?: string;
731
804
  }
805
+ type CapabilityName = "web_search" | "computer" | "wallet";
806
+ interface CapabilityProviderDefinition {
807
+ id: string;
808
+ name: string;
809
+ credentialFields: string[];
810
+ endpoint?: boolean;
811
+ }
812
+ interface CapabilityProviderConfiguration {
813
+ id: string;
814
+ capability: CapabilityName;
815
+ provider: string;
816
+ displayName?: string | null;
817
+ endpointUrl?: string | null;
818
+ settings: Record<string, unknown>;
819
+ status: "active" | "disabled";
820
+ hasCredentials: boolean;
821
+ updatedAt: string;
822
+ }
823
+ interface CapabilityProviderInput {
824
+ provider: string;
825
+ displayName?: string;
826
+ endpointUrl?: string;
827
+ settings?: Record<string, unknown>;
828
+ credentials?: Record<string, string>;
829
+ status?: "active" | "disabled";
830
+ }
831
+ type UiPluginPermission = "theme.read" | "navigation";
832
+ interface UiPluginSurface {
833
+ type: "page" | "widget";
834
+ title?: string;
835
+ width?: number;
836
+ height?: number;
837
+ }
838
+ interface UiPlugin {
839
+ pluginId: string;
840
+ ownerUserId: string;
841
+ workspaceId?: string | null;
842
+ createdByAgentId?: string | null;
843
+ codeProjectId: string;
844
+ name: string;
845
+ slug: string;
846
+ description?: string | null;
847
+ version: string;
848
+ entryUrl: string;
849
+ manifest: {
850
+ schemaVersion: "1";
851
+ surfaces: UiPluginSurface[];
852
+ permissions: UiPluginPermission[];
853
+ };
854
+ status: "draft" | "active" | "disabled";
855
+ createdAt: string;
856
+ updatedAt: string;
857
+ }
858
+ interface CreateUiPluginParams {
859
+ name: string;
860
+ slug?: string;
861
+ description?: string;
862
+ version?: string;
863
+ codeProjectId: string;
864
+ manifest: {
865
+ schemaVersion?: "1";
866
+ surfaces: UiPluginSurface[];
867
+ permissions?: UiPluginPermission[];
868
+ };
869
+ }
732
870
  type MemoryType = "episodic" | "semantic" | "procedural";
733
871
  type MemorySourceType = "auto" | "manual";
734
872
  interface AgentMemory {
@@ -843,8 +981,39 @@ interface CreditBalance {
843
981
  principalId: string;
844
982
  workspaceId?: string | null;
845
983
  balance: number;
984
+ reserved: number;
985
+ available: number;
846
986
  currency: "credits";
847
987
  }
988
+ interface CreditCampaign {
989
+ campaignKey: string;
990
+ name: string;
991
+ description?: string | null;
992
+ rewardCredits: number;
993
+ triggerType: "once" | "daily" | "monthly" | "event";
994
+ sourcePlatform: CreditPlatform;
995
+ claimable: boolean;
996
+ claimed: boolean;
997
+ }
998
+ interface CreditTransfer {
999
+ transferId: string;
1000
+ senderPrincipalId: string;
1001
+ recipientPrincipalId: string;
1002
+ amount: number;
1003
+ message?: string | null;
1004
+ status: "completed" | "reversed";
1005
+ createdAt: string;
1006
+ }
1007
+ interface CreditSummary {
1008
+ balance: CreditBalance;
1009
+ month: {
1010
+ earned: number;
1011
+ spent: number;
1012
+ };
1013
+ recent: CreditLedgerEntry[];
1014
+ campaigns: CreditCampaign[];
1015
+ transfers: CreditTransfer[];
1016
+ }
848
1017
  interface CreditWriteParams {
849
1018
  principalId: string;
850
1019
  principalType?: "user" | "agent" | "service";
@@ -863,6 +1032,249 @@ interface CreditWriteParams {
863
1032
  usageEventId?: string;
864
1033
  metadata?: Record<string, unknown>;
865
1034
  }
1035
+ type PlanKey = "free" | "plus" | "pro" | "max";
1036
+ type ComputeProfile = "starter" | "standard" | "performance" | "gpu";
1037
+ type ModelTier = "frontier" | "standard" | "fast" | "local";
1038
+ interface PlanEntitlements {
1039
+ computerUse: boolean;
1040
+ allowedProfiles: ComputeProfile[];
1041
+ maxComputerAgents: number;
1042
+ maxConcurrentComputers: number;
1043
+ modelTiers: ModelTier[];
1044
+ maxConcurrentRuns: number;
1045
+ }
1046
+ interface BillingCatalog {
1047
+ creditsPerUsd: number;
1048
+ plans: Array<{
1049
+ key: PlanKey;
1050
+ name: string;
1051
+ priceUsd: number;
1052
+ monthlyCredits: number;
1053
+ entitlements: PlanEntitlements;
1054
+ }>;
1055
+ topups: Array<{
1056
+ key: string;
1057
+ name: string;
1058
+ credits: number;
1059
+ priceUsd: number;
1060
+ }>;
1061
+ }
1062
+ interface SubscriptionInfo {
1063
+ planKey: PlanKey;
1064
+ planName: string;
1065
+ monthlyCredits: number;
1066
+ entitlements: PlanEntitlements;
1067
+ status: string;
1068
+ currentPeriodEnd: string | null;
1069
+ cancelAtPeriodEnd: boolean;
1070
+ }
1071
+ interface FlagEvaluation {
1072
+ key: string;
1073
+ enabled: boolean;
1074
+ variant: string | null;
1075
+ payload?: unknown;
1076
+ }
1077
+ interface ActivityEvent {
1078
+ eventId?: string;
1079
+ actorId: string;
1080
+ actorType?: "user" | "agent" | "service" | string;
1081
+ eventType: string;
1082
+ resourceType?: string | null;
1083
+ resourceId?: string | null;
1084
+ metadata?: Record<string, unknown> | null;
1085
+ createdAt: string;
1086
+ }
1087
+ interface AgentLog {
1088
+ logId?: string;
1089
+ agentId: string;
1090
+ sessionId?: string | null;
1091
+ action?: string;
1092
+ message?: string | null;
1093
+ status?: "success" | "error" | "warning" | string;
1094
+ responseTime?: number | null;
1095
+ tools?: unknown[];
1096
+ timestamp: string;
1097
+ [key: string]: unknown;
1098
+ }
1099
+ interface FileArtifact {
1100
+ fileId: string;
1101
+ name?: string;
1102
+ originalName?: string;
1103
+ mimeType?: string;
1104
+ size?: number;
1105
+ storageProvider?: "s3" | "ipfs" | string;
1106
+ agentId?: string | null;
1107
+ sessionId?: string | null;
1108
+ ownerId?: string | null;
1109
+ workspaceId?: string | null;
1110
+ createdAt?: string;
1111
+ [key: string]: unknown;
1112
+ }
1113
+ interface FileContentDownload {
1114
+ itemId?: string;
1115
+ name?: string;
1116
+ mimeType?: string;
1117
+ url?: string;
1118
+ [key: string]: unknown;
1119
+ }
1120
+ interface FileContentArtifact {
1121
+ artifactId?: string;
1122
+ kind?: string;
1123
+ mimeType?: string;
1124
+ pageNumber?: number | null;
1125
+ width?: number | null;
1126
+ height?: number | null;
1127
+ url?: string;
1128
+ [key: string]: unknown;
1129
+ }
1130
+ interface FileContent {
1131
+ fileId?: string;
1132
+ name?: string;
1133
+ content?: string;
1134
+ mimeType?: string;
1135
+ kind?: string;
1136
+ status?: string;
1137
+ offset?: number;
1138
+ nextOffset?: number | null;
1139
+ totalChars?: number;
1140
+ truncated?: boolean;
1141
+ textPreview?: string | null;
1142
+ metadata?: Record<string, unknown>;
1143
+ download?: FileContentDownload;
1144
+ artifacts?: FileContentArtifact[];
1145
+ /** Convenience aliases returned alongside the structured fields. */
1146
+ imageUrls?: string[];
1147
+ downloadUrl?: string;
1148
+ [key: string]: unknown;
1149
+ }
1150
+ interface UploadFileInput {
1151
+ data: Blob;
1152
+ name?: string;
1153
+ }
1154
+ interface LibraryItem extends FileArtifact {
1155
+ itemId?: string;
1156
+ description?: string | null;
1157
+ isFavorite?: boolean;
1158
+ source?: string;
1159
+ grants?: LibraryGrant[];
1160
+ shareLinks?: LibraryShareLink[];
1161
+ }
1162
+ interface LibraryGrant {
1163
+ grantId: string;
1164
+ subjectType: "user" | "agent" | "workspace";
1165
+ subjectId: string;
1166
+ permission: "read" | "edit" | "manage";
1167
+ expiresAt?: string | null;
1168
+ [key: string]: unknown;
1169
+ }
1170
+ interface LibraryShareLink {
1171
+ shareId: string;
1172
+ token?: string;
1173
+ url?: string;
1174
+ expiresAt?: string | null;
1175
+ [key: string]: unknown;
1176
+ }
1177
+ interface Space {
1178
+ spaceId: string;
1179
+ name: string;
1180
+ description?: string | null;
1181
+ visibility?: string;
1182
+ createdBy?: string;
1183
+ createdByType?: "agent" | "human";
1184
+ createdAt?: string;
1185
+ updatedAt?: string;
1186
+ members?: SpaceMember[];
1187
+ [key: string]: unknown;
1188
+ }
1189
+ interface SpaceMember {
1190
+ memberId: string;
1191
+ memberType: "agent" | "human";
1192
+ role?: string;
1193
+ status?: string;
1194
+ permissions?: Record<string, unknown>;
1195
+ [key: string]: unknown;
1196
+ }
1197
+ interface SpaceMessage {
1198
+ messageId: string;
1199
+ spaceId: string;
1200
+ senderId: string;
1201
+ senderType: "agent" | "human";
1202
+ content: string;
1203
+ metadata?: Record<string, unknown>;
1204
+ createdAt?: string;
1205
+ updatedAt?: string;
1206
+ [key: string]: unknown;
1207
+ }
1208
+ interface CodeProjectFile {
1209
+ path: string;
1210
+ content: string;
1211
+ }
1212
+ interface CodeProject {
1213
+ projectId: string;
1214
+ agentId: string;
1215
+ name: string;
1216
+ description?: string | null;
1217
+ sessionId?: string | null;
1218
+ files?: CodeProjectFile[];
1219
+ previewSlug?: string | null;
1220
+ previewUrl?: string | null;
1221
+ createdAt?: string;
1222
+ updatedAt?: string;
1223
+ [key: string]: unknown;
1224
+ }
1225
+ interface Goal {
1226
+ goalId: string;
1227
+ status: "pending" | "started" | "completed" | "failed";
1228
+ progress: number;
1229
+ title?: string;
1230
+ description?: string;
1231
+ agentId?: string;
1232
+ [key: string]: unknown;
1233
+ }
1234
+ interface OAuthProvider {
1235
+ providerKey: string;
1236
+ displayName: string;
1237
+ isActive: boolean;
1238
+ scopes?: string[];
1239
+ scopeGroups?: Record<string, string[]>;
1240
+ [key: string]: unknown;
1241
+ }
1242
+ interface OAuthConnection {
1243
+ connectionId: string;
1244
+ providerKey: string;
1245
+ providerDisplayName?: string;
1246
+ providerUserId?: string | null;
1247
+ providerUserEmail?: string | null;
1248
+ providerUserName?: string | null;
1249
+ scopes: string[];
1250
+ status: string;
1251
+ canRefresh?: boolean;
1252
+ lastUsedAt?: string | null;
1253
+ accessTokenExpiresAt?: string | null;
1254
+ expiresAt?: string | null;
1255
+ metadata?: Record<string, unknown> | null;
1256
+ [key: string]: unknown;
1257
+ }
1258
+ interface BillingInvoice {
1259
+ id: string;
1260
+ status?: string | null;
1261
+ currency?: string;
1262
+ amountDue?: number;
1263
+ amountPaid?: number;
1264
+ created?: number | string;
1265
+ hostedInvoiceUrl?: string | null;
1266
+ invoicePdf?: string | null;
1267
+ [key: string]: unknown;
1268
+ }
1269
+ interface BillingPaymentMethod {
1270
+ id: string;
1271
+ type: string;
1272
+ brand?: string;
1273
+ last4?: string;
1274
+ expMonth?: number;
1275
+ expYear?: number;
1276
+ [key: string]: unknown;
1277
+ }
866
1278
  type WalletType = "eoa" | "erc4337" | "external";
867
1279
  interface AgentWallet {
868
1280
  id: string;
@@ -874,6 +1286,8 @@ interface AgentWallet {
874
1286
  label?: string | null;
875
1287
  isActive: boolean;
876
1288
  createdAt: string;
1289
+ provider?: string | null;
1290
+ providerWalletId?: string | null;
877
1291
  }
878
1292
  interface WalletBalance {
879
1293
  address: string;
@@ -908,15 +1322,70 @@ interface CreateApiKeyParams {
908
1322
  interface CreatedApiKey extends ApiKey {
909
1323
  key: string;
910
1324
  }
1325
+ type DeveloperProjectEnvironment = "production" | "development" | "staging";
1326
+ interface DeveloperProject {
1327
+ id: string;
1328
+ workspaceId: string;
1329
+ name: string;
1330
+ slug: string;
1331
+ environment: DeveloperProjectEnvironment;
1332
+ status: string;
1333
+ createdAt: string;
1334
+ }
1335
+ interface DeveloperApiKey {
1336
+ id: string;
1337
+ projectId: string;
1338
+ keyPrefix: string;
1339
+ name: string;
1340
+ scopes: string[];
1341
+ status: string;
1342
+ expiresAt?: string | null;
1343
+ lastUsedAt?: string | null;
1344
+ createdAt: string;
1345
+ }
1346
+ interface CreatedDeveloperApiKey extends DeveloperApiKey {
1347
+ /** Plaintext key — shown once at creation time. */
1348
+ key: string;
1349
+ }
1350
+ type WorkflowValueKind = "text" | "markdown" | "number" | "boolean" | "json" | "image" | "audio" | "video" | "file" | "link" | "email" | "calendar_event" | "tool_result";
1351
+ interface WorkflowValue {
1352
+ kind: WorkflowValueKind;
1353
+ /** Canonical string representation — always present. */
1354
+ text: string;
1355
+ data?: Record<string, any>;
1356
+ mime?: string;
1357
+ label?: string;
1358
+ meta?: Record<string, any>;
1359
+ }
1360
+ /** Optional hint a tool/node declares for how its output should be presented. */
1361
+ interface OutputPresentation {
1362
+ kind?: WorkflowValueKind;
1363
+ textPath?: string;
1364
+ fieldMap?: Record<string, string>;
1365
+ label?: string;
1366
+ }
911
1367
 
1368
+ interface CommonsRequestOptions {
1369
+ headers?: Record<string, string>;
1370
+ signal?: AbortSignal;
1371
+ }
912
1372
  declare class CommonsClient {
913
1373
  private readonly baseUrl;
1374
+ private readonly identityUrl;
1375
+ private readonly identityToken?;
914
1376
  private readonly apiKey?;
915
1377
  private readonly initiator?;
916
1378
  private readonly _fetch;
917
1379
  constructor(config: CommonsClientConfig);
918
1380
  private headers;
919
- private request;
1381
+ /**
1382
+ * Call an API route that is not yet represented by a resource namespace.
1383
+ * Most applications should use the typed helpers below.
1384
+ */
1385
+ request<T>(method: string, path: string, body?: unknown, options?: CommonsRequestOptions): Promise<T>;
1386
+ private errorPayload;
1387
+ private errorMessage;
1388
+ private identityRequest;
920
1389
  get models(): {
921
1390
  /** List all available LLM models from the registry */
922
1391
  list: () => Promise<{
@@ -937,6 +1406,13 @@ declare class CommonsClient {
937
1406
  update: (agentId: string, params: Partial<CreateAgentParams>) => Promise<{
938
1407
  data: Agent;
939
1408
  }>;
1409
+ /**
1410
+ * Generate durable image assets for this agent without routing a
1411
+ * deterministic image operation through an LLM tool-selection turn.
1412
+ */
1413
+ generateImage: (agentId: string, params: GenerateImageParams) => Promise<{
1414
+ data: GeneratedImageAsset[];
1415
+ }>;
940
1416
  getRuntime: (agentId: string) => Promise<{
941
1417
  data: AgentRuntime;
942
1418
  }>;
@@ -957,6 +1433,13 @@ declare class CommonsClient {
957
1433
  restartRuntime: (agentId: string) => Promise<{
958
1434
  data: AgentRuntime;
959
1435
  }>;
1436
+ manageRuntimeChannel: (agentId: string, channel: string, action: string, params?: {
1437
+ pairingCode?: string;
1438
+ target?: string;
1439
+ message?: string;
1440
+ }) => Promise<{
1441
+ data: unknown;
1442
+ }>;
960
1443
  /** List tools assigned to an agent. */
961
1444
  listTools: (agentId: string) => Promise<{
962
1445
  data: any[];
@@ -968,6 +1451,13 @@ declare class CommonsClient {
968
1451
  }) => Promise<{
969
1452
  data: any;
970
1453
  }>;
1454
+ /** Update an agent tool assignment. */
1455
+ updateTool: (assignmentId: string, params: {
1456
+ usageComments?: string;
1457
+ enabled?: boolean;
1458
+ }) => Promise<{
1459
+ data: any;
1460
+ }>;
971
1461
  /** Remove a tool assignment from an agent. */
972
1462
  removeTool: (assignmentId: string) => Promise<void>;
973
1463
  /** Create a liaison agent for an external agent. */
@@ -982,6 +1472,11 @@ declare class CommonsClient {
982
1472
  * }
983
1473
  */
984
1474
  stream: (params: RunParams) => AsyncGenerator<StreamEvent>;
1475
+ /** Resume a streamed run after executing a caller-owned CLI tool. */
1476
+ submitCliToolResult: (requestId: string, result: string) => Promise<{
1477
+ data?: unknown;
1478
+ message?: string;
1479
+ }>;
985
1480
  /** Get the current heartbeat status for an agent. */
986
1481
  getAutonomy: (agentId: string) => Promise<{
987
1482
  data: {
@@ -1068,9 +1563,19 @@ declare class CommonsClient {
1068
1563
  readComputerFile: (agentId: string, pathOrLegacyComputerId: string, legacyPath?: string) => Promise<{
1069
1564
  data: ComputerFile;
1070
1565
  }>;
1566
+ writeComputerFile: (agentId: string, params: {
1567
+ path: string;
1568
+ content: string;
1569
+ encoding?: "utf8" | "base64";
1570
+ }) => Promise<{
1571
+ data: ComputerFile;
1572
+ }>;
1071
1573
  openComputerBrowser: (agentId: string, paramsOrLegacyComputerId: ComputerBrowserOpenParams | string, legacyParams?: ComputerBrowserOpenParams) => Promise<{
1072
1574
  data: any;
1073
1575
  }>;
1576
+ testComputerBrowser: (agentId: string) => Promise<{
1577
+ data: Record<string, unknown>;
1578
+ }>;
1074
1579
  listComputerEvents: (agentId: string, limitOrLegacyComputerId?: number | string, legacyLimit?: number) => Promise<{
1075
1580
  data: AgentComputerEvent[];
1076
1581
  }>;
@@ -1111,6 +1616,33 @@ declare class CommonsClient {
1111
1616
  data: any[];
1112
1617
  }>;
1113
1618
  };
1619
+ get copilot(): {
1620
+ get: () => Promise<{
1621
+ data: Agent | null;
1622
+ }>;
1623
+ updateSettings: (params: {
1624
+ accessMode: "full" | "scoped" | "confirm";
1625
+ scopes?: string[];
1626
+ }) => Promise<{
1627
+ data: Agent;
1628
+ }>;
1629
+ listChanges: (filter?: {
1630
+ status?: string;
1631
+ resourceType?: string;
1632
+ resourceId?: string;
1633
+ }) => Promise<{
1634
+ data: CopilotChange[];
1635
+ }>;
1636
+ acceptChange: (changeId: string) => Promise<{
1637
+ data: CopilotChange;
1638
+ }>;
1639
+ rejectChange: (changeId: string) => Promise<{
1640
+ data: CopilotChange;
1641
+ }>;
1642
+ revertChange: (changeId: string) => Promise<{
1643
+ data: CopilotChange;
1644
+ }>;
1645
+ };
1114
1646
  get run(): {
1115
1647
  once: (params: RunParams) => Promise<any>;
1116
1648
  };
@@ -1126,11 +1658,34 @@ declare class CommonsClient {
1126
1658
  tags?: string[];
1127
1659
  }) => Promise<Workflow>;
1128
1660
  list: (ownerId: string, ownerType: "user" | "agent") => Promise<Workflow[]>;
1661
+ discoverPublic: (filter?: {
1662
+ category?: string;
1663
+ tags?: string[];
1664
+ limit?: number;
1665
+ }) => Promise<Workflow[]>;
1129
1666
  get: (workflowId: string) => Promise<Workflow>;
1130
1667
  update: (workflowId: string, updates: Partial<Workflow>) => Promise<Workflow>;
1131
1668
  delete: (workflowId: string) => Promise<{
1132
1669
  success: boolean;
1133
1670
  }>;
1671
+ fork: (workflowId: string, params: {
1672
+ newOwnerId: string;
1673
+ newOwnerType: "user" | "agent";
1674
+ customizations?: {
1675
+ name?: string;
1676
+ description?: string;
1677
+ isPublic?: boolean;
1678
+ };
1679
+ }) => Promise<Workflow>;
1680
+ getWebhook: (workflowId: string) => Promise<Record<string, unknown>>;
1681
+ rotateWebhookToken: (workflowId: string) => Promise<{
1682
+ token: string;
1683
+ webhookUrl: string;
1684
+ }>;
1685
+ disableWebhook: (workflowId: string) => Promise<{
1686
+ success: boolean;
1687
+ }>;
1688
+ executeWebhook: (token: string, payload: unknown, query?: Record<string, string>) => Promise<unknown>;
1134
1689
  execute: (workflowId: string, params: {
1135
1690
  agentId?: string;
1136
1691
  sessionId?: string;
@@ -1239,6 +1794,18 @@ declare class CommonsClient {
1239
1794
  getFull: (sessionId: string) => Promise<{
1240
1795
  data: any;
1241
1796
  }>;
1797
+ /** Rename a session. */
1798
+ rename: (sessionId: string, title: string) => Promise<{
1799
+ data: Session;
1800
+ }>;
1801
+ /** Delete a session and its owned session data. */
1802
+ delete: (sessionId: string) => Promise<{
1803
+ data: unknown;
1804
+ }>;
1805
+ /** Get the full chat transcript for a session. */
1806
+ getChat: (sessionId: string) => Promise<{
1807
+ data: unknown;
1808
+ }>;
1242
1809
  };
1243
1810
  get tools(): {
1244
1811
  list: (filter?: {
@@ -1269,11 +1836,11 @@ declare class CommonsClient {
1269
1836
  get oauth(): {
1270
1837
  /** List OAuth providers available on the platform (Google Workspace, GitHub, …). */
1271
1838
  listProviders: () => Promise<{
1272
- providers: any[];
1839
+ providers: OAuthProvider[];
1273
1840
  }>;
1274
1841
  /** Get one provider's details, including its scope groups. */
1275
1842
  getProvider: (providerKey: string) => Promise<{
1276
- provider: any;
1843
+ provider: OAuthProvider;
1277
1844
  }>;
1278
1845
  /**
1279
1846
  * List the caller's OAuth connections (the accounts agents act with).
@@ -1283,7 +1850,19 @@ declare class CommonsClient {
1283
1850
  ownerId?: string;
1284
1851
  ownerType?: "user" | "agent";
1285
1852
  }) => Promise<{
1286
- connections: any[];
1853
+ connections: OAuthConnection[];
1854
+ }>;
1855
+ /** Get one OAuth connection. */
1856
+ getConnection: (connectionId: string) => Promise<{
1857
+ connection: OAuthConnection;
1858
+ }>;
1859
+ /** Update connection metadata or its active status. */
1860
+ updateConnection: (connectionId: string, params: {
1861
+ displayName?: string;
1862
+ isActive?: boolean;
1863
+ }) => Promise<{
1864
+ success: boolean;
1865
+ connection: OAuthConnection;
1287
1866
  }>;
1288
1867
  /**
1289
1868
  * Start an OAuth connect flow. Returns the authorization URL the user
@@ -1316,11 +1895,7 @@ declare class CommonsClient {
1316
1895
  }>;
1317
1896
  };
1318
1897
  get toolKeys(): {
1319
- list: (filter: {
1320
- ownerId?: string;
1321
- ownerType?: string;
1322
- toolId?: string;
1323
- }) => Promise<{
1898
+ list: () => Promise<{
1324
1899
  success: boolean;
1325
1900
  data: ToolKey[];
1326
1901
  }>;
@@ -1328,28 +1903,112 @@ declare class CommonsClient {
1328
1903
  success: boolean;
1329
1904
  data: ToolKey;
1330
1905
  }>;
1906
+ get: (keyId: string) => Promise<{
1907
+ success: boolean;
1908
+ data: ToolKey;
1909
+ }>;
1910
+ updateMetadata: (keyId: string, params: {
1911
+ displayName?: string;
1912
+ description?: string;
1913
+ isActive?: boolean;
1914
+ expiresAt?: string;
1915
+ }) => Promise<{
1916
+ success: boolean;
1917
+ data: ToolKey;
1918
+ }>;
1919
+ updateValue: (keyId: string, value: string) => Promise<{
1920
+ success: boolean;
1921
+ data: unknown;
1922
+ }>;
1923
+ test: (keyId: string) => Promise<{
1924
+ success: boolean;
1925
+ data: unknown;
1926
+ }>;
1927
+ mapToTool: (params: {
1928
+ toolId: string;
1929
+ keyId: string;
1930
+ contextId: string;
1931
+ contextType: "user" | "agent" | "global";
1932
+ priority?: number;
1933
+ }) => Promise<{
1934
+ success: boolean;
1935
+ data: unknown;
1936
+ }>;
1937
+ removeMapping: (mappingId: string) => Promise<{
1938
+ success: boolean;
1939
+ }>;
1331
1940
  delete: (keyId: string) => Promise<{
1332
1941
  success: boolean;
1333
1942
  }>;
1334
1943
  };
1335
1944
  get toolPermissions(): {
1336
- list: (toolId?: string) => Promise<{
1945
+ /** @deprecated Use listForTool with a tool ID. */
1946
+ list: (toolId: string) => Promise<{
1947
+ success: boolean;
1948
+ data: ToolPermission[];
1949
+ }>;
1950
+ listForTool: (toolId: string) => Promise<{
1951
+ success: boolean;
1952
+ data: ToolPermission[];
1953
+ }>;
1954
+ listForSubject: (subjectId: string, subjectType: "user" | "agent") => Promise<{
1337
1955
  success: boolean;
1338
1956
  data: ToolPermission[];
1339
1957
  }>;
1958
+ accessibleTools: (subjectId: string, subjectType: "user" | "agent") => Promise<{
1959
+ success: boolean;
1960
+ data: Tool[];
1961
+ }>;
1340
1962
  grant: (params: {
1341
1963
  toolId: string;
1342
1964
  subjectId: string;
1343
1965
  subjectType: "user" | "agent";
1344
1966
  permission: "read" | "execute" | "admin";
1345
- grantedBy?: string;
1967
+ grantedBy: string;
1968
+ expiresAt?: string;
1346
1969
  }) => Promise<{
1347
1970
  success: boolean;
1348
1971
  data: ToolPermission;
1349
1972
  }>;
1973
+ batchGrant: (params: {
1974
+ toolId: string;
1975
+ subjects: Array<{
1976
+ subjectId: string;
1977
+ subjectType: "user" | "agent";
1978
+ }>;
1979
+ permission: "read" | "execute" | "admin";
1980
+ grantedBy: string;
1981
+ expiresAt?: string;
1982
+ }) => Promise<{
1983
+ success: boolean;
1984
+ data: ToolPermission[];
1985
+ }>;
1350
1986
  revoke: (permissionId: string) => Promise<{
1351
1987
  success: boolean;
1352
1988
  }>;
1989
+ check: (params: {
1990
+ toolId: string;
1991
+ subjectId: string;
1992
+ subjectType: "user" | "agent";
1993
+ permission: "read" | "execute" | "admin";
1994
+ }) => Promise<{
1995
+ success: boolean;
1996
+ data: {
1997
+ hasPermission: boolean;
1998
+ };
1999
+ }>;
2000
+ checkAgentAccess: (toolId: string, agentId: string, userId?: string) => Promise<{
2001
+ success: boolean;
2002
+ data: unknown;
2003
+ }>;
2004
+ transferOwnership: (params: {
2005
+ toolId: string;
2006
+ newOwnerId: string;
2007
+ newOwnerType: "user" | "agent";
2008
+ }) => Promise<{
2009
+ success: boolean;
2010
+ data: Tool;
2011
+ }>;
1353
2012
  };
1354
2013
  get skills(): {
1355
2014
  list: (filter?: {
@@ -1365,6 +2024,12 @@ declare class CommonsClient {
1365
2024
  getIndex: (ownerId?: string) => Promise<{
1366
2025
  data: SkillIndex[];
1367
2026
  }>;
2027
+ listForAgent: (agentId: string) => Promise<{
2028
+ data: AgentSkill[];
2029
+ }>;
2030
+ setAgentAvailability: (skillIdOrSlug: string, agentId: string, isEnabled: boolean) => Promise<{
2031
+ data: unknown;
2032
+ }>;
1368
2033
  create: (params: CreateSkillParams) => Promise<{
1369
2034
  data: Skill;
1370
2035
  }>;
@@ -1374,6 +2039,41 @@ declare class CommonsClient {
1374
2039
  delete: (skillIdOrSlug: string) => Promise<{
1375
2040
  deleted: boolean;
1376
2041
  }>;
2042
+ import: (file: Blob, options?: {
2043
+ fileName?: string;
2044
+ agentId?: string;
2045
+ }) => Promise<{
2046
+ data: Skill;
2047
+ }>;
2048
+ };
2049
+ get providers(): {
2050
+ list: () => Promise<{
2051
+ catalog: Record<CapabilityName, CapabilityProviderDefinition[]>;
2052
+ configurations: CapabilityProviderConfiguration[];
2053
+ }>;
2054
+ configure: (capability: CapabilityName, input: CapabilityProviderInput) => Promise<{
2055
+ data: CapabilityProviderConfiguration;
2056
+ }>;
2057
+ remove: (capability: CapabilityName) => Promise<{
2058
+ deleted: boolean;
2059
+ }>;
2060
+ };
2061
+ get uiPlugins(): {
2062
+ list: (activeOnly?: boolean) => Promise<{
2063
+ data: UiPlugin[];
2064
+ }>;
2065
+ getBySlug: (slug: string) => Promise<{
2066
+ data: UiPlugin;
2067
+ }>;
2068
+ create: (input: CreateUiPluginParams) => Promise<{
2069
+ data: UiPlugin;
2070
+ }>;
2071
+ setStatus: (pluginId: string, status: "draft" | "active" | "disabled") => Promise<{
2072
+ data: UiPlugin;
2073
+ }>;
2074
+ delete: (pluginId: string) => Promise<{
2075
+ deleted: boolean;
2076
+ }>;
1377
2077
  };
1378
2078
  get wallets(): {
1379
2079
  /** List all wallets for an agent. */
@@ -1424,6 +2124,38 @@ declare class CommonsClient {
1424
2124
  principalType: string | null;
1425
2125
  }>;
1426
2126
  };
2127
+ get developer(): {
2128
+ scopes: () => Promise<{
2129
+ data: string[];
2130
+ }>;
2131
+ listProjects: () => Promise<{
2132
+ data: DeveloperProject[];
2133
+ }>;
2134
+ createProject: (params: {
2135
+ workspaceId: string;
2136
+ name: string;
2137
+ environment?: DeveloperProjectEnvironment;
2138
+ }) => Promise<{
2139
+ data: DeveloperProject;
2140
+ }>;
2141
+ listApiKeys: (projectId: string) => Promise<{
2142
+ data: DeveloperApiKey[];
2143
+ }>;
2144
+ createApiKey: (projectId: string, params: {
2145
+ name: string;
2146
+ scopes?: string[];
2147
+ expiresAt?: string | null;
2148
+ }) => Promise<{
2149
+ data: CreatedDeveloperApiKey;
2150
+ }>;
2151
+ revokeApiKey: (keyId: string) => Promise<void>;
2152
+ };
2153
+ /**
2154
+ * Legacy per-principal keys (`sk-ac-*`).
2155
+ *
2156
+ * New developer integrations should use `client.developer`, which creates
2157
+ * project-scoped `csk_*` keys with explicit environments and scopes.
2158
+ */
1427
2159
  get apiKeys(): {
1428
2160
  /**
1429
2161
  * Generate a new API key for a principal (user or agent).
@@ -1593,6 +2325,299 @@ declare class CommonsClient {
1593
2325
  data: UsageAggregation;
1594
2326
  }>;
1595
2327
  };
2328
+ get activity(): {
2329
+ list: (filter?: {
2330
+ actorId?: string;
2331
+ eventType?: string;
2332
+ since?: string;
2333
+ limit?: number;
2334
+ }) => Promise<{
2335
+ data: ActivityEvent[];
2336
+ }>;
2337
+ };
2338
+ get logs(): {
2339
+ list: (agentId: string, filter?: {
2340
+ sessionId?: string;
2341
+ limit?: number;
2342
+ }) => Promise<{
2343
+ data: AgentLog[];
2344
+ }>;
2345
+ observability: (agentId: string, filter?: {
2346
+ from?: string;
2347
+ to?: string;
2348
+ limit?: number;
2349
+ }) => Promise<Record<string, unknown>>;
2350
+ };
2351
+ get files(): {
2352
+ upload: (files: UploadFileInput[], params?: {
2353
+ agentId?: string;
2354
+ sessionId?: string;
2355
+ workspaceId?: string;
2356
+ storageProvider?: "s3" | "ipfs";
2357
+ }) => Promise<{
2358
+ data: FileArtifact[];
2359
+ }>;
2360
+ get: (fileId: string, context?: {
2361
+ agentId?: string;
2362
+ sessionId?: string;
2363
+ }) => Promise<{
2364
+ data: FileArtifact;
2365
+ }>;
2366
+ content: (fileId: string, options?: {
2367
+ agentId?: string;
2368
+ sessionId?: string;
2369
+ offset?: number;
2370
+ maxChars?: number;
2371
+ includeImageUrls?: boolean;
2372
+ includeDownloadUrl?: boolean;
2373
+ }) => Promise<{
2374
+ data: FileContent;
2375
+ }>;
2376
+ };
2377
+ get library(): {
2378
+ list: (filter?: {
2379
+ query?: string;
2380
+ view?: string;
2381
+ source?: string;
2382
+ favorite?: boolean;
2383
+ sessionId?: string;
2384
+ agentId?: string;
2385
+ limit?: number;
2386
+ offset?: number;
2387
+ }) => Promise<{
2388
+ data: LibraryItem[];
2389
+ total?: number;
2390
+ }>;
2391
+ get: (itemId: string) => Promise<{
2392
+ data: LibraryItem;
2393
+ }>;
2394
+ download: (itemId: string) => Promise<Record<string, unknown>>;
2395
+ preview: (itemId: string) => Promise<Record<string, unknown>>;
2396
+ update: (itemId: string, params: {
2397
+ name?: string;
2398
+ description?: string;
2399
+ isFavorite?: boolean;
2400
+ }) => Promise<{
2401
+ data: LibraryItem;
2402
+ }>;
2403
+ delete: (itemId: string) => Promise<{
2404
+ success?: boolean;
2405
+ }>;
2406
+ storagePreference: () => Promise<{
2407
+ data?: {
2408
+ defaultStorageProvider: "s3" | "ipfs";
2409
+ };
2410
+ defaultStorageProvider?: "s3" | "ipfs";
2411
+ }>;
2412
+ setStoragePreference: (defaultStorageProvider: "s3" | "ipfs") => Promise<{
2413
+ data?: {
2414
+ defaultStorageProvider: "s3" | "ipfs";
2415
+ };
2416
+ defaultStorageProvider?: "s3" | "ipfs";
2417
+ }>;
2418
+ grant: (itemId: string, params: {
2419
+ subjectType: "user" | "agent" | "workspace";
2420
+ subjectId: string;
2421
+ permission?: "read" | "edit" | "manage";
2422
+ expiresAt?: string | null;
2423
+ }) => Promise<{
2424
+ data: LibraryGrant;
2425
+ }>;
2426
+ revokeGrant: (itemId: string, grantId: string) => Promise<{
2427
+ success?: boolean;
2428
+ }>;
2429
+ createShareLink: (itemId: string, expiresAt?: string | null) => Promise<{
2430
+ data: LibraryShareLink;
2431
+ }>;
2432
+ revokeShareLink: (itemId: string, shareId: string) => Promise<{
2433
+ success?: boolean;
2434
+ }>;
2435
+ resolveShare: (token: string) => Promise<{
2436
+ data: LibraryItem;
2437
+ }>;
2438
+ };
2439
+ get spaces(): {
2440
+ list: (filter?: {
2441
+ memberId?: string;
2442
+ memberType?: "agent" | "human";
2443
+ agentIds?: string[];
2444
+ publicOnly?: boolean;
2445
+ search?: string;
2446
+ includeMembers?: boolean;
2447
+ limit?: number;
2448
+ offset?: number;
2449
+ }) => Promise<{
2450
+ data: Space[];
2451
+ total?: number;
2452
+ limit?: number;
2453
+ offset?: number;
2454
+ }>;
2455
+ create: (params: {
2456
+ name: string;
2457
+ description?: string;
2458
+ sessionId?: string;
2459
+ isPublic?: boolean;
2460
+ maxMembers?: number;
2461
+ image?: string;
2462
+ settings?: Record<string, unknown>;
2463
+ }, creator: {
2464
+ id: string;
2465
+ type: "agent" | "human";
2466
+ }) => Promise<{
2467
+ data: Space;
2468
+ }>;
2469
+ get: (spaceId: string) => Promise<{
2470
+ data: Space;
2471
+ }>;
2472
+ getFull: (spaceId: string) => Promise<{
2473
+ data: Space;
2474
+ }>;
2475
+ update: (spaceId: string, params: Partial<{
2476
+ name: string;
2477
+ description: string;
2478
+ sessionId: string;
2479
+ isPublic: boolean;
2480
+ maxMembers: number;
2481
+ image: string;
2482
+ settings: Record<string, unknown>;
2483
+ }>) => Promise<{
2484
+ data: Space;
2485
+ }>;
2486
+ delete: (spaceId: string) => Promise<{
2487
+ success?: boolean;
2488
+ }>;
2489
+ issueRtcTicket: (spaceId: string) => Promise<{
2490
+ data: {
2491
+ ticket: string;
2492
+ };
2493
+ }>;
2494
+ listMembers: (spaceId: string) => Promise<{
2495
+ data: SpaceMember[];
2496
+ }>;
2497
+ addMember: (spaceId: string, params: {
2498
+ memberId: string;
2499
+ memberType: "agent" | "human";
2500
+ role?: string;
2501
+ permissions?: Record<string, unknown>;
2502
+ }) => Promise<{
2503
+ data: SpaceMember;
2504
+ }>;
2505
+ updateMember: (spaceId: string, memberId: string, memberType: "agent" | "human", params: {
2506
+ role?: string;
2507
+ permissions?: Record<string, unknown>;
2508
+ status?: string;
2509
+ }) => Promise<{
2510
+ data: SpaceMember;
2511
+ }>;
2512
+ removeMember: (spaceId: string, memberId: string, memberType: "agent" | "human") => Promise<{
2513
+ success?: boolean;
2514
+ }>;
2515
+ listMessages: (spaceId: string, filter?: {
2516
+ limit?: number;
2517
+ offset?: number;
2518
+ memberId?: string;
2519
+ }) => Promise<{
2520
+ data: SpaceMessage[];
2521
+ }>;
2522
+ sendMessage: (spaceId: string, params: {
2523
+ content: string;
2524
+ targetType?: "broadcast" | "direct" | "group";
2525
+ targetIds?: string[];
2526
+ messageType?: string;
2527
+ metadata?: Record<string, unknown>;
2528
+ sessionId?: string;
2529
+ }, sender: {
2530
+ id: string;
2531
+ type: "agent" | "human";
2532
+ }) => Promise<{
2533
+ data: SpaceMessage;
2534
+ }>;
2535
+ updateMessage: (spaceId: string, messageId: string, params: {
2536
+ content?: string;
2537
+ metadata?: Record<string, unknown>;
2538
+ }) => Promise<{
2539
+ data: SpaceMessage;
2540
+ }>;
2541
+ deleteMessage: (spaceId: string, messageId: string) => Promise<{
2542
+ success?: boolean;
2543
+ }>;
2544
+ };
2545
+ get projects(): {
2546
+ list: (agentId: string) => Promise<{
2547
+ data: CodeProject[];
2548
+ }>;
2549
+ create: (agentId: string, params: {
2550
+ name: string;
2551
+ description?: string;
2552
+ sessionId?: string;
2553
+ files?: CodeProjectFile[];
2554
+ }) => Promise<{
2555
+ data: CodeProject;
2556
+ }>;
2557
+ get: (agentId: string, projectId: string) => Promise<{
2558
+ data: CodeProject;
2559
+ }>;
2560
+ writeFiles: (agentId: string, projectId: string, files: CodeProjectFile[], replace?: boolean) => Promise<{
2561
+ data: CodeProject;
2562
+ }>;
2563
+ publish: (agentId: string, projectId: string) => Promise<{
2564
+ data: Record<string, unknown>;
2565
+ }>;
2566
+ verify: (agentId: string, projectId: string, actions?: Array<Record<string, unknown>>) => Promise<{
2567
+ data: Record<string, unknown>;
2568
+ }>;
2569
+ exportToComputer: (agentId: string, projectId: string, params?: {
2570
+ directory?: string;
2571
+ sessionId?: string;
2572
+ }) => Promise<{
2573
+ data: Record<string, unknown>;
2574
+ }>;
2575
+ exportToGitHub: (agentId: string, projectId: string, params?: {
2576
+ repositoryName?: string;
2577
+ private?: boolean;
2578
+ }) => Promise<{
2579
+ data: Record<string, unknown>;
2580
+ }>;
2581
+ };
2582
+ get goals(): {
2583
+ create: (params: Record<string, unknown>) => Promise<{
2584
+ data: Goal;
2585
+ }>;
2586
+ get: (goalId: string) => Promise<{
2587
+ data: Goal;
2588
+ }>;
2589
+ updateProgress: (goalId: string, progress: number, status: Goal["status"]) => Promise<{
2590
+ data: Goal;
2591
+ }>;
2592
+ };
2593
+ get audio(): {
2594
+ transcribe: (file: UploadFileInput, options?: {
2595
+ durationMs?: number;
2596
+ idempotencyKey?: string;
2597
+ }) => Promise<{
2598
+ data: {
2599
+ text: string;
2600
+ };
2601
+ }>;
2602
+ };
2603
+ get liaisons(): {
2604
+ create: (params: {
2605
+ name: string;
2606
+ owner: string;
2607
+ externalOwner: string;
2608
+ persona?: string;
2609
+ instructions?: string;
2610
+ externalUrl?: string;
2611
+ externalEndpoint?: string;
2612
+ }) => Promise<{
2613
+ data: Agent;
2614
+ liaisonKey: string;
2615
+ note: string;
2616
+ }>;
2617
+ interact: (liaisonAgentId: string, liaisonKey: string, message?: string) => Promise<{
2618
+ data: unknown;
2619
+ }>;
2620
+ };
1596
2621
  get credits(): {
1597
2622
  balance: (filter?: {
1598
2623
  principalId?: string;
@@ -1607,6 +2632,31 @@ declare class CommonsClient {
1607
2632
  }) => Promise<{
1608
2633
  data: CreditLedgerEntry[];
1609
2634
  }>;
2635
+ summary: () => Promise<{
2636
+ data: CreditSummary;
2637
+ }>;
2638
+ campaigns: () => Promise<{
2639
+ data: CreditCampaign[];
2640
+ }>;
2641
+ claimCampaign: (params: {
2642
+ campaignKey: string;
2643
+ eventId?: string;
2644
+ }) => Promise<{
2645
+ data: {
2646
+ alreadyClaimed: boolean;
2647
+ };
2648
+ }>;
2649
+ transfers: () => Promise<{
2650
+ data: CreditTransfer[];
2651
+ }>;
2652
+ gift: (params: {
2653
+ recipientPrincipalId: string;
2654
+ amount: number;
2655
+ message?: string;
2656
+ idempotencyKey: string;
2657
+ }) => Promise<{
2658
+ data: CreditTransfer;
2659
+ }>;
1610
2660
  grant: (params: CreditWriteParams) => Promise<{
1611
2661
  data: CreditLedgerEntry;
1612
2662
  }>;
@@ -1614,6 +2664,56 @@ declare class CommonsClient {
1614
2664
  data: CreditLedgerEntry;
1615
2665
  }>;
1616
2666
  };
2667
+ get billing(): {
2668
+ /** Public product catalog served from the backend source of truth. */
2669
+ catalog: () => Promise<{
2670
+ data: BillingCatalog;
2671
+ }>;
2672
+ /** Current plan, status, and entitlements for the caller. */
2673
+ subscription: () => Promise<{
2674
+ data: SubscriptionInfo;
2675
+ }>;
2676
+ /** Entitlements only (what paid features the caller may use). */
2677
+ entitlements: () => Promise<{
2678
+ data: PlanEntitlements;
2679
+ }>;
2680
+ /** Stripe invoice history for the caller. */
2681
+ invoices: () => Promise<{
2682
+ data: BillingInvoice[];
2683
+ }>;
2684
+ /** Saved Stripe payment methods for the caller. */
2685
+ paymentMethods: () => Promise<{
2686
+ data: BillingPaymentMethod[];
2687
+ }>;
2688
+ /** Create a Stripe Checkout session for a subscription plan. */
2689
+ subscribe: (planKey: "plus" | "pro" | "max") => Promise<{
2690
+ data: {
2691
+ url: string;
2692
+ };
2693
+ }>;
2694
+ /** Create a Stripe Checkout session for a one-time credit top-up. */
2695
+ topup: (packKey: string) => Promise<{
2696
+ data: {
2697
+ url: string;
2698
+ };
2699
+ }>;
2700
+ /** Open the Stripe billing portal. */
2701
+ portal: () => Promise<{
2702
+ data: {
2703
+ url: string;
2704
+ };
2705
+ }>;
2706
+ };
2707
+ get flags(): {
2708
+ /** Evaluate all active flags for the caller (call once at boot). */
2709
+ all: () => Promise<{
2710
+ data: Record<string, FlagEvaluation>;
2711
+ }>;
2712
+ /** Evaluate a single flag for the caller. */
2713
+ evaluate: (key: string) => Promise<{
2714
+ data: FlagEvaluation;
2715
+ }>;
2716
+ };
1617
2717
  }
1618
2718
  declare class CommonsError extends Error {
1619
2719
  readonly status: number;
@@ -1657,4 +2757,4 @@ declare function listWorkflowTemplates(): readonly [{
1657
2757
  }];
1658
2758
  declare function buildWorkflowTemplate(templateName: WorkflowTemplateName, ctx: WorkflowTemplateContext): WorkflowTemplateBuild;
1659
2759
 
1660
- export { type A2AArtifact, type A2ADataPart, type A2AFilePart, type A2AMessage, type A2AMessagePart, type A2ASendTaskParams, type A2ASkill, type A2ATask, type A2ATaskState, type A2ATextPart, type Agent, type AgentCard, type AgentComputer, type AgentComputerBrowser, type AgentComputerConfig, type AgentComputerDesiredState, type AgentComputerEvent, type AgentComputerGpu, type AgentComputerGpuType, type AgentComputerInstance, type AgentComputerLifecycle, type AgentComputerResourceMode, type AgentComputerResourceProfile, type AgentComputerResources, type AgentComputerStatus, type AgentComputerTerminal, type AgentMemory, type AgentWallet, type ApiKey, type ApiKeyPrincipalType, type ChatMessage, CommonsClient, type CommonsClientConfig, CommonsError, type ComputerActionParams, type ComputerBrowserOpenParams, type ComputerCommandParams, type ComputerConfigUpdate, type ComputerFile, type ComputerGpu, type ComputerGpuType, type ComputerLifecycle, type ComputerNetworkAccess, type ComputerPersistence, type ComputerResizeParams, type ComputerResourceMode, type ComputerResourceProfile, type ComputerResourceUpdate, type ComputerResources, type CreateAgentParams, type CreateApiKeyParams, type CreateMemoryParams, type CreateSkillParams, type CreateTaskParams, type CreateToolKeyParams, type CreateToolParams, type CreateWalletParams, type CreatedApiKey, type McpConnectionType, type McpPrompt, type McpResource, type McpServer, type MemorySourceType, type MemoryStats, type MemoryType, type ModelConfig, type ModelProvider, type RunParams, type Session, type Skill, type SkillIndex, type StreamEvent, type StreamEventType, type Task, type Tool, type ToolKey, type ToolPermission, type UpdateMemoryParams, type UsageAggregation, type UsageEvent, type WalletBalance, type WalletType, type Workflow, type WorkflowDefinition, type WorkflowEdge, type WorkflowExecution, type WorkflowNode, type WorkflowNodeType, type WorkflowTemplateBuild, type WorkflowTemplateContext, type WorkflowTemplateName, type WorkflowTemplateTool, buildWorkflowTemplate, listWorkflowTemplates };
2760
+ export { type A2AArtifact, type A2ADataPart, type A2AFilePart, type A2AMessage, type A2AMessagePart, type A2ASendTaskParams, type A2ASkill, type A2ATask, type A2ATaskState, type A2ATextPart, type ActivityEvent, type Agent, type AgentCard, type AgentComputer, type AgentComputerBrowser, type AgentComputerConfig, type AgentComputerDesiredState, type AgentComputerEvent, type AgentComputerGpu, type AgentComputerGpuType, type AgentComputerInstance, type AgentComputerLifecycle, type AgentComputerResourceMode, type AgentComputerResourceProfile, type AgentComputerResources, type AgentComputerStatus, type AgentComputerTerminal, type AgentLog, type AgentMemory, type AgentSkill, type AgentWallet, type ApiKey, type ApiKeyPrincipalType, type BillingCatalog, type BillingInvoice, type BillingPaymentMethod, type CapabilityName, type CapabilityProviderConfiguration, type CapabilityProviderDefinition, type CapabilityProviderInput, type ChatMessage, type CodeProject, type CodeProjectFile, CommonsClient, type CommonsClientConfig, CommonsError, type CommonsRequestOptions, type ComputeProfile, type ComputerActionParams, type ComputerBrowserOpenParams, type ComputerCommandParams, type ComputerConfigUpdate, type ComputerFile, type ComputerGpu, type ComputerGpuType, type ComputerLifecycle, type ComputerNetworkAccess, type ComputerPersistence, type ComputerResizeParams, type ComputerResourceMode, type ComputerResourceProfile, type ComputerResourceUpdate, type ComputerResources, type CreateAgentParams, type CreateApiKeyParams, type CreateMemoryParams, type CreateSkillParams, type CreateTaskParams, type CreateToolKeyParams, type CreateToolParams, type CreateUiPluginParams, type CreateWalletParams, type CreatedApiKey, type CreatedDeveloperApiKey, type CreditBalance, type CreditCampaign, type CreditDirection, type CreditLedgerEntry, type CreditPlatform, type CreditSummary, type CreditTransfer, type CreditWriteParams, type DeveloperApiKey, type DeveloperProject, type DeveloperProjectEnvironment, type FileArtifact, type FileContent, type FileContentArtifact, type FileContentDownload, type FlagEvaluation, type GenerateImageParams, type GeneratedImageAsset, type Goal, type LibraryGrant, type LibraryItem, type LibraryShareLink, type McpConnectionType, type McpPrompt, type McpResource, type McpServer, type MemorySourceType, type MemoryStats, type MemoryType, type ModelConfig, type ModelProvider, type ModelTier, type OAuthConnection, type OAuthProvider, type OutputPresentation, type PlanEntitlements, type PlanKey, type RunParams, type Session, type Skill, type SkillAgentAssignment, type SkillIndex, type Space, type SpaceMember, type SpaceMessage, type StreamEvent, type StreamEventType, type SubscriptionInfo, type Task, type Tool, type ToolKey, type ToolPermission, type UiPlugin, type UiPluginPermission, type UiPluginSurface, type UpdateMemoryParams, type UploadFileInput, type UsageAggregation, type UsageEvent, type WalletBalance, type WalletType, type Workflow, type WorkflowDefinition, type WorkflowEdge, type WorkflowExecution, type WorkflowNode, type WorkflowNodeType, type WorkflowTemplateBuild, type WorkflowTemplateContext, type WorkflowTemplateName, type WorkflowTemplateTool, type WorkflowValue, type WorkflowValueKind, buildWorkflowTemplate, listWorkflowTemplates };