@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/sdk/sdk.gen.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
3
  import type { Options as ClientOptions, TDataShape, Client } from './client';
4
- 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';
4
+ 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';
5
5
  import { client as _heyApiClient } from './client.gen';
6
6
 
7
7
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -1116,6 +1116,13 @@ export const listAgents = <ThrowOnError extends boolean = false>(options: Option
1116
1116
  * - Leverage conversation history for contextual understanding
1117
1117
  * - Enable RAG for knowledge base enrichment
1118
1118
  *
1119
+ * **Subgraph Support:**
1120
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1121
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1122
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1123
+ * Agents operate on the specified graph/subgraph's data independently. RAG enrichment
1124
+ * and knowledge base search are scoped to the specific graph/subgraph.
1125
+ *
1119
1126
  * See request/response examples in the "Examples" dropdown below.
1120
1127
  */
1121
1128
  export const autoSelectAgent = <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => {
@@ -1300,6 +1307,13 @@ export const recommendAgent = <ThrowOnError extends boolean = false>(options: Op
1300
1307
  * - User permissions and subscription tier
1301
1308
  * - Backend capabilities (Kuzu, Neo4j, etc.)
1302
1309
  *
1310
+ * **Subgraph Support:**
1311
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1312
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1313
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1314
+ * The returned tool list is identical for parent graphs and subgraphs, as all
1315
+ * MCP tools work uniformly across graph boundaries.
1316
+ *
1303
1317
  * **Note:**
1304
1318
  * MCP tool listing is included - no credit consumption required.
1305
1319
  */
@@ -1354,6 +1368,13 @@ export const listMcpTools = <ThrowOnError extends boolean = false>(options: Opti
1354
1368
  * - `408 Request Timeout`: Tool execution exceeded timeout
1355
1369
  * - Clients should implement exponential backoff on errors
1356
1370
  *
1371
+ * **Subgraph Support:**
1372
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1373
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1374
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1375
+ * MCP tools operate on the specified graph/subgraph independently. Each subgraph
1376
+ * has its own schema, data, and can be queried separately via MCP.
1377
+ *
1357
1378
  * **Credit Model:**
1358
1379
  * MCP tool execution is included - no credit consumption required. Database
1359
1380
  * operations (queries, schema inspection, analytics) are completely free.
@@ -1761,6 +1782,12 @@ export const getGraphUsageAnalytics = <ThrowOnError extends boolean = false>(opt
1761
1782
  * - `503 Service Unavailable`: Circuit breaker open or SSE disabled
1762
1783
  * - Clients should implement exponential backoff
1763
1784
  *
1785
+ * **Subgraph Support:**
1786
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1787
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1788
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1789
+ * Subgraphs share the same instance as their parent graph and have independent data.
1790
+ *
1764
1791
  * **Note:**
1765
1792
  * Query operations are included - no credit consumption required.
1766
1793
  * Queue position is based on subscription tier for priority.
@@ -1823,6 +1850,14 @@ export const executeCypherQuery = <ThrowOnError extends boolean = false>(options
1823
1850
  * Property discovery is limited to 10 properties per node type for performance.
1824
1851
  * For complete schema definitions, use `/schema/export`.
1825
1852
  *
1853
+ * ## Subgraph Support
1854
+ *
1855
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1856
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1857
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1858
+ * Each subgraph has independent schema and data. The returned schema reflects
1859
+ * only the specified graph/subgraph's actual structure.
1860
+ *
1826
1861
  * This operation is included - no credit consumption required.
1827
1862
  */
1828
1863
  export const getGraphSchema = <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => {
@@ -1932,6 +1967,13 @@ export const exportGraphSchema = <ThrowOnError extends boolean = false>(options:
1932
1967
  * - Performance problems
1933
1968
  * - Naming conflicts
1934
1969
  *
1970
+ * **Subgraph Support:**
1971
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1972
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1973
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1974
+ * Schema validation is performed against the specified graph/subgraph's current
1975
+ * schema and data structure.
1976
+ *
1935
1977
  * This operation is included - no credit consumption required.
1936
1978
  */
1937
1979
  export const validateSchema = <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => {
@@ -2128,6 +2170,13 @@ export const checkStorageLimits = <ThrowOnError extends boolean = false>(options
2128
2170
  * - **Resource Usage**: Memory and storage consumption
2129
2171
  * - **Alerts**: Active warnings or issues
2130
2172
  *
2173
+ * **Subgraph Support:**
2174
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
2175
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
2176
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
2177
+ * Health metrics are specific to the requested graph/subgraph. Subgraphs share the
2178
+ * same physical instance as their parent but have independent health indicators.
2179
+ *
2131
2180
  * This endpoint provides essential monitoring data for operational visibility.
2132
2181
  */
2133
2182
  export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => {
@@ -2166,6 +2215,13 @@ export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options:
2166
2215
  * - **Backup Status**: Backup availability and recency
2167
2216
  * - **Timestamps**: Creation and modification dates
2168
2217
  *
2218
+ * **Subgraph Support:**
2219
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
2220
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
2221
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
2222
+ * Returned metrics are specific to the requested graph/subgraph. Subgraphs have
2223
+ * independent size, node/relationship counts, and backup status.
2224
+ *
2169
2225
  * This endpoint provides essential database information for capacity planning and monitoring.
2170
2226
  */
2171
2227
  export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => {
@@ -2199,7 +2255,7 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
2199
2255
  *
2200
2256
  * This unified endpoint provides all limits in one place for easier client integration.
2201
2257
  *
2202
- * **Note**: Limits vary based on subscription tier (Standard, Enterprise, Premium).
2258
+ * **Note**: Limits vary based on subscription tier (kuzu-standard, kuzu-large, kuzu-xlarge).
2203
2259
  */
2204
2260
  export const getGraphLimits = <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => {
2205
2261
  return (options.client ?? _heyApiClient).get<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError>({
@@ -2256,12 +2312,18 @@ export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Opt
2256
2312
  * - Valid authentication
2257
2313
  * - Parent graph must exist and be accessible to the user
2258
2314
  * - User must have 'admin' permission on the parent graph
2259
- * - Parent graph tier must support subgraphs (Enterprise or Premium only)
2315
+ * - Parent graph tier must support subgraphs (Kuzu Large/XLarge or Neo4j Enterprise XLarge)
2260
2316
  * - Must be within subgraph quota limits
2261
2317
  * - Subgraph name must be unique within the parent graph
2262
2318
  *
2263
2319
  * **Returns:**
2264
2320
  * - Created subgraph details including its unique ID
2321
+ * - Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
2322
+ *
2323
+ * **Usage:**
2324
+ * - Subgraphs share parent's credit pool
2325
+ * - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
2326
+ * - Permissions inherited from parent graph
2265
2327
  */
2266
2328
  export const createSubgraph = <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => {
2267
2329
  return (options.client ?? _heyApiClient).post<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError>({
@@ -2291,6 +2353,7 @@ export const createSubgraph = <ThrowOnError extends boolean = false>(options: Op
2291
2353
  * **Requirements:**
2292
2354
  * - Must be a valid subgraph (not parent graph)
2293
2355
  * - User must have admin access to parent graph
2356
+ * - Subgraph name must be alphanumeric (1-20 characters)
2294
2357
  * - Optional backup before deletion
2295
2358
  *
2296
2359
  * **Deletion Options:**
@@ -2302,8 +2365,13 @@ export const createSubgraph = <ThrowOnError extends boolean = false>(options: Op
2302
2365
  * All data in the subgraph will be lost.
2303
2366
  *
2304
2367
  * **Backup Location:**
2305
- * If backup requested, stored in S3 at:
2306
- * `s3://robosystems-backups/{instance_id}/{database_name}_{timestamp}.backup`
2368
+ * If backup requested, stored in S3 Kuzu database bucket at:
2369
+ * `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
2370
+ *
2371
+ * **Notes:**
2372
+ * - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
2373
+ * - Deletion does not affect parent graph's credit pool or permissions
2374
+ * - Backup creation consumes credits from parent graph's allocation
2307
2375
  */
2308
2376
  export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => {
2309
2377
  return (options.client ?? _heyApiClient).delete<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError>({
@@ -2317,7 +2385,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
2317
2385
  type: 'http'
2318
2386
  }
2319
2387
  ],
2320
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}',
2388
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}',
2321
2389
  ...options,
2322
2390
  headers: {
2323
2391
  'Content-Type': 'application/json',
@@ -2332,6 +2400,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
2332
2400
  *
2333
2401
  * **Requirements:**
2334
2402
  * - User must have read access to parent graph
2403
+ * - Subgraph name must be alphanumeric (1-20 characters)
2335
2404
  *
2336
2405
  * **Response includes:**
2337
2406
  * - Full subgraph metadata
@@ -2347,6 +2416,10 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
2347
2416
  * - Edge count
2348
2417
  * - Database size on disk
2349
2418
  * - Schema information
2419
+ *
2420
+ * **Note:**
2421
+ * Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
2422
+ * The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
2350
2423
  */
2351
2424
  export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => {
2352
2425
  return (options.client ?? _heyApiClient).get<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError>({
@@ -2360,7 +2433,7 @@ export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: O
2360
2433
  type: 'http'
2361
2434
  }
2362
2435
  ],
2363
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}/info',
2436
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info',
2364
2437
  ...options
2365
2438
  });
2366
2439
  };
@@ -2402,32 +2475,6 @@ export const getSubgraphQuota = <ThrowOnError extends boolean = false>(options:
2402
2475
  });
2403
2476
  };
2404
2477
 
2405
- /**
2406
- * Cancel Subscription
2407
- * Cancel a subscription.
2408
- *
2409
- * For shared repositories: Cancels the user's personal subscription
2410
- * For user graphs: Not allowed - delete the graph instead
2411
- *
2412
- * The subscription will be marked as canceled and will end at the current period end date.
2413
- */
2414
- export const cancelSubscription = <ThrowOnError extends boolean = false>(options: Options<CancelSubscriptionData, ThrowOnError>) => {
2415
- return (options.client ?? _heyApiClient).delete<CancelSubscriptionResponses, CancelSubscriptionErrors, ThrowOnError>({
2416
- security: [
2417
- {
2418
- name: 'X-API-Key',
2419
- type: 'apiKey'
2420
- },
2421
- {
2422
- scheme: 'bearer',
2423
- type: 'http'
2424
- }
2425
- ],
2426
- url: '/v1/graphs/{graph_id}/subscriptions',
2427
- ...options
2428
- });
2429
- };
2430
-
2431
2478
  /**
2432
2479
  * Get Subscription
2433
2480
  * Get subscription details for a graph or shared repository.
@@ -2650,6 +2697,13 @@ export const listTableFiles = <ThrowOnError extends boolean = false>(options: Op
2650
2697
  * Tables are automatically created on first file upload with type inferred from name
2651
2698
  * (e.g., "Transaction" → relationship) and empty schema populated during ingestion.
2652
2699
  *
2700
+ * **Subgraph Support:**
2701
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
2702
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
2703
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
2704
+ * Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
2705
+ * to one subgraph do not appear in other subgraphs.
2706
+ *
2653
2707
  * **Important Notes:**
2654
2708
  * - Presigned URLs expire (default: 1 hour)
2655
2709
  * - Use appropriate Content-Type header when uploading to S3
@@ -2841,7 +2895,7 @@ export const updateFileStatus = <ThrowOnError extends boolean = false>(options:
2841
2895
  * 2. Files are validated and marked as 'uploaded'
2842
2896
  * 3. Trigger ingestion: `POST /tables/ingest`
2843
2897
  * 4. DuckDB staging tables created from S3 patterns
2844
- * 5. Data copied row-by-row from DuckDB to Kuzu
2898
+ * 5. Data copied from DuckDB to Kuzu
2845
2899
  * 6. Per-table results and metrics returned
2846
2900
  *
2847
2901
  * **Rebuild Feature:**
@@ -2872,6 +2926,13 @@ export const updateFileStatus = <ThrowOnError extends boolean = false>(options:
2872
2926
  * you'll receive a 409 Conflict error. The distributed lock automatically expires after
2873
2927
  * the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
2874
2928
  *
2929
+ * **Subgraph Support:**
2930
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
2931
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
2932
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
2933
+ * Each subgraph has independent staging tables and graph data. Ingestion operates
2934
+ * on the specified graph/subgraph only and does not affect other subgraphs.
2935
+ *
2875
2936
  * **Important Notes:**
2876
2937
  * - Only files with 'uploaded' status are processed
2877
2938
  * - Tables with no uploaded files are skipped
@@ -2948,6 +3009,12 @@ export const ingestTables = <ThrowOnError extends boolean = false>(options: Opti
2948
3009
  * - Read-only: No INSERT, UPDATE, DELETE
2949
3010
  * - User's tables only: Cannot query other users' data
2950
3011
  *
3012
+ * **Subgraph Support:**
3013
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
3014
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
3015
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
3016
+ * Each subgraph has its own independent staging tables.
3017
+ *
2951
3018
  * **Shared Repositories:**
2952
3019
  * Shared repositories (SEC, etc.) do not allow direct SQL queries.
2953
3020
  * Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
@@ -3460,16 +3527,23 @@ export const getOrgBillingCustomer = <ThrowOnError extends boolean = false>(opti
3460
3527
  };
3461
3528
 
3462
3529
  /**
3463
- * Update Organization Default Payment Method
3464
- * Update the default payment method for the organization.
3530
+ * Create Customer Portal Session
3531
+ * Create a Stripe Customer Portal session for managing payment methods.
3465
3532
  *
3466
- * This changes which payment method will be used for future subscription charges.
3533
+ * The portal allows users to:
3534
+ * - Add new payment methods
3535
+ * - Remove existing payment methods
3536
+ * - Update default payment method
3537
+ * - View billing history
3538
+ *
3539
+ * The user will be redirected to Stripe's hosted portal page and returned to the billing page when done.
3467
3540
  *
3468
3541
  * **Requirements:**
3469
3542
  * - User must be an OWNER of the organization
3543
+ * - Organization must have a Stripe customer ID (i.e., has gone through checkout at least once)
3470
3544
  */
3471
- export const updateOrgPaymentMethod = <ThrowOnError extends boolean = false>(options: Options<UpdateOrgPaymentMethodData, ThrowOnError>) => {
3472
- return (options.client ?? _heyApiClient).post<UpdateOrgPaymentMethodResponses, UpdateOrgPaymentMethodErrors, ThrowOnError>({
3545
+ export const createPortalSession = <ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>) => {
3546
+ return (options.client ?? _heyApiClient).post<CreatePortalSessionResponses, CreatePortalSessionErrors, ThrowOnError>({
3473
3547
  security: [
3474
3548
  {
3475
3549
  name: 'X-API-Key',
@@ -3480,12 +3554,8 @@ export const updateOrgPaymentMethod = <ThrowOnError extends boolean = false>(opt
3480
3554
  type: 'http'
3481
3555
  }
3482
3556
  ],
3483
- url: '/v1/billing/customer/{org_id}/payment-method',
3484
- ...options,
3485
- headers: {
3486
- 'Content-Type': 'application/json',
3487
- ...options.headers
3488
- }
3557
+ url: '/v1/billing/customer/{org_id}/portal',
3558
+ ...options
3489
3559
  });
3490
3560
  };
3491
3561
 
@@ -813,27 +813,6 @@ export type BulkIngestResponse = {
813
813
  */
814
814
  results: Array<TableIngestResult>;
815
815
  };
816
- /**
817
- * CancellationResponse
818
- * Response for subscription cancellation.
819
- */
820
- export type CancellationResponse = {
821
- /**
822
- * Message
823
- * Cancellation confirmation message
824
- */
825
- message: string;
826
- /**
827
- * Subscription Id
828
- * ID of the cancelled subscription
829
- */
830
- subscription_id: string;
831
- /**
832
- * Cancelled At
833
- * Cancellation timestamp (ISO format)
834
- */
835
- cancelled_at: string;
836
- };
837
816
  /**
838
817
  * CheckoutResponse
839
818
  * Response from checkout session creation.
@@ -1223,7 +1202,7 @@ export type CreateSubgraphRequest = {
1223
1202
  * Schema Extensions
1224
1203
  * Schema extensions to include (inherits from parent by default)
1225
1204
  */
1226
- schema_extensions?: Array<string> | null;
1205
+ schema_extensions?: Array<string>;
1227
1206
  /**
1228
1207
  * Type of subgraph (currently only 'static' is supported)
1229
1208
  */
@@ -2199,6 +2178,11 @@ export type GraphSubscriptionResponse = {
2199
2178
  * Cancellation date
2200
2179
  */
2201
2180
  canceled_at?: string | null;
2181
+ /**
2182
+ * Ends At
2183
+ * Subscription end date (when access will be revoked, especially relevant for cancelled subscriptions)
2184
+ */
2185
+ ends_at?: string | null;
2202
2186
  /**
2203
2187
  * Created At
2204
2188
  * Creation timestamp
@@ -2817,6 +2801,11 @@ export type ListSubgraphsResponse = {
2817
2801
  * Parent graph tier
2818
2802
  */
2819
2803
  parent_graph_tier: string;
2804
+ /**
2805
+ * Subgraphs Enabled
2806
+ * Whether subgraphs are enabled for this tier (requires Kuzu Large/XLarge or Neo4j Enterprise XLarge)
2807
+ */
2808
+ subgraphs_enabled: boolean;
2820
2809
  /**
2821
2810
  * Subgraph Count
2822
2811
  * Total number of subgraphs
@@ -3411,17 +3400,17 @@ export type PaymentMethod = {
3411
3400
  brand?: string | null;
3412
3401
  /**
3413
3402
  * Last4
3414
- * Last 4 digits
3403
+ * Last 4 digits of the card or account number
3415
3404
  */
3416
3405
  last4?: string | null;
3417
3406
  /**
3418
3407
  * Exp Month
3419
- * Expiration month
3408
+ * Expiration month of the card
3420
3409
  */
3421
3410
  exp_month?: number | null;
3422
3411
  /**
3423
3412
  * Exp Year
3424
- * Expiration year
3413
+ * Expiration year of the card
3425
3414
  */
3426
3415
  exp_year?: number | null;
3427
3416
  /**
@@ -3500,6 +3489,17 @@ export type PlaidConnectionConfig = {
3500
3489
  [key: string]: unknown;
3501
3490
  }> | null;
3502
3491
  };
3492
+ /**
3493
+ * PortalSessionResponse
3494
+ * Response for customer portal session creation.
3495
+ */
3496
+ export type PortalSessionResponse = {
3497
+ /**
3498
+ * Portal Url
3499
+ * Stripe Customer Portal URL where user can manage payment methods
3500
+ */
3501
+ portal_url: string;
3502
+ };
3503
3503
  /**
3504
3504
  * QueryLimits
3505
3505
  * Query operation limits.
@@ -4568,32 +4568,6 @@ export type UpdatePasswordRequest = {
4568
4568
  */
4569
4569
  confirm_password: string;
4570
4570
  };
4571
- /**
4572
- * UpdatePaymentMethodRequest
4573
- * Request to update default payment method.
4574
- */
4575
- export type UpdatePaymentMethodRequest = {
4576
- /**
4577
- * Payment Method Id
4578
- * Payment method ID to set as default
4579
- */
4580
- payment_method_id: string;
4581
- };
4582
- /**
4583
- * UpdatePaymentMethodResponse
4584
- * Response for payment method update.
4585
- */
4586
- export type UpdatePaymentMethodResponse = {
4587
- /**
4588
- * Message
4589
- * Success message
4590
- */
4591
- message: string;
4592
- /**
4593
- * Updated payment method
4594
- */
4595
- payment_method: PaymentMethod;
4596
- };
4597
4571
  /**
4598
4572
  * UpdateUserRequest
4599
4573
  * Request model for updating user profile.
@@ -7133,13 +7107,13 @@ export type DeleteSubgraphData = {
7133
7107
  */
7134
7108
  graph_id: string;
7135
7109
  /**
7136
- * Subgraph Id
7137
- * Subgraph identifier to delete
7110
+ * Subgraph Name
7111
+ * Subgraph name to delete (e.g., 'dev', 'staging')
7138
7112
  */
7139
- subgraph_id: string;
7113
+ subgraph_name: string;
7140
7114
  };
7141
7115
  query?: never;
7142
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}';
7116
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}';
7143
7117
  };
7144
7118
  export type DeleteSubgraphErrors = {
7145
7119
  /**
@@ -7187,13 +7161,13 @@ export type GetSubgraphInfoData = {
7187
7161
  */
7188
7162
  graph_id: string;
7189
7163
  /**
7190
- * Subgraph Id
7191
- * Subgraph identifier
7164
+ * Subgraph Name
7165
+ * Subgraph name (e.g., 'dev', 'staging')
7192
7166
  */
7193
- subgraph_id: string;
7167
+ subgraph_name: string;
7194
7168
  };
7195
7169
  query?: never;
7196
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}/info';
7170
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info';
7197
7171
  };
7198
7172
  export type GetSubgraphInfoErrors = {
7199
7173
  /**
@@ -7270,40 +7244,6 @@ export type GetSubgraphQuotaResponses = {
7270
7244
  200: SubgraphQuotaResponse;
7271
7245
  };
7272
7246
  export type GetSubgraphQuotaResponse = GetSubgraphQuotaResponses[keyof GetSubgraphQuotaResponses];
7273
- export type CancelSubscriptionData = {
7274
- body?: never;
7275
- path: {
7276
- /**
7277
- * Graph Id
7278
- * Graph ID or repository name
7279
- */
7280
- graph_id: string;
7281
- };
7282
- query?: never;
7283
- url: '/v1/graphs/{graph_id}/subscriptions';
7284
- };
7285
- export type CancelSubscriptionErrors = {
7286
- /**
7287
- * Cannot cancel graph subscriptions directly
7288
- */
7289
- 400: unknown;
7290
- /**
7291
- * No subscription found
7292
- */
7293
- 404: unknown;
7294
- /**
7295
- * Validation Error
7296
- */
7297
- 422: HttpValidationError;
7298
- };
7299
- export type CancelSubscriptionError = CancelSubscriptionErrors[keyof CancelSubscriptionErrors];
7300
- export type CancelSubscriptionResponses = {
7301
- /**
7302
- * Subscription canceled successfully
7303
- */
7304
- 200: CancellationResponse;
7305
- };
7306
- export type CancelSubscriptionResponse = CancelSubscriptionResponses[keyof CancelSubscriptionResponses];
7307
7247
  export type GetGraphSubscriptionData = {
7308
7248
  body?: never;
7309
7249
  path: {
@@ -8094,8 +8034,8 @@ export type GetOrgBillingCustomerResponses = {
8094
8034
  200: BillingCustomer;
8095
8035
  };
8096
8036
  export type GetOrgBillingCustomerResponse = GetOrgBillingCustomerResponses[keyof GetOrgBillingCustomerResponses];
8097
- export type UpdateOrgPaymentMethodData = {
8098
- body: UpdatePaymentMethodRequest;
8037
+ export type CreatePortalSessionData = {
8038
+ body?: never;
8099
8039
  path: {
8100
8040
  /**
8101
8041
  * Org Id
@@ -8103,22 +8043,22 @@ export type UpdateOrgPaymentMethodData = {
8103
8043
  org_id: string;
8104
8044
  };
8105
8045
  query?: never;
8106
- url: '/v1/billing/customer/{org_id}/payment-method';
8046
+ url: '/v1/billing/customer/{org_id}/portal';
8107
8047
  };
8108
- export type UpdateOrgPaymentMethodErrors = {
8048
+ export type CreatePortalSessionErrors = {
8109
8049
  /**
8110
8050
  * Validation Error
8111
8051
  */
8112
8052
  422: HttpValidationError;
8113
8053
  };
8114
- export type UpdateOrgPaymentMethodError = UpdateOrgPaymentMethodErrors[keyof UpdateOrgPaymentMethodErrors];
8115
- export type UpdateOrgPaymentMethodResponses = {
8054
+ export type CreatePortalSessionError = CreatePortalSessionErrors[keyof CreatePortalSessionErrors];
8055
+ export type CreatePortalSessionResponses = {
8116
8056
  /**
8117
8057
  * Successful Response
8118
8058
  */
8119
- 200: UpdatePaymentMethodResponse;
8059
+ 200: PortalSessionResponse;
8120
8060
  };
8121
- export type UpdateOrgPaymentMethodResponse = UpdateOrgPaymentMethodResponses[keyof UpdateOrgPaymentMethodResponses];
8061
+ export type CreatePortalSessionResponse = CreatePortalSessionResponses[keyof CreatePortalSessionResponses];
8122
8062
  export type ListOrgSubscriptionsData = {
8123
8063
  body?: never;
8124
8064
  path: {