@robosystems/client 0.2.10 → 0.2.12
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/extensions/AgentClient.d.ts +82 -0
- package/extensions/AgentClient.js +218 -0
- package/extensions/AgentClient.ts +321 -0
- package/extensions/QueryClient.js +85 -37
- package/extensions/QueryClient.ts +82 -34
- package/extensions/index.d.ts +7 -1
- package/extensions/index.js +18 -1
- package/extensions/index.ts +21 -1
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +197 -91
- package/sdk/sdk.gen.js +452 -169
- package/sdk/sdk.gen.ts +441 -159
- package/sdk/types.gen.d.ts +854 -246
- package/sdk/types.gen.ts +955 -279
- package/sdk-extensions/AgentClient.d.ts +82 -0
- package/sdk-extensions/AgentClient.js +218 -0
- package/sdk-extensions/AgentClient.ts +321 -0
- package/sdk-extensions/QueryClient.js +85 -37
- package/sdk-extensions/QueryClient.ts +82 -34
- package/sdk-extensions/index.d.ts +7 -1
- package/sdk-extensions/index.js +18 -1
- package/sdk-extensions/index.ts +21 -1
- package/sdk.gen.d.ts +197 -91
- package/sdk.gen.js +452 -169
- package/sdk.gen.ts +441 -159
- package/types.gen.d.ts +854 -246
- package/types.gen.ts +955 -279
package/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Options as ClientOptions, TDataShape, Client } from './client';
|
|
2
|
-
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors,
|
|
2
|
+
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ListUserOrgsData, ListUserOrgsResponses, CreateOrgData, CreateOrgResponses, CreateOrgErrors, GetOrgData, GetOrgResponses, GetOrgErrors, UpdateOrgData, UpdateOrgResponses, UpdateOrgErrors, ListOrgGraphsData, ListOrgGraphsResponses, ListOrgGraphsErrors, ListOrgMembersData, ListOrgMembersResponses, ListOrgMembersErrors, InviteOrgMemberData, InviteOrgMemberResponses, InviteOrgMemberErrors, RemoveOrgMemberData, RemoveOrgMemberResponses, RemoveOrgMemberErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, GetOrgLimitsData, GetOrgLimitsResponses, GetOrgLimitsErrors, GetOrgUsageData, GetOrgUsageResponses, GetOrgUsageErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, CancelSubscriptionData, CancelSubscriptionResponses, CancelSubscriptionErrors, GetGraphSubscriptionData, GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, CreateRepositorySubscriptionData, CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, UpgradeSubscriptionData, UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, GetAvailableGraphTiersData, GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors, GetOrgBillingCustomerData, GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, UpdateOrgPaymentMethodData, UpdateOrgPaymentMethodResponses, UpdateOrgPaymentMethodErrors, ListOrgSubscriptionsData, ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, GetOrgSubscriptionData, GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, CancelOrgSubscriptionData, CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ListOrgInvoicesData, ListOrgInvoicesResponses, ListOrgInvoicesErrors, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, CreateCheckoutSessionData, CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, GetCheckoutStatusData, GetCheckoutStatusResponses, GetCheckoutStatusErrors } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -15,7 +15,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
17
|
* Register New User
|
|
18
|
-
* Register a new user account with email and password.
|
|
18
|
+
* Register a new user account with email and password.
|
|
19
|
+
*
|
|
20
|
+
* **Organization Creation**: RoboSystems is an org-centric platform. When you register, a personal organization is automatically created for you. All resources (graphs, subscriptions, billing) belong to organizations, not individual users. You can later upgrade your personal org to a team or enterprise organization.
|
|
21
|
+
*
|
|
22
|
+
* **Security Controls**: CAPTCHA and email verification are disabled in development for API testing, but required in production.
|
|
19
23
|
*/
|
|
20
24
|
export declare const registerUser: <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => import("./client").RequestResult<RegisterUserResponses, RegisterUserErrors, ThrowOnError, "fields">;
|
|
21
25
|
/**
|
|
@@ -134,10 +138,63 @@ export declare const revokeUserApiKey: <ThrowOnError extends boolean = false>(op
|
|
|
134
138
|
*/
|
|
135
139
|
export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ThrowOnError, "fields">;
|
|
136
140
|
/**
|
|
137
|
-
*
|
|
138
|
-
*
|
|
141
|
+
* List User's Organizations
|
|
142
|
+
* Get all organizations the current user belongs to, with their role in each.
|
|
143
|
+
*/
|
|
144
|
+
export declare const listUserOrgs: <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => import("./client").RequestResult<ListUserOrgsResponses, unknown, ThrowOnError, "fields">;
|
|
145
|
+
/**
|
|
146
|
+
* Create Organization
|
|
147
|
+
* Create a new organization. The creating user becomes the owner.
|
|
148
|
+
*/
|
|
149
|
+
export declare const createOrg: <ThrowOnError extends boolean = false>(options: Options<CreateOrgData, ThrowOnError>) => import("./client").RequestResult<CreateOrgResponses, CreateOrgErrors, ThrowOnError, "fields">;
|
|
150
|
+
/**
|
|
151
|
+
* Get Organization
|
|
152
|
+
* Get detailed information about an organization.
|
|
153
|
+
*/
|
|
154
|
+
export declare const getOrg: <ThrowOnError extends boolean = false>(options: Options<GetOrgData, ThrowOnError>) => import("./client").RequestResult<GetOrgResponses, GetOrgErrors, ThrowOnError, "fields">;
|
|
155
|
+
/**
|
|
156
|
+
* Update Organization
|
|
157
|
+
* Update organization information. Requires admin or owner role.
|
|
158
|
+
*/
|
|
159
|
+
export declare const updateOrg: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgData, ThrowOnError>) => import("./client").RequestResult<UpdateOrgResponses, UpdateOrgErrors, ThrowOnError, "fields">;
|
|
160
|
+
/**
|
|
161
|
+
* List Organization Graphs
|
|
162
|
+
* Get all graphs belonging to an organization.
|
|
139
163
|
*/
|
|
140
|
-
export declare const
|
|
164
|
+
export declare const listOrgGraphs: <ThrowOnError extends boolean = false>(options: Options<ListOrgGraphsData, ThrowOnError>) => import("./client").RequestResult<ListOrgGraphsResponses, ListOrgGraphsErrors, ThrowOnError, "fields">;
|
|
165
|
+
/**
|
|
166
|
+
* List Organization Members
|
|
167
|
+
* Get all members of an organization with their roles.
|
|
168
|
+
*/
|
|
169
|
+
export declare const listOrgMembers: <ThrowOnError extends boolean = false>(options: Options<ListOrgMembersData, ThrowOnError>) => import("./client").RequestResult<ListOrgMembersResponses, ListOrgMembersErrors, ThrowOnError, "fields">;
|
|
170
|
+
/**
|
|
171
|
+
* Invite Member
|
|
172
|
+
* Invite a user to join the organization. Requires admin or owner role.
|
|
173
|
+
*
|
|
174
|
+
* **⚠️ FEATURE NOT READY**: This endpoint is disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false).
|
|
175
|
+
* Returns 501 NOT IMPLEMENTED when disabled. See endpoint implementation for TODO list before enabling.
|
|
176
|
+
*/
|
|
177
|
+
export declare const inviteOrgMember: <ThrowOnError extends boolean = false>(options: Options<InviteOrgMemberData, ThrowOnError>) => import("./client").RequestResult<InviteOrgMemberResponses, InviteOrgMemberErrors, ThrowOnError, "fields">;
|
|
178
|
+
/**
|
|
179
|
+
* Remove Member
|
|
180
|
+
* Remove a member from the organization. Requires admin or owner role.
|
|
181
|
+
*/
|
|
182
|
+
export declare const removeOrgMember: <ThrowOnError extends boolean = false>(options: Options<RemoveOrgMemberData, ThrowOnError>) => import("./client").RequestResult<RemoveOrgMemberResponses, RemoveOrgMemberErrors, ThrowOnError, "fields">;
|
|
183
|
+
/**
|
|
184
|
+
* Update Member Role
|
|
185
|
+
* Update a member's role in the organization. Requires admin or owner role.
|
|
186
|
+
*/
|
|
187
|
+
export declare const updateOrgMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) => import("./client").RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError, "fields">;
|
|
188
|
+
/**
|
|
189
|
+
* Get Organization Limits
|
|
190
|
+
* Get the current limits and quotas for an organization.
|
|
191
|
+
*/
|
|
192
|
+
export declare const getOrgLimits: <ThrowOnError extends boolean = false>(options: Options<GetOrgLimitsData, ThrowOnError>) => import("./client").RequestResult<GetOrgLimitsResponses, GetOrgLimitsErrors, ThrowOnError, "fields">;
|
|
193
|
+
/**
|
|
194
|
+
* Get Organization Usage
|
|
195
|
+
* Get detailed usage statistics for an organization aggregated across all graphs.
|
|
196
|
+
*/
|
|
197
|
+
export declare const getOrgUsage: <ThrowOnError extends boolean = false>(options: Options<GetOrgUsageData, ThrowOnError>) => import("./client").RequestResult<GetOrgUsageResponses, GetOrgUsageErrors, ThrowOnError, "fields">;
|
|
141
198
|
/**
|
|
142
199
|
* List Connections
|
|
143
200
|
* List all data connections in the graph.
|
|
@@ -335,9 +392,22 @@ export declare const getConnection: <ThrowOnError extends boolean = false>(optio
|
|
|
335
392
|
* Returns a task ID for monitoring sync progress.
|
|
336
393
|
*/
|
|
337
394
|
export declare const syncConnection: <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => import("./client").RequestResult<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError, "fields">;
|
|
395
|
+
/**
|
|
396
|
+
* List available agents
|
|
397
|
+
* Get a comprehensive list of all available agents with their metadata.
|
|
398
|
+
*
|
|
399
|
+
* **Returns:**
|
|
400
|
+
* - Agent types and names
|
|
401
|
+
* - Capabilities and supported modes
|
|
402
|
+
* - Version information
|
|
403
|
+
* - Credit requirements
|
|
404
|
+
*
|
|
405
|
+
* Use the optional `capability` filter to find agents with specific capabilities.
|
|
406
|
+
*/
|
|
407
|
+
export declare const listAgents: <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => import("./client").RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError, "fields">;
|
|
338
408
|
/**
|
|
339
409
|
* Auto-select agent for query
|
|
340
|
-
* Automatically select the best agent for your query.
|
|
410
|
+
* Automatically select the best agent for your query with intelligent execution strategy.
|
|
341
411
|
*
|
|
342
412
|
* **Agent Selection Process:**
|
|
343
413
|
*
|
|
@@ -346,7 +416,8 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
|
|
|
346
416
|
* 2. Enriching context with RAG if enabled
|
|
347
417
|
* 3. Evaluating all available agents against selection criteria
|
|
348
418
|
* 4. Selecting the best match based on confidence scores
|
|
349
|
-
* 5.
|
|
419
|
+
* 5. Choosing execution strategy (sync/SSE/async) based on expected time
|
|
420
|
+
* 6. Executing the query with the selected agent
|
|
350
421
|
*
|
|
351
422
|
* **Available Agent Types:**
|
|
352
423
|
* - `financial`: Financial analysis, SEC filings, company metrics
|
|
@@ -359,6 +430,14 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
|
|
|
359
430
|
* - `extended`: Comprehensive analysis (~15-60s), deep research
|
|
360
431
|
* - `streaming`: Real-time response streaming
|
|
361
432
|
*
|
|
433
|
+
* **Execution Strategies (automatic):**
|
|
434
|
+
* - Fast operations (<5s): Immediate synchronous response
|
|
435
|
+
* - Medium operations (5-30s): SSE streaming with progress updates
|
|
436
|
+
* - Long operations (>30s): Async Celery worker with operation tracking
|
|
437
|
+
*
|
|
438
|
+
* **Response Mode Override:**
|
|
439
|
+
* Use query parameter `?mode=sync|async` to override automatic strategy selection.
|
|
440
|
+
*
|
|
362
441
|
* **Confidence Score Interpretation:**
|
|
363
442
|
* - `0.9-1.0`: High confidence, agent is ideal match
|
|
364
443
|
* - `0.7-0.9`: Good confidence, agent is suitable
|
|
@@ -381,15 +460,38 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
|
|
|
381
460
|
* See request/response examples in the "Examples" dropdown below.
|
|
382
461
|
*/
|
|
383
462
|
export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
|
|
463
|
+
/**
|
|
464
|
+
* Get agent metadata
|
|
465
|
+
* Get comprehensive metadata for a specific agent type.
|
|
466
|
+
*
|
|
467
|
+
* **Returns:**
|
|
468
|
+
* - Agent name and description
|
|
469
|
+
* - Version information
|
|
470
|
+
* - Supported capabilities and modes
|
|
471
|
+
* - Credit requirements
|
|
472
|
+
* - Author and tags
|
|
473
|
+
* - Configuration options
|
|
474
|
+
*
|
|
475
|
+
* Use this to understand agent capabilities before execution.
|
|
476
|
+
*/
|
|
477
|
+
export declare const getAgentMetadata: <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => import("./client").RequestResult<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError, "fields">;
|
|
384
478
|
/**
|
|
385
479
|
* Execute specific agent
|
|
386
|
-
* Execute a specific agent type directly.
|
|
480
|
+
* Execute a specific agent type directly with intelligent execution strategy.
|
|
387
481
|
*
|
|
388
482
|
* Available agents:
|
|
389
483
|
* - **financial**: Financial analysis, SEC filings, accounting data
|
|
390
484
|
* - **research**: Deep research and comprehensive analysis
|
|
391
485
|
* - **rag**: Fast retrieval without AI (no credits required)
|
|
392
486
|
*
|
|
487
|
+
* **Execution Strategies (automatic):**
|
|
488
|
+
* - Fast operations (<5s): Immediate synchronous response
|
|
489
|
+
* - Medium operations (5-30s): SSE streaming with progress updates
|
|
490
|
+
* - Long operations (>30s): Async Celery worker with operation tracking
|
|
491
|
+
*
|
|
492
|
+
* **Response Mode Override:**
|
|
493
|
+
* Use query parameter `?mode=sync|async` to override automatic strategy selection.
|
|
494
|
+
*
|
|
393
495
|
* Use this endpoint when you know which agent you want to use.
|
|
394
496
|
*/
|
|
395
497
|
export declare const executeSpecificAgent: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificAgentData, ThrowOnError>) => import("./client").RequestResult<ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, ThrowOnError, "fields">;
|
|
@@ -411,34 +513,6 @@ export declare const executeSpecificAgent: <ThrowOnError extends boolean = false
|
|
|
411
513
|
* Returns individual results for each query with execution metrics.
|
|
412
514
|
*/
|
|
413
515
|
export declare const batchProcessQueries: <ThrowOnError extends boolean = false>(options: Options<BatchProcessQueriesData, ThrowOnError>) => import("./client").RequestResult<BatchProcessQueriesResponses, BatchProcessQueriesErrors, ThrowOnError, "fields">;
|
|
414
|
-
/**
|
|
415
|
-
* List available agents
|
|
416
|
-
* Get a comprehensive list of all available agents with their metadata.
|
|
417
|
-
*
|
|
418
|
-
* **Returns:**
|
|
419
|
-
* - Agent types and names
|
|
420
|
-
* - Capabilities and supported modes
|
|
421
|
-
* - Version information
|
|
422
|
-
* - Credit requirements
|
|
423
|
-
*
|
|
424
|
-
* Use the optional `capability` filter to find agents with specific capabilities.
|
|
425
|
-
*/
|
|
426
|
-
export declare const listAgents: <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => import("./client").RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError, "fields">;
|
|
427
|
-
/**
|
|
428
|
-
* Get agent metadata
|
|
429
|
-
* Get comprehensive metadata for a specific agent type.
|
|
430
|
-
*
|
|
431
|
-
* **Returns:**
|
|
432
|
-
* - Agent name and description
|
|
433
|
-
* - Version information
|
|
434
|
-
* - Supported capabilities and modes
|
|
435
|
-
* - Credit requirements
|
|
436
|
-
* - Author and tags
|
|
437
|
-
* - Configuration options
|
|
438
|
-
*
|
|
439
|
-
* Use this to understand agent capabilities before execution.
|
|
440
|
-
*/
|
|
441
|
-
export declare const getAgentMetadata: <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => import("./client").RequestResult<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError, "fields">;
|
|
442
516
|
/**
|
|
443
517
|
* Get agent recommendations
|
|
444
518
|
* Get intelligent agent recommendations for a specific query.
|
|
@@ -687,7 +761,7 @@ export declare const getBackupStats: <ThrowOnError extends boolean = false>(opti
|
|
|
687
761
|
export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => import("./client").RequestResult<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError, "fields">;
|
|
688
762
|
/**
|
|
689
763
|
* Get Graph Usage Analytics
|
|
690
|
-
* Get comprehensive usage analytics tracked by the
|
|
764
|
+
* Get comprehensive usage analytics tracked by the GraphUsage model.
|
|
691
765
|
*
|
|
692
766
|
* Provides temporal usage patterns including:
|
|
693
767
|
* - **Storage Analytics**: GB-hours for billing, breakdown by type (files, tables, graphs, subgraphs)
|
|
@@ -1706,9 +1780,15 @@ export declare const selectGraph: <ThrowOnError extends boolean = false>(options
|
|
|
1706
1780
|
* and shared repository subscriptions. This is the primary endpoint for frontend
|
|
1707
1781
|
* applications to display subscription options.
|
|
1708
1782
|
*
|
|
1783
|
+
* **Pricing Model:**
|
|
1784
|
+
* - Graph subscriptions are **per-graph** with infrastructure-based pricing
|
|
1785
|
+
* - Each graph you create has its own monthly subscription
|
|
1786
|
+
* - Organizations can have multiple graphs with different infrastructure tiers
|
|
1787
|
+
* - Credits are allocated per-graph, not shared across organization
|
|
1788
|
+
*
|
|
1709
1789
|
* Includes:
|
|
1710
|
-
* - Graph
|
|
1711
|
-
* - Shared repository subscriptions (SEC, industry, economic data)
|
|
1790
|
+
* - Graph infrastructure tiers (kuzu-standard, kuzu-large, kuzu-xlarge) - per-graph pricing
|
|
1791
|
+
* - Shared repository subscriptions (SEC, industry, economic data) - org-level
|
|
1712
1792
|
* - Operation costs and credit information
|
|
1713
1793
|
* - Features and capabilities for each tier
|
|
1714
1794
|
* - Enabled/disabled status for repositories
|
|
@@ -1799,23 +1879,96 @@ export declare const getOperationStatus: <ThrowOnError extends boolean = false>(
|
|
|
1799
1879
|
* **No credits are consumed for cancellation requests.**
|
|
1800
1880
|
*/
|
|
1801
1881
|
export declare const cancelOperation: <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) => import("./client").RequestResult<CancelOperationResponses, CancelOperationErrors, ThrowOnError, "fields">;
|
|
1882
|
+
/**
|
|
1883
|
+
* Get Organization Customer Info
|
|
1884
|
+
* Get billing customer information for an organization including payment methods on file.
|
|
1885
|
+
*
|
|
1886
|
+
* Returns customer details, payment methods, and whether invoice billing is enabled.
|
|
1887
|
+
*
|
|
1888
|
+
* **Requirements:**
|
|
1889
|
+
* - User must be a member of the organization
|
|
1890
|
+
* - Sensitive payment details are only visible to owners
|
|
1891
|
+
*/
|
|
1892
|
+
export declare const getOrgBillingCustomer: <ThrowOnError extends boolean = false>(options: Options<GetOrgBillingCustomerData, ThrowOnError>) => import("./client").RequestResult<GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, ThrowOnError, "fields">;
|
|
1893
|
+
/**
|
|
1894
|
+
* Update Organization Default Payment Method
|
|
1895
|
+
* Update the default payment method for the organization.
|
|
1896
|
+
*
|
|
1897
|
+
* This changes which payment method will be used for future subscription charges.
|
|
1898
|
+
*
|
|
1899
|
+
* **Requirements:**
|
|
1900
|
+
* - User must be an OWNER of the organization
|
|
1901
|
+
*/
|
|
1902
|
+
export declare const updateOrgPaymentMethod: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgPaymentMethodData, ThrowOnError>) => import("./client").RequestResult<UpdateOrgPaymentMethodResponses, UpdateOrgPaymentMethodErrors, ThrowOnError, "fields">;
|
|
1903
|
+
/**
|
|
1904
|
+
* List Organization Subscriptions
|
|
1905
|
+
* List all active and past subscriptions for an organization.
|
|
1906
|
+
*
|
|
1907
|
+
* Includes both graph and repository subscriptions with their status, pricing, and billing information.
|
|
1908
|
+
*
|
|
1909
|
+
* **Requirements:**
|
|
1910
|
+
* - User must be a member of the organization
|
|
1911
|
+
*/
|
|
1912
|
+
export declare const listOrgSubscriptions: <ThrowOnError extends boolean = false>(options: Options<ListOrgSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, ThrowOnError, "fields">;
|
|
1913
|
+
/**
|
|
1914
|
+
* Get Organization Subscription Details
|
|
1915
|
+
* Get detailed information about a specific subscription.
|
|
1916
|
+
*
|
|
1917
|
+
* **Requirements:**
|
|
1918
|
+
* - User must be a member of the organization
|
|
1919
|
+
*/
|
|
1920
|
+
export declare const getOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<GetOrgSubscriptionData, ThrowOnError>) => import("./client").RequestResult<GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, ThrowOnError, "fields">;
|
|
1921
|
+
/**
|
|
1922
|
+
* Cancel Organization Subscription
|
|
1923
|
+
* Cancel an organization subscription.
|
|
1924
|
+
*
|
|
1925
|
+
* The subscription will remain active until the end of the current billing period.
|
|
1926
|
+
*
|
|
1927
|
+
* **Requirements:**
|
|
1928
|
+
* - User must be an OWNER of the organization
|
|
1929
|
+
*/
|
|
1930
|
+
export declare const cancelOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<CancelOrgSubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ThrowOnError, "fields">;
|
|
1931
|
+
/**
|
|
1932
|
+
* List Organization Invoices
|
|
1933
|
+
* List payment history and invoices for an organization.
|
|
1934
|
+
*
|
|
1935
|
+
* Returns past invoices with payment status, amounts, and line items.
|
|
1936
|
+
*
|
|
1937
|
+
* **Requirements:**
|
|
1938
|
+
* - User must be a member of the organization
|
|
1939
|
+
* - Full invoice details are only visible to owners and admins
|
|
1940
|
+
*/
|
|
1941
|
+
export declare const listOrgInvoices: <ThrowOnError extends boolean = false>(options: Options<ListOrgInvoicesData, ThrowOnError>) => import("./client").RequestResult<ListOrgInvoicesResponses, ListOrgInvoicesErrors, ThrowOnError, "fields">;
|
|
1942
|
+
/**
|
|
1943
|
+
* Get Organization Upcoming Invoice
|
|
1944
|
+
* Get preview of the next invoice for an organization.
|
|
1945
|
+
*
|
|
1946
|
+
* Returns estimated charges for the next billing period.
|
|
1947
|
+
*
|
|
1948
|
+
* **Requirements:**
|
|
1949
|
+
* - User must be a member of the organization
|
|
1950
|
+
* - Full invoice details are only visible to owners and admins
|
|
1951
|
+
*/
|
|
1952
|
+
export declare const getOrgUpcomingInvoice: <ThrowOnError extends boolean = false>(options: Options<GetOrgUpcomingInvoiceData, ThrowOnError>) => import("./client").RequestResult<GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, ThrowOnError, "fields">;
|
|
1802
1953
|
/**
|
|
1803
1954
|
* Create Payment Checkout Session
|
|
1804
1955
|
* Create a Stripe checkout session for collecting payment method.
|
|
1805
1956
|
*
|
|
1806
|
-
* This endpoint is used when
|
|
1957
|
+
* This endpoint is used when an organization owner needs to add a payment method before
|
|
1807
1958
|
* provisioning resources. It creates a pending subscription and redirects
|
|
1808
|
-
*
|
|
1959
|
+
* to Stripe Checkout to collect payment details.
|
|
1809
1960
|
*
|
|
1810
1961
|
* **Flow:**
|
|
1811
|
-
* 1.
|
|
1962
|
+
* 1. Owner tries to create a graph but org has no payment method
|
|
1812
1963
|
* 2. Frontend calls this endpoint with graph configuration
|
|
1813
|
-
* 3. Backend creates a subscription in PENDING_PAYMENT status
|
|
1964
|
+
* 3. Backend creates a subscription in PENDING_PAYMENT status for the user's org
|
|
1814
1965
|
* 4. Returns Stripe Checkout URL
|
|
1815
1966
|
* 5. User completes payment on Stripe
|
|
1816
1967
|
* 6. Webhook activates subscription and provisions resource
|
|
1817
1968
|
*
|
|
1818
|
-
* **
|
|
1969
|
+
* **Requirements:**
|
|
1970
|
+
* - User must be an OWNER of their organization
|
|
1971
|
+
* - Enterprise customers (with invoice_billing_enabled) should not call this endpoint.
|
|
1819
1972
|
*/
|
|
1820
1973
|
export declare const createCheckoutSession: <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionData, ThrowOnError>) => import("./client").RequestResult<CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, ThrowOnError, "fields">;
|
|
1821
1974
|
/**
|
|
@@ -1836,50 +1989,3 @@ export declare const createCheckoutSession: <ThrowOnError extends boolean = fals
|
|
|
1836
1989
|
* - For repositories: `resource_id` will be the repository name and access is immediately available
|
|
1837
1990
|
*/
|
|
1838
1991
|
export declare const getCheckoutStatus: <ThrowOnError extends boolean = false>(options: Options<GetCheckoutStatusData, ThrowOnError>) => import("./client").RequestResult<GetCheckoutStatusResponses, GetCheckoutStatusErrors, ThrowOnError, "fields">;
|
|
1839
|
-
/**
|
|
1840
|
-
* Get Customer Info
|
|
1841
|
-
* Get billing customer information including payment methods on file.
|
|
1842
|
-
*
|
|
1843
|
-
* Returns customer details, payment methods, and whether invoice billing is enabled.
|
|
1844
|
-
*/
|
|
1845
|
-
export declare const getBillingCustomer: <ThrowOnError extends boolean = false>(options?: Options<GetBillingCustomerData, ThrowOnError>) => import("./client").RequestResult<GetBillingCustomerResponses, unknown, ThrowOnError, "fields">;
|
|
1846
|
-
/**
|
|
1847
|
-
* Update Default Payment Method
|
|
1848
|
-
* Update the default payment method for the customer.
|
|
1849
|
-
*
|
|
1850
|
-
* This changes which payment method will be used for future subscription charges.
|
|
1851
|
-
*/
|
|
1852
|
-
export declare const updatePaymentMethod: <ThrowOnError extends boolean = false>(options: Options<UpdatePaymentMethodData, ThrowOnError>) => import("./client").RequestResult<UpdatePaymentMethodResponses, UpdatePaymentMethodErrors, ThrowOnError, "fields">;
|
|
1853
|
-
/**
|
|
1854
|
-
* List Invoices
|
|
1855
|
-
* List payment history and invoices.
|
|
1856
|
-
*
|
|
1857
|
-
* Returns past invoices with payment status, amounts, and line items.
|
|
1858
|
-
*/
|
|
1859
|
-
export declare const listInvoices: <ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>) => import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
1860
|
-
/**
|
|
1861
|
-
* Get Upcoming Invoice
|
|
1862
|
-
* Get preview of the next invoice.
|
|
1863
|
-
*
|
|
1864
|
-
* Returns estimated charges for the next billing period.
|
|
1865
|
-
*/
|
|
1866
|
-
export declare const getUpcomingInvoice: <ThrowOnError extends boolean = false>(options?: Options<GetUpcomingInvoiceData, ThrowOnError>) => import("./client").RequestResult<GetUpcomingInvoiceResponses, unknown, ThrowOnError, "fields">;
|
|
1867
|
-
/**
|
|
1868
|
-
* List All Subscriptions
|
|
1869
|
-
* List all active and past subscriptions for the user.
|
|
1870
|
-
*
|
|
1871
|
-
* Includes both graph and repository subscriptions with their status, pricing, and billing information.
|
|
1872
|
-
*/
|
|
1873
|
-
export declare const listSubscriptions: <ThrowOnError extends boolean = false>(options?: Options<ListSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<ListSubscriptionsResponses, unknown, ThrowOnError, "fields">;
|
|
1874
|
-
/**
|
|
1875
|
-
* Get Subscription Details
|
|
1876
|
-
* Get detailed information about a specific subscription.
|
|
1877
|
-
*/
|
|
1878
|
-
export declare const getSubscription: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionData, ThrowOnError>) => import("./client").RequestResult<GetSubscriptionResponses, GetSubscriptionErrors, ThrowOnError, "fields">;
|
|
1879
|
-
/**
|
|
1880
|
-
* Cancel Subscription
|
|
1881
|
-
* Cancel a subscription.
|
|
1882
|
-
*
|
|
1883
|
-
* The subscription will remain active until the end of the current billing period.
|
|
1884
|
-
*/
|
|
1885
|
-
export declare const cancelSubscription2: <ThrowOnError extends boolean = false>(options: Options<CancelSubscription2Data, ThrowOnError>) => import("./client").RequestResult<CancelSubscription2Responses, CancelSubscription2Errors, ThrowOnError, "fields">;
|