@robosystems/client 0.2.12 → 0.2.14
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/index.d.ts +1 -0
- package/extensions/index.js +1 -0
- package/extensions/index.ts +1 -0
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +110 -20
- package/sdk/sdk.gen.js +116 -46
- package/sdk/sdk.gen.ts +115 -45
- package/sdk/types.gen.d.ts +41 -101
- package/sdk/types.gen.ts +42 -109
- package/sdk-extensions/index.d.ts +1 -0
- package/sdk-extensions/index.js +1 -0
- package/sdk-extensions/index.ts +1 -0
- package/sdk.gen.d.ts +110 -20
- package/sdk.gen.js +116 -46
- package/sdk.gen.ts +115 -45
- package/types.gen.d.ts +41 -101
- package/types.gen.ts +42 -109
package/extensions/index.d.ts
CHANGED
|
@@ -43,6 +43,7 @@ export * from './AgentClient';
|
|
|
43
43
|
export * from './SSEClient';
|
|
44
44
|
export * from './TableIngestClient';
|
|
45
45
|
export * from './GraphClient';
|
|
46
|
+
export * from './config';
|
|
46
47
|
export { OperationClient, QueryClient, AgentClient, SSEClient, TableIngestClient, GraphClient };
|
|
47
48
|
export { useMultipleOperations, useOperation, useQuery, useSDKClients, useStreamingQuery, useTableUpload, } from './hooks';
|
|
48
49
|
export declare const extensions: {
|
package/extensions/index.js
CHANGED
|
@@ -116,6 +116,7 @@ __exportStar(require("./AgentClient"), exports);
|
|
|
116
116
|
__exportStar(require("./SSEClient"), exports);
|
|
117
117
|
__exportStar(require("./TableIngestClient"), exports);
|
|
118
118
|
__exportStar(require("./GraphClient"), exports);
|
|
119
|
+
__exportStar(require("./config"), exports);
|
|
119
120
|
// Export React hooks
|
|
120
121
|
var hooks_1 = require("./hooks");
|
|
121
122
|
Object.defineProperty(exports, "useMultipleOperations", { enumerable: true, get: function () { return hooks_1.useMultipleOperations; } });
|
package/extensions/index.ts
CHANGED
|
@@ -131,6 +131,7 @@ export * from './AgentClient'
|
|
|
131
131
|
export * from './SSEClient'
|
|
132
132
|
export * from './TableIngestClient'
|
|
133
133
|
export * from './GraphClient'
|
|
134
|
+
export * from './config'
|
|
134
135
|
export { OperationClient, QueryClient, AgentClient, SSEClient, TableIngestClient, GraphClient }
|
|
135
136
|
|
|
136
137
|
// Export React hooks
|
package/package.json
CHANGED
package/sdk/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, 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,
|
|
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, 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, CreatePortalSessionData, CreatePortalSessionResponses, CreatePortalSessionErrors, 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
|
|
@@ -457,6 +457,13 @@ export declare const listAgents: <ThrowOnError extends boolean = false>(options:
|
|
|
457
457
|
* - Leverage conversation history for contextual understanding
|
|
458
458
|
* - Enable RAG for knowledge base enrichment
|
|
459
459
|
*
|
|
460
|
+
* **Subgraph Support:**
|
|
461
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
462
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
463
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
464
|
+
* Agents operate on the specified graph/subgraph's data independently. RAG enrichment
|
|
465
|
+
* and knowledge base search are scoped to the specific graph/subgraph.
|
|
466
|
+
*
|
|
460
467
|
* See request/response examples in the "Examples" dropdown below.
|
|
461
468
|
*/
|
|
462
469
|
export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
|
|
@@ -545,6 +552,13 @@ export declare const recommendAgent: <ThrowOnError extends boolean = false>(opti
|
|
|
545
552
|
* - User permissions and subscription tier
|
|
546
553
|
* - Backend capabilities (Kuzu, Neo4j, etc.)
|
|
547
554
|
*
|
|
555
|
+
* **Subgraph Support:**
|
|
556
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
557
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
558
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
559
|
+
* The returned tool list is identical for parent graphs and subgraphs, as all
|
|
560
|
+
* MCP tools work uniformly across graph boundaries.
|
|
561
|
+
*
|
|
548
562
|
* **Note:**
|
|
549
563
|
* MCP tool listing is included - no credit consumption required.
|
|
550
564
|
*/
|
|
@@ -583,6 +597,13 @@ export declare const listMcpTools: <ThrowOnError extends boolean = false>(option
|
|
|
583
597
|
* - `408 Request Timeout`: Tool execution exceeded timeout
|
|
584
598
|
* - Clients should implement exponential backoff on errors
|
|
585
599
|
*
|
|
600
|
+
* **Subgraph Support:**
|
|
601
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
602
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
603
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
604
|
+
* MCP tools operate on the specified graph/subgraph independently. Each subgraph
|
|
605
|
+
* has its own schema, data, and can be queried separately via MCP.
|
|
606
|
+
*
|
|
586
607
|
* **Credit Model:**
|
|
587
608
|
* MCP tool execution is included - no credit consumption required. Database
|
|
588
609
|
* operations (queries, schema inspection, analytics) are completely free.
|
|
@@ -850,6 +871,12 @@ export declare const getGraphUsageAnalytics: <ThrowOnError extends boolean = fal
|
|
|
850
871
|
* - `503 Service Unavailable`: Circuit breaker open or SSE disabled
|
|
851
872
|
* - Clients should implement exponential backoff
|
|
852
873
|
*
|
|
874
|
+
* **Subgraph Support:**
|
|
875
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
876
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
877
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
878
|
+
* Subgraphs share the same instance as their parent graph and have independent data.
|
|
879
|
+
*
|
|
853
880
|
* **Note:**
|
|
854
881
|
* Query operations are included - no credit consumption required.
|
|
855
882
|
* Queue position is based on subscription tier for priority.
|
|
@@ -892,6 +919,14 @@ export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(
|
|
|
892
919
|
* Property discovery is limited to 10 properties per node type for performance.
|
|
893
920
|
* For complete schema definitions, use `/schema/export`.
|
|
894
921
|
*
|
|
922
|
+
* ## Subgraph Support
|
|
923
|
+
*
|
|
924
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
925
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
926
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
927
|
+
* Each subgraph has independent schema and data. The returned schema reflects
|
|
928
|
+
* only the specified graph/subgraph's actual structure.
|
|
929
|
+
*
|
|
895
930
|
* This operation is included - no credit consumption required.
|
|
896
931
|
*/
|
|
897
932
|
export declare const getGraphSchema: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaResponses, GetGraphSchemaErrors, ThrowOnError, "fields">;
|
|
@@ -969,6 +1004,13 @@ export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(o
|
|
|
969
1004
|
* - Performance problems
|
|
970
1005
|
* - Naming conflicts
|
|
971
1006
|
*
|
|
1007
|
+
* **Subgraph Support:**
|
|
1008
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1009
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1010
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1011
|
+
* Schema validation is performed against the specified graph/subgraph's current
|
|
1012
|
+
* schema and data structure.
|
|
1013
|
+
*
|
|
972
1014
|
* This operation is included - no credit consumption required.
|
|
973
1015
|
*/
|
|
974
1016
|
export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
|
|
@@ -1065,6 +1107,13 @@ export declare const checkStorageLimits: <ThrowOnError extends boolean = false>(
|
|
|
1065
1107
|
* - **Resource Usage**: Memory and storage consumption
|
|
1066
1108
|
* - **Alerts**: Active warnings or issues
|
|
1067
1109
|
*
|
|
1110
|
+
* **Subgraph Support:**
|
|
1111
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1112
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1113
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1114
|
+
* Health metrics are specific to the requested graph/subgraph. Subgraphs share the
|
|
1115
|
+
* same physical instance as their parent but have independent health indicators.
|
|
1116
|
+
*
|
|
1068
1117
|
* This endpoint provides essential monitoring data for operational visibility.
|
|
1069
1118
|
*/
|
|
1070
1119
|
export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseHealthResponses, GetDatabaseHealthErrors, ThrowOnError, "fields">;
|
|
@@ -1087,6 +1136,13 @@ export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(o
|
|
|
1087
1136
|
* - **Backup Status**: Backup availability and recency
|
|
1088
1137
|
* - **Timestamps**: Creation and modification dates
|
|
1089
1138
|
*
|
|
1139
|
+
* **Subgraph Support:**
|
|
1140
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1141
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1142
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1143
|
+
* Returned metrics are specific to the requested graph/subgraph. Subgraphs have
|
|
1144
|
+
* independent size, node/relationship counts, and backup status.
|
|
1145
|
+
*
|
|
1090
1146
|
* This endpoint provides essential database information for capacity planning and monitoring.
|
|
1091
1147
|
*/
|
|
1092
1148
|
export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError, "fields">;
|
|
@@ -1104,7 +1160,7 @@ export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(opt
|
|
|
1104
1160
|
*
|
|
1105
1161
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
1106
1162
|
*
|
|
1107
|
-
* **Note**: Limits vary based on subscription tier (
|
|
1163
|
+
* **Note**: Limits vary based on subscription tier (kuzu-standard, kuzu-large, kuzu-xlarge).
|
|
1108
1164
|
*/
|
|
1109
1165
|
export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => import("./client").RequestResult<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError, "fields">;
|
|
1110
1166
|
/**
|
|
@@ -1129,12 +1185,18 @@ export declare const listSubgraphs: <ThrowOnError extends boolean = false>(optio
|
|
|
1129
1185
|
* - Valid authentication
|
|
1130
1186
|
* - Parent graph must exist and be accessible to the user
|
|
1131
1187
|
* - User must have 'admin' permission on the parent graph
|
|
1132
|
-
* - Parent graph tier must support subgraphs (
|
|
1188
|
+
* - Parent graph tier must support subgraphs (Kuzu Large/XLarge or Neo4j Enterprise XLarge)
|
|
1133
1189
|
* - Must be within subgraph quota limits
|
|
1134
1190
|
* - Subgraph name must be unique within the parent graph
|
|
1135
1191
|
*
|
|
1136
1192
|
* **Returns:**
|
|
1137
1193
|
* - Created subgraph details including its unique ID
|
|
1194
|
+
* - Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
1195
|
+
*
|
|
1196
|
+
* **Usage:**
|
|
1197
|
+
* - Subgraphs share parent's credit pool
|
|
1198
|
+
* - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
|
|
1199
|
+
* - Permissions inherited from parent graph
|
|
1138
1200
|
*/
|
|
1139
1201
|
export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => import("./client").RequestResult<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError, "fields">;
|
|
1140
1202
|
/**
|
|
@@ -1144,6 +1206,7 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1144
1206
|
* **Requirements:**
|
|
1145
1207
|
* - Must be a valid subgraph (not parent graph)
|
|
1146
1208
|
* - User must have admin access to parent graph
|
|
1209
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
1147
1210
|
* - Optional backup before deletion
|
|
1148
1211
|
*
|
|
1149
1212
|
* **Deletion Options:**
|
|
@@ -1155,8 +1218,13 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1155
1218
|
* All data in the subgraph will be lost.
|
|
1156
1219
|
*
|
|
1157
1220
|
* **Backup Location:**
|
|
1158
|
-
* If backup requested, stored in S3 at:
|
|
1159
|
-
* `s3://
|
|
1221
|
+
* If backup requested, stored in S3 Kuzu database bucket at:
|
|
1222
|
+
* `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
1223
|
+
*
|
|
1224
|
+
* **Notes:**
|
|
1225
|
+
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
1226
|
+
* - Deletion does not affect parent graph's credit pool or permissions
|
|
1227
|
+
* - Backup creation consumes credits from parent graph's allocation
|
|
1160
1228
|
*/
|
|
1161
1229
|
export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => import("./client").RequestResult<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError, "fields">;
|
|
1162
1230
|
/**
|
|
@@ -1165,6 +1233,7 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1165
1233
|
*
|
|
1166
1234
|
* **Requirements:**
|
|
1167
1235
|
* - User must have read access to parent graph
|
|
1236
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
1168
1237
|
*
|
|
1169
1238
|
* **Response includes:**
|
|
1170
1239
|
* - Full subgraph metadata
|
|
@@ -1180,6 +1249,10 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1180
1249
|
* - Edge count
|
|
1181
1250
|
* - Database size on disk
|
|
1182
1251
|
* - Schema information
|
|
1252
|
+
*
|
|
1253
|
+
* **Note:**
|
|
1254
|
+
* Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
1255
|
+
* The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
1183
1256
|
*/
|
|
1184
1257
|
export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError, "fields">;
|
|
1185
1258
|
/**
|
|
@@ -1203,16 +1276,6 @@ export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(opt
|
|
|
1203
1276
|
* Individual subgraph sizes shown in list endpoint.
|
|
1204
1277
|
*/
|
|
1205
1278
|
export declare const getSubgraphQuota: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError, "fields">;
|
|
1206
|
-
/**
|
|
1207
|
-
* Cancel Subscription
|
|
1208
|
-
* Cancel a subscription.
|
|
1209
|
-
*
|
|
1210
|
-
* For shared repositories: Cancels the user's personal subscription
|
|
1211
|
-
* For user graphs: Not allowed - delete the graph instead
|
|
1212
|
-
*
|
|
1213
|
-
* The subscription will be marked as canceled and will end at the current period end date.
|
|
1214
|
-
*/
|
|
1215
|
-
export declare const cancelSubscription: <ThrowOnError extends boolean = false>(options: Options<CancelSubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelSubscriptionResponses, CancelSubscriptionErrors, ThrowOnError, "fields">;
|
|
1216
1279
|
/**
|
|
1217
1280
|
* Get Subscription
|
|
1218
1281
|
* Get subscription details for a graph or shared repository.
|
|
@@ -1347,6 +1410,13 @@ export declare const listTableFiles: <ThrowOnError extends boolean = false>(opti
|
|
|
1347
1410
|
* Tables are automatically created on first file upload with type inferred from name
|
|
1348
1411
|
* (e.g., "Transaction" → relationship) and empty schema populated during ingestion.
|
|
1349
1412
|
*
|
|
1413
|
+
* **Subgraph Support:**
|
|
1414
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1415
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1416
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1417
|
+
* Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
|
|
1418
|
+
* to one subgraph do not appear in other subgraphs.
|
|
1419
|
+
*
|
|
1350
1420
|
* **Important Notes:**
|
|
1351
1421
|
* - Presigned URLs expire (default: 1 hour)
|
|
1352
1422
|
* - Use appropriate Content-Type header when uploading to S3
|
|
@@ -1466,7 +1536,7 @@ export declare const updateFileStatus: <ThrowOnError extends boolean = false>(op
|
|
|
1466
1536
|
* 2. Files are validated and marked as 'uploaded'
|
|
1467
1537
|
* 3. Trigger ingestion: `POST /tables/ingest`
|
|
1468
1538
|
* 4. DuckDB staging tables created from S3 patterns
|
|
1469
|
-
* 5. Data copied
|
|
1539
|
+
* 5. Data copied from DuckDB to Kuzu
|
|
1470
1540
|
* 6. Per-table results and metrics returned
|
|
1471
1541
|
*
|
|
1472
1542
|
* **Rebuild Feature:**
|
|
@@ -1497,6 +1567,13 @@ export declare const updateFileStatus: <ThrowOnError extends boolean = false>(op
|
|
|
1497
1567
|
* you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
1498
1568
|
* the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
|
|
1499
1569
|
*
|
|
1570
|
+
* **Subgraph Support:**
|
|
1571
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1572
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1573
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1574
|
+
* Each subgraph has independent staging tables and graph data. Ingestion operates
|
|
1575
|
+
* on the specified graph/subgraph only and does not affect other subgraphs.
|
|
1576
|
+
*
|
|
1500
1577
|
* **Important Notes:**
|
|
1501
1578
|
* - Only files with 'uploaded' status are processed
|
|
1502
1579
|
* - Tables with no uploaded files are skipped
|
|
@@ -1553,6 +1630,12 @@ export declare const ingestTables: <ThrowOnError extends boolean = false>(option
|
|
|
1553
1630
|
* - Read-only: No INSERT, UPDATE, DELETE
|
|
1554
1631
|
* - User's tables only: Cannot query other users' data
|
|
1555
1632
|
*
|
|
1633
|
+
* **Subgraph Support:**
|
|
1634
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1635
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1636
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1637
|
+
* Each subgraph has its own independent staging tables.
|
|
1638
|
+
*
|
|
1556
1639
|
* **Shared Repositories:**
|
|
1557
1640
|
* Shared repositories (SEC, etc.) do not allow direct SQL queries.
|
|
1558
1641
|
* Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
|
|
@@ -1891,15 +1974,22 @@ export declare const cancelOperation: <ThrowOnError extends boolean = false>(opt
|
|
|
1891
1974
|
*/
|
|
1892
1975
|
export declare const getOrgBillingCustomer: <ThrowOnError extends boolean = false>(options: Options<GetOrgBillingCustomerData, ThrowOnError>) => import("./client").RequestResult<GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, ThrowOnError, "fields">;
|
|
1893
1976
|
/**
|
|
1894
|
-
*
|
|
1895
|
-
*
|
|
1977
|
+
* Create Customer Portal Session
|
|
1978
|
+
* Create a Stripe Customer Portal session for managing payment methods.
|
|
1979
|
+
*
|
|
1980
|
+
* The portal allows users to:
|
|
1981
|
+
* - Add new payment methods
|
|
1982
|
+
* - Remove existing payment methods
|
|
1983
|
+
* - Update default payment method
|
|
1984
|
+
* - View billing history
|
|
1896
1985
|
*
|
|
1897
|
-
*
|
|
1986
|
+
* The user will be redirected to Stripe's hosted portal page and returned to the billing page when done.
|
|
1898
1987
|
*
|
|
1899
1988
|
* **Requirements:**
|
|
1900
1989
|
* - User must be an OWNER of the organization
|
|
1990
|
+
* - Organization must have a Stripe customer ID (i.e., has gone through checkout at least once)
|
|
1901
1991
|
*/
|
|
1902
|
-
export declare const
|
|
1992
|
+
export declare const createPortalSession: <ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>) => import("./client").RequestResult<CreatePortalSessionResponses, CreatePortalSessionErrors, ThrowOnError, "fields">;
|
|
1903
1993
|
/**
|
|
1904
1994
|
* List Organization Subscriptions
|
|
1905
1995
|
* List all active and past subscriptions for an organization.
|