@robosystems/client 0.1.16 → 0.1.18
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/CopyClient.d.ts +97 -0
- package/extensions/CopyClient.js +287 -0
- package/extensions/CopyClient.ts +438 -0
- package/extensions/hooks.d.ts +36 -1
- package/extensions/hooks.js +123 -0
- package/extensions/hooks.ts +139 -0
- package/extensions/index.d.ts +7 -2
- package/extensions/index.js +15 -1
- package/extensions/index.ts +23 -1
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +182 -167
- package/sdk/sdk.gen.js +298 -355
- package/sdk/sdk.gen.ts +292 -349
- package/sdk/types.gen.d.ts +635 -512
- package/sdk/types.gen.ts +697 -588
- package/sdk-extensions/CopyClient.d.ts +97 -0
- package/sdk-extensions/CopyClient.js +287 -0
- package/sdk-extensions/CopyClient.ts +438 -0
- package/sdk-extensions/README.md +219 -0
- package/sdk-extensions/hooks.d.ts +36 -1
- package/sdk-extensions/hooks.js +123 -0
- package/sdk-extensions/hooks.ts +139 -0
- package/sdk-extensions/index.d.ts +7 -2
- package/sdk-extensions/index.js +15 -1
- package/sdk-extensions/index.ts +23 -1
- package/sdk.gen.d.ts +182 -167
- package/sdk.gen.js +298 -355
- package/sdk.gen.ts +292 -349
- package/types.gen.d.ts +635 -512
- package/types.gen.ts +697 -588
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, LogoutUserErrors, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshSessionData, RefreshSessionResponses, RefreshSessionErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoLoginData, SsoLoginResponses, SsoLoginErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors,
|
|
4
|
+
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshSessionData, RefreshSessionResponses, RefreshSessionErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoLoginData, SsoLoginResponses, SsoLoginErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, GetCurrentUserErrors, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetUserGraphsData, GetUserGraphsResponses, GetUserGraphsErrors, SelectUserGraphData, SelectUserGraphResponses, SelectUserGraphErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, ListUserApiKeysErrors, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetUserUsageErrors, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetUserUsageOverviewErrors, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, QueryFinancialAgentData, QueryFinancialAgentResponses, QueryFinancialAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, ExportBackupData, ExportBackupResponses, ExportBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaInfoData, GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ListSchemaExtensionsData, ListSchemaExtensionsResponses, ListSchemaExtensionsErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, 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, CopyDataToGraphData, CopyDataToGraphResponses, CopyDataToGraphErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } 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> & {
|
|
@@ -137,17 +137,6 @@ export const completeSsoAuth = <ThrowOnError extends boolean = false>(options: O
|
|
|
137
137
|
});
|
|
138
138
|
};
|
|
139
139
|
|
|
140
|
-
/**
|
|
141
|
-
* Get CAPTCHA Configuration
|
|
142
|
-
* Get CAPTCHA configuration including site key and whether CAPTCHA is required.
|
|
143
|
-
*/
|
|
144
|
-
export const getCaptchaConfig = <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => {
|
|
145
|
-
return (options?.client ?? _heyApiClient).get<GetCaptchaConfigResponses, unknown, ThrowOnError>({
|
|
146
|
-
url: '/v1/auth/captcha/config',
|
|
147
|
-
...options
|
|
148
|
-
});
|
|
149
|
-
};
|
|
150
|
-
|
|
151
140
|
/**
|
|
152
141
|
* Get Password Policy
|
|
153
142
|
* Get current password policy requirements for frontend validation
|
|
@@ -174,6 +163,17 @@ export const checkPasswordStrength = <ThrowOnError extends boolean = false>(opti
|
|
|
174
163
|
});
|
|
175
164
|
};
|
|
176
165
|
|
|
166
|
+
/**
|
|
167
|
+
* Get CAPTCHA Configuration
|
|
168
|
+
* Get CAPTCHA configuration including site key and whether CAPTCHA is required.
|
|
169
|
+
*/
|
|
170
|
+
export const getCaptchaConfig = <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => {
|
|
171
|
+
return (options?.client ?? _heyApiClient).get<GetCaptchaConfigResponses, unknown, ThrowOnError>({
|
|
172
|
+
url: '/v1/auth/captcha/config',
|
|
173
|
+
...options
|
|
174
|
+
});
|
|
175
|
+
};
|
|
176
|
+
|
|
177
177
|
/**
|
|
178
178
|
* Health Check
|
|
179
179
|
* Service health check endpoint for monitoring and load balancers
|
|
@@ -295,7 +295,7 @@ export const getAllCreditSummaries = <ThrowOnError extends boolean = false>(opti
|
|
|
295
295
|
type: 'http'
|
|
296
296
|
}
|
|
297
297
|
],
|
|
298
|
-
url: '/v1/user/credits
|
|
298
|
+
url: '/v1/user/credits',
|
|
299
299
|
...options
|
|
300
300
|
});
|
|
301
301
|
};
|
|
@@ -460,19 +460,11 @@ export const getUserUsage = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
460
460
|
};
|
|
461
461
|
|
|
462
462
|
/**
|
|
463
|
-
* Get shared repository
|
|
464
|
-
* Get
|
|
465
|
-
*
|
|
466
|
-
* Returns:
|
|
467
|
-
* - Current usage across different time windows
|
|
468
|
-
* - Rate limits based on subscription tier
|
|
469
|
-
* - Remaining quota
|
|
470
|
-
* - Reset times
|
|
471
|
-
*
|
|
472
|
-
* Note: All queries are FREE - this only shows rate limit status.
|
|
463
|
+
* Get all shared repository limits
|
|
464
|
+
* Get rate limit status for all shared repositories the user has access to.
|
|
473
465
|
*/
|
|
474
|
-
export const
|
|
475
|
-
return (options
|
|
466
|
+
export const getAllSharedRepositoryLimits = <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => {
|
|
467
|
+
return (options?.client ?? _heyApiClient).get<GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, ThrowOnError>({
|
|
476
468
|
security: [
|
|
477
469
|
{
|
|
478
470
|
name: 'X-API-Key',
|
|
@@ -483,17 +475,25 @@ export const getSharedRepositoryLimits = <ThrowOnError extends boolean = false>(
|
|
|
483
475
|
type: 'http'
|
|
484
476
|
}
|
|
485
477
|
],
|
|
486
|
-
url: '/v1/user/limits/shared-repositories/
|
|
478
|
+
url: '/v1/user/limits/shared-repositories/summary',
|
|
487
479
|
...options
|
|
488
480
|
});
|
|
489
481
|
};
|
|
490
482
|
|
|
491
483
|
/**
|
|
492
|
-
* Get
|
|
493
|
-
* Get rate limit status for
|
|
484
|
+
* Get shared repository rate limit status
|
|
485
|
+
* Get current rate limit status and usage for a shared repository.
|
|
486
|
+
*
|
|
487
|
+
* Returns:
|
|
488
|
+
* - Current usage across different time windows
|
|
489
|
+
* - Rate limits based on subscription tier
|
|
490
|
+
* - Remaining quota
|
|
491
|
+
* - Reset times
|
|
492
|
+
*
|
|
493
|
+
* Note: All queries are FREE - this only shows rate limit status.
|
|
494
494
|
*/
|
|
495
|
-
export const
|
|
496
|
-
return (options
|
|
495
|
+
export const getSharedRepositoryLimits = <ThrowOnError extends boolean = false>(options: Options<GetSharedRepositoryLimitsData, ThrowOnError>) => {
|
|
496
|
+
return (options.client ?? _heyApiClient).get<GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, ThrowOnError>({
|
|
497
497
|
security: [
|
|
498
498
|
{
|
|
499
499
|
name: 'X-API-Key',
|
|
@@ -504,7 +504,7 @@ export const getAllSharedRepositoryLimits = <ThrowOnError extends boolean = fals
|
|
|
504
504
|
type: 'http'
|
|
505
505
|
}
|
|
506
506
|
],
|
|
507
|
-
url: '/v1/user/limits/shared-repositories/
|
|
507
|
+
url: '/v1/user/limits/shared-repositories/{repository}',
|
|
508
508
|
...options
|
|
509
509
|
});
|
|
510
510
|
};
|
|
@@ -685,46 +685,6 @@ export const getRepositoryCredits = <ThrowOnError extends boolean = false>(optio
|
|
|
685
685
|
});
|
|
686
686
|
};
|
|
687
687
|
|
|
688
|
-
/**
|
|
689
|
-
* List Connection Options
|
|
690
|
-
* Get metadata about all available data connection providers.
|
|
691
|
-
*
|
|
692
|
-
* This endpoint returns comprehensive information about each supported provider:
|
|
693
|
-
*
|
|
694
|
-
* **SEC EDGAR**: Public entity financial filings
|
|
695
|
-
* - No authentication required (public data)
|
|
696
|
-
* - 10-K, 10-Q, 8-K reports with XBRL data
|
|
697
|
-
* - Historical and real-time filing access
|
|
698
|
-
*
|
|
699
|
-
* **QuickBooks Online**: Full accounting system integration
|
|
700
|
-
* - OAuth 2.0 authentication
|
|
701
|
-
* - Chart of accounts, transactions, trial balance
|
|
702
|
-
* - Real-time sync capabilities
|
|
703
|
-
*
|
|
704
|
-
* **Plaid**: Bank account connections
|
|
705
|
-
* - Secure bank authentication via Plaid Link
|
|
706
|
-
* - Transaction history and balances
|
|
707
|
-
* - Multi-account support
|
|
708
|
-
*
|
|
709
|
-
* No credits are consumed for viewing connection options.
|
|
710
|
-
*/
|
|
711
|
-
export const getConnectionOptions = <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => {
|
|
712
|
-
return (options.client ?? _heyApiClient).get<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError>({
|
|
713
|
-
security: [
|
|
714
|
-
{
|
|
715
|
-
name: 'X-API-Key',
|
|
716
|
-
type: 'apiKey'
|
|
717
|
-
},
|
|
718
|
-
{
|
|
719
|
-
scheme: 'bearer',
|
|
720
|
-
type: 'http'
|
|
721
|
-
}
|
|
722
|
-
],
|
|
723
|
-
url: '/v1/{graph_id}/connections/options',
|
|
724
|
-
...options
|
|
725
|
-
});
|
|
726
|
-
};
|
|
727
|
-
|
|
728
688
|
/**
|
|
729
689
|
* List Connections
|
|
730
690
|
* List all data connections in the graph.
|
|
@@ -866,6 +826,46 @@ export const getConnection = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
866
826
|
});
|
|
867
827
|
};
|
|
868
828
|
|
|
829
|
+
/**
|
|
830
|
+
* List Connection Options
|
|
831
|
+
* Get metadata about all available data connection providers.
|
|
832
|
+
*
|
|
833
|
+
* This endpoint returns comprehensive information about each supported provider:
|
|
834
|
+
*
|
|
835
|
+
* **SEC EDGAR**: Public entity financial filings
|
|
836
|
+
* - No authentication required (public data)
|
|
837
|
+
* - 10-K, 10-Q, 8-K reports with XBRL data
|
|
838
|
+
* - Historical and real-time filing access
|
|
839
|
+
*
|
|
840
|
+
* **QuickBooks Online**: Full accounting system integration
|
|
841
|
+
* - OAuth 2.0 authentication
|
|
842
|
+
* - Chart of accounts, transactions, trial balance
|
|
843
|
+
* - Real-time sync capabilities
|
|
844
|
+
*
|
|
845
|
+
* **Plaid**: Bank account connections
|
|
846
|
+
* - Secure bank authentication via Plaid Link
|
|
847
|
+
* - Transaction history and balances
|
|
848
|
+
* - Multi-account support
|
|
849
|
+
*
|
|
850
|
+
* No credits are consumed for viewing connection options.
|
|
851
|
+
*/
|
|
852
|
+
export const getConnectionOptions = <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => {
|
|
853
|
+
return (options.client ?? _heyApiClient).get<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError>({
|
|
854
|
+
security: [
|
|
855
|
+
{
|
|
856
|
+
name: 'X-API-Key',
|
|
857
|
+
type: 'apiKey'
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
scheme: 'bearer',
|
|
861
|
+
type: 'http'
|
|
862
|
+
}
|
|
863
|
+
],
|
|
864
|
+
url: '/v1/{graph_id}/connections/options',
|
|
865
|
+
...options
|
|
866
|
+
});
|
|
867
|
+
};
|
|
868
|
+
|
|
869
869
|
/**
|
|
870
870
|
* Sync Connection
|
|
871
871
|
* Trigger a data synchronization for the connection.
|
|
@@ -1230,6 +1230,27 @@ export const callMcpTool = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
1230
1230
|
});
|
|
1231
1231
|
};
|
|
1232
1232
|
|
|
1233
|
+
/**
|
|
1234
|
+
* List Kuzu graph backups
|
|
1235
|
+
* List all backups for the specified graph database
|
|
1236
|
+
*/
|
|
1237
|
+
export const listBackups = <ThrowOnError extends boolean = false>(options: Options<ListBackupsData, ThrowOnError>) => {
|
|
1238
|
+
return (options.client ?? _heyApiClient).get<ListBackupsResponses, ListBackupsErrors, ThrowOnError>({
|
|
1239
|
+
security: [
|
|
1240
|
+
{
|
|
1241
|
+
name: 'X-API-Key',
|
|
1242
|
+
type: 'apiKey'
|
|
1243
|
+
},
|
|
1244
|
+
{
|
|
1245
|
+
scheme: 'bearer',
|
|
1246
|
+
type: 'http'
|
|
1247
|
+
}
|
|
1248
|
+
],
|
|
1249
|
+
url: '/v1/{graph_id}/backups',
|
|
1250
|
+
...options
|
|
1251
|
+
});
|
|
1252
|
+
};
|
|
1253
|
+
|
|
1233
1254
|
/**
|
|
1234
1255
|
* Create Backup
|
|
1235
1256
|
* Create a backup of the graph database.
|
|
@@ -1287,7 +1308,7 @@ export const createBackup = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1287
1308
|
type: 'http'
|
|
1288
1309
|
}
|
|
1289
1310
|
],
|
|
1290
|
-
url: '/v1/{graph_id}/
|
|
1311
|
+
url: '/v1/{graph_id}/backups',
|
|
1291
1312
|
...options,
|
|
1292
1313
|
headers: {
|
|
1293
1314
|
'Content-Type': 'application/json',
|
|
@@ -1297,11 +1318,11 @@ export const createBackup = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1297
1318
|
};
|
|
1298
1319
|
|
|
1299
1320
|
/**
|
|
1300
|
-
*
|
|
1301
|
-
*
|
|
1321
|
+
* Export Kuzu backup for download
|
|
1322
|
+
* Export a backup file for download (only available for non-encrypted, compressed .kuzu backups)
|
|
1302
1323
|
*/
|
|
1303
|
-
export const
|
|
1304
|
-
return (options.client ?? _heyApiClient).
|
|
1324
|
+
export const exportBackup = <ThrowOnError extends boolean = false>(options: Options<ExportBackupData, ThrowOnError>) => {
|
|
1325
|
+
return (options.client ?? _heyApiClient).post<ExportBackupResponses, ExportBackupErrors, ThrowOnError>({
|
|
1305
1326
|
security: [
|
|
1306
1327
|
{
|
|
1307
1328
|
name: 'X-API-Key',
|
|
@@ -1312,17 +1333,17 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
1312
1333
|
type: 'http'
|
|
1313
1334
|
}
|
|
1314
1335
|
],
|
|
1315
|
-
url: '/v1/{graph_id}/
|
|
1336
|
+
url: '/v1/{graph_id}/backups/{backup_id}/export',
|
|
1316
1337
|
...options
|
|
1317
1338
|
});
|
|
1318
1339
|
};
|
|
1319
1340
|
|
|
1320
1341
|
/**
|
|
1321
|
-
*
|
|
1322
|
-
*
|
|
1342
|
+
* Get temporary download URL for backup
|
|
1343
|
+
* Generate a temporary download URL for a backup (unencrypted, compressed .kuzu files only)
|
|
1323
1344
|
*/
|
|
1324
|
-
export const
|
|
1325
|
-
return (options.client ?? _heyApiClient).
|
|
1345
|
+
export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => {
|
|
1346
|
+
return (options.client ?? _heyApiClient).get<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>({
|
|
1326
1347
|
security: [
|
|
1327
1348
|
{
|
|
1328
1349
|
name: 'X-API-Key',
|
|
@@ -1333,12 +1354,8 @@ export const exportBackup = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1333
1354
|
type: 'http'
|
|
1334
1355
|
}
|
|
1335
1356
|
],
|
|
1336
|
-
url: '/v1/{graph_id}/
|
|
1337
|
-
...options
|
|
1338
|
-
headers: {
|
|
1339
|
-
'Content-Type': 'application/json',
|
|
1340
|
-
...options.headers
|
|
1341
|
-
}
|
|
1357
|
+
url: '/v1/{graph_id}/backups/{backup_id}/download',
|
|
1358
|
+
...options
|
|
1342
1359
|
});
|
|
1343
1360
|
};
|
|
1344
1361
|
|
|
@@ -1399,7 +1416,7 @@ export const restoreBackup = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
1399
1416
|
type: 'http'
|
|
1400
1417
|
}
|
|
1401
1418
|
],
|
|
1402
|
-
url: '/v1/{graph_id}/
|
|
1419
|
+
url: '/v1/{graph_id}/backups/restore',
|
|
1403
1420
|
...options,
|
|
1404
1421
|
headers: {
|
|
1405
1422
|
'Content-Type': 'application/json',
|
|
@@ -1424,49 +1441,7 @@ export const getBackupStats = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1424
1441
|
type: 'http'
|
|
1425
1442
|
}
|
|
1426
1443
|
],
|
|
1427
|
-
url: '/v1/{graph_id}/
|
|
1428
|
-
...options
|
|
1429
|
-
});
|
|
1430
|
-
};
|
|
1431
|
-
|
|
1432
|
-
/**
|
|
1433
|
-
* Check Kuzu backup system health
|
|
1434
|
-
* Check the health status of the Kuzu backup system
|
|
1435
|
-
*/
|
|
1436
|
-
export const kuzuBackupHealth = <ThrowOnError extends boolean = false>(options: Options<KuzuBackupHealthData, ThrowOnError>) => {
|
|
1437
|
-
return (options.client ?? _heyApiClient).get<KuzuBackupHealthResponses, KuzuBackupHealthErrors, ThrowOnError>({
|
|
1438
|
-
security: [
|
|
1439
|
-
{
|
|
1440
|
-
name: 'X-API-Key',
|
|
1441
|
-
type: 'apiKey'
|
|
1442
|
-
},
|
|
1443
|
-
{
|
|
1444
|
-
scheme: 'bearer',
|
|
1445
|
-
type: 'http'
|
|
1446
|
-
}
|
|
1447
|
-
],
|
|
1448
|
-
url: '/v1/{graph_id}/backup/health',
|
|
1449
|
-
...options
|
|
1450
|
-
});
|
|
1451
|
-
};
|
|
1452
|
-
|
|
1453
|
-
/**
|
|
1454
|
-
* Get temporary download URL for backup
|
|
1455
|
-
* Generate a temporary download URL for a backup (unencrypted, compressed .kuzu files only)
|
|
1456
|
-
*/
|
|
1457
|
-
export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => {
|
|
1458
|
-
return (options.client ?? _heyApiClient).get<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>({
|
|
1459
|
-
security: [
|
|
1460
|
-
{
|
|
1461
|
-
name: 'X-API-Key',
|
|
1462
|
-
type: 'apiKey'
|
|
1463
|
-
},
|
|
1464
|
-
{
|
|
1465
|
-
scheme: 'bearer',
|
|
1466
|
-
type: 'http'
|
|
1467
|
-
}
|
|
1468
|
-
],
|
|
1469
|
-
url: '/v1/{graph_id}/backup/{backup_id}/download',
|
|
1444
|
+
url: '/v1/{graph_id}/backups/stats',
|
|
1470
1445
|
...options
|
|
1471
1446
|
});
|
|
1472
1447
|
};
|
|
@@ -1774,22 +1749,26 @@ export const getCurrentGraphBill = <ThrowOnError extends boolean = false>(option
|
|
|
1774
1749
|
};
|
|
1775
1750
|
|
|
1776
1751
|
/**
|
|
1777
|
-
* Get
|
|
1778
|
-
* Get
|
|
1752
|
+
* Get Usage Details
|
|
1753
|
+
* Get detailed usage metrics for the graph.
|
|
1779
1754
|
*
|
|
1780
|
-
*
|
|
1781
|
-
*
|
|
1782
|
-
* -
|
|
1783
|
-
* -
|
|
1784
|
-
* -
|
|
1785
|
-
* -
|
|
1755
|
+
* Provides granular usage information including:
|
|
1756
|
+
* - **Daily Credit Consumption**: Track credit usage patterns
|
|
1757
|
+
* - **Storage Growth**: Monitor database size over time
|
|
1758
|
+
* - **Operation Breakdown**: Credits by operation type
|
|
1759
|
+
* - **Peak Usage Times**: Identify high-activity periods
|
|
1760
|
+
* - **API Call Volumes**: Request counts and patterns
|
|
1786
1761
|
*
|
|
1787
|
-
*
|
|
1762
|
+
* Useful for:
|
|
1763
|
+
* - Optimizing credit consumption
|
|
1764
|
+
* - Capacity planning
|
|
1765
|
+
* - Usage trend analysis
|
|
1766
|
+
* - Cost optimization
|
|
1788
1767
|
*
|
|
1789
|
-
* ℹ️ No credits are consumed for viewing
|
|
1768
|
+
* ℹ️ No credits are consumed for viewing usage details.
|
|
1790
1769
|
*/
|
|
1791
|
-
export const
|
|
1792
|
-
return (options.client ?? _heyApiClient).get<
|
|
1770
|
+
export const getGraphUsageDetails = <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageDetailsData, ThrowOnError>) => {
|
|
1771
|
+
return (options.client ?? _heyApiClient).get<GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, ThrowOnError>({
|
|
1793
1772
|
security: [
|
|
1794
1773
|
{
|
|
1795
1774
|
name: 'X-API-Key',
|
|
@@ -1800,7 +1779,7 @@ export const getGraphMonthlyBill = <ThrowOnError extends boolean = false>(option
|
|
|
1800
1779
|
type: 'http'
|
|
1801
1780
|
}
|
|
1802
1781
|
],
|
|
1803
|
-
url: '/v1/{graph_id}/billing/
|
|
1782
|
+
url: '/v1/{graph_id}/billing/usage',
|
|
1804
1783
|
...options
|
|
1805
1784
|
});
|
|
1806
1785
|
};
|
|
@@ -1841,138 +1820,22 @@ export const getGraphBillingHistory = <ThrowOnError extends boolean = false>(opt
|
|
|
1841
1820
|
};
|
|
1842
1821
|
|
|
1843
1822
|
/**
|
|
1844
|
-
* Get
|
|
1845
|
-
* Get
|
|
1846
|
-
*
|
|
1847
|
-
* Provides granular usage information including:
|
|
1848
|
-
* - **Daily Credit Consumption**: Track credit usage patterns
|
|
1849
|
-
* - **Storage Growth**: Monitor database size over time
|
|
1850
|
-
* - **Operation Breakdown**: Credits by operation type
|
|
1851
|
-
* - **Peak Usage Times**: Identify high-activity periods
|
|
1852
|
-
* - **API Call Volumes**: Request counts and patterns
|
|
1823
|
+
* Get Monthly Bill
|
|
1824
|
+
* Get billing details for a specific month.
|
|
1853
1825
|
*
|
|
1826
|
+
* Retrieve historical billing information for any previous month.
|
|
1854
1827
|
* Useful for:
|
|
1855
|
-
* -
|
|
1856
|
-
* -
|
|
1857
|
-
* -
|
|
1858
|
-
* -
|
|
1828
|
+
* - Reconciling past charges
|
|
1829
|
+
* - Tracking usage trends
|
|
1830
|
+
* - Expense reporting
|
|
1831
|
+
* - Budget analysis
|
|
1859
1832
|
*
|
|
1860
|
-
*
|
|
1861
|
-
*/
|
|
1862
|
-
export const getGraphUsageDetails = <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageDetailsData, ThrowOnError>) => {
|
|
1863
|
-
return (options.client ?? _heyApiClient).get<GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, ThrowOnError>({
|
|
1864
|
-
security: [
|
|
1865
|
-
{
|
|
1866
|
-
name: 'X-API-Key',
|
|
1867
|
-
type: 'apiKey'
|
|
1868
|
-
},
|
|
1869
|
-
{
|
|
1870
|
-
scheme: 'bearer',
|
|
1871
|
-
type: 'http'
|
|
1872
|
-
}
|
|
1873
|
-
],
|
|
1874
|
-
url: '/v1/{graph_id}/billing/usage',
|
|
1875
|
-
...options
|
|
1876
|
-
});
|
|
1877
|
-
};
|
|
1878
|
-
|
|
1879
|
-
/**
|
|
1880
|
-
* Get Graph Pricing Info
|
|
1881
|
-
* Get pricing information for a specific graph database.
|
|
1882
|
-
*/
|
|
1883
|
-
export const getGraphPricingInfoV1GraphIdBillingPricingGet = <ThrowOnError extends boolean = false>(options: Options<GetGraphPricingInfoV1GraphIdBillingPricingGetData, ThrowOnError>) => {
|
|
1884
|
-
return (options.client ?? _heyApiClient).get<GetGraphPricingInfoV1GraphIdBillingPricingGetResponses, GetGraphPricingInfoV1GraphIdBillingPricingGetErrors, ThrowOnError>({
|
|
1885
|
-
security: [
|
|
1886
|
-
{
|
|
1887
|
-
name: 'X-API-Key',
|
|
1888
|
-
type: 'apiKey'
|
|
1889
|
-
},
|
|
1890
|
-
{
|
|
1891
|
-
scheme: 'bearer',
|
|
1892
|
-
type: 'http'
|
|
1893
|
-
}
|
|
1894
|
-
],
|
|
1895
|
-
url: '/v1/{graph_id}/billing/pricing',
|
|
1896
|
-
...options
|
|
1897
|
-
});
|
|
1898
|
-
};
|
|
1899
|
-
|
|
1900
|
-
/**
|
|
1901
|
-
* Upgrade Graph Subscription
|
|
1902
|
-
* Upgrade subscription for a specific graph database.
|
|
1903
|
-
*/
|
|
1904
|
-
export const upgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePost = <ThrowOnError extends boolean = false>(options: Options<UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostData, ThrowOnError>) => {
|
|
1905
|
-
return (options.client ?? _heyApiClient).post<UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostResponses, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostErrors, ThrowOnError>({
|
|
1906
|
-
security: [
|
|
1907
|
-
{
|
|
1908
|
-
name: 'X-API-Key',
|
|
1909
|
-
type: 'apiKey'
|
|
1910
|
-
},
|
|
1911
|
-
{
|
|
1912
|
-
scheme: 'bearer',
|
|
1913
|
-
type: 'http'
|
|
1914
|
-
}
|
|
1915
|
-
],
|
|
1916
|
-
url: '/v1/{graph_id}/billing/subscription/upgrade',
|
|
1917
|
-
...options,
|
|
1918
|
-
headers: {
|
|
1919
|
-
'Content-Type': 'application/json',
|
|
1920
|
-
...options.headers
|
|
1921
|
-
}
|
|
1922
|
-
});
|
|
1923
|
-
};
|
|
1924
|
-
|
|
1925
|
-
/**
|
|
1926
|
-
* Get Graph Subscription
|
|
1927
|
-
* Get current subscription for a graph database.
|
|
1928
|
-
*/
|
|
1929
|
-
export const getGraphSubscriptionV1GraphIdBillingSubscriptionGet = <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionV1GraphIdBillingSubscriptionGetData, ThrowOnError>) => {
|
|
1930
|
-
return (options.client ?? _heyApiClient).get<GetGraphSubscriptionV1GraphIdBillingSubscriptionGetResponses, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetErrors, ThrowOnError>({
|
|
1931
|
-
security: [
|
|
1932
|
-
{
|
|
1933
|
-
name: 'X-API-Key',
|
|
1934
|
-
type: 'apiKey'
|
|
1935
|
-
},
|
|
1936
|
-
{
|
|
1937
|
-
scheme: 'bearer',
|
|
1938
|
-
type: 'http'
|
|
1939
|
-
}
|
|
1940
|
-
],
|
|
1941
|
-
url: '/v1/{graph_id}/billing/subscription',
|
|
1942
|
-
...options
|
|
1943
|
-
});
|
|
1944
|
-
};
|
|
1945
|
-
|
|
1946
|
-
/**
|
|
1947
|
-
* Get Available Subscription Plans
|
|
1948
|
-
* Get available subscription plans for upgrade.
|
|
1949
|
-
*/
|
|
1950
|
-
export const getAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGet = <ThrowOnError extends boolean = false>(options: Options<GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetData, ThrowOnError>) => {
|
|
1951
|
-
return (options.client ?? _heyApiClient).get<GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetResponses, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetErrors, ThrowOnError>({
|
|
1952
|
-
security: [
|
|
1953
|
-
{
|
|
1954
|
-
name: 'X-API-Key',
|
|
1955
|
-
type: 'apiKey'
|
|
1956
|
-
},
|
|
1957
|
-
{
|
|
1958
|
-
scheme: 'bearer',
|
|
1959
|
-
type: 'http'
|
|
1960
|
-
}
|
|
1961
|
-
],
|
|
1962
|
-
url: '/v1/{graph_id}/billing/available-plans',
|
|
1963
|
-
...options
|
|
1964
|
-
});
|
|
1965
|
-
};
|
|
1966
|
-
|
|
1967
|
-
/**
|
|
1968
|
-
* Get Credit Billing Info
|
|
1969
|
-
* Get credit-based billing information for a specific graph.
|
|
1833
|
+
* Returns the same detailed breakdown as the current bill endpoint.
|
|
1970
1834
|
*
|
|
1971
|
-
*
|
|
1972
|
-
* without consuming credits (for billing transparency).
|
|
1835
|
+
* ℹ️ No credits are consumed for viewing billing history.
|
|
1973
1836
|
*/
|
|
1974
|
-
export const
|
|
1975
|
-
return (options.client ?? _heyApiClient).get<
|
|
1837
|
+
export const getGraphMonthlyBill = <ThrowOnError extends boolean = false>(options: Options<GetGraphMonthlyBillData, ThrowOnError>) => {
|
|
1838
|
+
return (options.client ?? _heyApiClient).get<GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, ThrowOnError>({
|
|
1976
1839
|
security: [
|
|
1977
1840
|
{
|
|
1978
1841
|
name: 'X-API-Key',
|
|
@@ -1983,7 +1846,7 @@ export const getCreditBillingInfoV1GraphIdBillingCreditsGet = <ThrowOnError exte
|
|
|
1983
1846
|
type: 'http'
|
|
1984
1847
|
}
|
|
1985
1848
|
],
|
|
1986
|
-
url: '/v1/{graph_id}/billing/
|
|
1849
|
+
url: '/v1/{graph_id}/billing/history/{year}/{month}',
|
|
1987
1850
|
...options
|
|
1988
1851
|
});
|
|
1989
1852
|
};
|
|
@@ -2067,7 +1930,7 @@ export const listCreditTransactions = <ThrowOnError extends boolean = false>(opt
|
|
|
2067
1930
|
* No credits are consumed for checking availability.
|
|
2068
1931
|
*/
|
|
2069
1932
|
export const checkCreditBalance = <ThrowOnError extends boolean = false>(options: Options<CheckCreditBalanceData, ThrowOnError>) => {
|
|
2070
|
-
return (options.client ?? _heyApiClient).
|
|
1933
|
+
return (options.client ?? _heyApiClient).get<CheckCreditBalanceResponses, CheckCreditBalanceErrors, ThrowOnError>({
|
|
2071
1934
|
security: [
|
|
2072
1935
|
{
|
|
2073
1936
|
name: 'X-API-Key',
|
|
@@ -2078,12 +1941,8 @@ export const checkCreditBalance = <ThrowOnError extends boolean = false>(options
|
|
|
2078
1941
|
type: 'http'
|
|
2079
1942
|
}
|
|
2080
1943
|
],
|
|
2081
|
-
url: '/v1/{graph_id}/credits/check',
|
|
2082
|
-
...options
|
|
2083
|
-
headers: {
|
|
2084
|
-
'Content-Type': 'application/json',
|
|
2085
|
-
...options.headers
|
|
2086
|
-
}
|
|
1944
|
+
url: '/v1/{graph_id}/credits/balance/check',
|
|
1945
|
+
...options
|
|
2087
1946
|
});
|
|
2088
1947
|
};
|
|
2089
1948
|
|
|
@@ -2179,7 +2038,7 @@ export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options:
|
|
|
2179
2038
|
type: 'http'
|
|
2180
2039
|
}
|
|
2181
2040
|
],
|
|
2182
|
-
url: '/v1/{graph_id}/
|
|
2041
|
+
url: '/v1/{graph_id}/health',
|
|
2183
2042
|
...options
|
|
2184
2043
|
});
|
|
2185
2044
|
};
|
|
@@ -2217,7 +2076,40 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
2217
2076
|
type: 'http'
|
|
2218
2077
|
}
|
|
2219
2078
|
],
|
|
2220
|
-
url: '/v1/{graph_id}/
|
|
2079
|
+
url: '/v1/{graph_id}/info',
|
|
2080
|
+
...options
|
|
2081
|
+
});
|
|
2082
|
+
};
|
|
2083
|
+
|
|
2084
|
+
/**
|
|
2085
|
+
* Get Graph Operational Limits
|
|
2086
|
+
* Get comprehensive operational limits for the graph database.
|
|
2087
|
+
*
|
|
2088
|
+
* Returns all operational limits that apply to this graph including:
|
|
2089
|
+
* - **Storage Limits**: Maximum storage size and current usage
|
|
2090
|
+
* - **Query Limits**: Timeouts, complexity, row limits
|
|
2091
|
+
* - **Copy/Ingestion Limits**: File sizes, timeouts, concurrent operations
|
|
2092
|
+
* - **Backup Limits**: Frequency, retention, size limits
|
|
2093
|
+
* - **Rate Limits**: Requests per minute/hour based on tier
|
|
2094
|
+
* - **Credit Limits**: AI operation credits (if applicable)
|
|
2095
|
+
*
|
|
2096
|
+
* This unified endpoint provides all limits in one place for easier client integration.
|
|
2097
|
+
*
|
|
2098
|
+
* **Note**: Limits vary based on subscription tier (Standard, Enterprise, Premium).
|
|
2099
|
+
*/
|
|
2100
|
+
export const getGraphLimits = <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => {
|
|
2101
|
+
return (options.client ?? _heyApiClient).get<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError>({
|
|
2102
|
+
security: [
|
|
2103
|
+
{
|
|
2104
|
+
name: 'X-API-Key',
|
|
2105
|
+
type: 'apiKey'
|
|
2106
|
+
},
|
|
2107
|
+
{
|
|
2108
|
+
scheme: 'bearer',
|
|
2109
|
+
type: 'http'
|
|
2110
|
+
}
|
|
2111
|
+
],
|
|
2112
|
+
url: '/v1/{graph_id}/limits',
|
|
2221
2113
|
...options
|
|
2222
2114
|
});
|
|
2223
2115
|
};
|
|
@@ -2227,19 +2119,13 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
2227
2119
|
* List all subgraphs for a parent graph.
|
|
2228
2120
|
*
|
|
2229
2121
|
* **Requirements:**
|
|
2230
|
-
* -
|
|
2122
|
+
* - Valid authentication
|
|
2123
|
+
* - Parent graph must exist and be accessible to the user
|
|
2124
|
+
* - User must have at least 'read' permission on the parent graph
|
|
2231
2125
|
*
|
|
2232
|
-
* **
|
|
2233
|
-
* - List of all subgraphs
|
|
2234
|
-
* -
|
|
2235
|
-
* - Size and statistics per subgraph
|
|
2236
|
-
* - Creation timestamps
|
|
2237
|
-
*
|
|
2238
|
-
* **Filtering:**
|
|
2239
|
-
* Currently returns all subgraphs. Future versions will support:
|
|
2240
|
-
* - Filtering by status
|
|
2241
|
-
* - Filtering by creation date
|
|
2242
|
-
* - Pagination for large lists
|
|
2126
|
+
* **Returns:**
|
|
2127
|
+
* - List of all subgraphs for the parent graph
|
|
2128
|
+
* - Each subgraph includes its ID, name, description, type, status, and creation date
|
|
2243
2129
|
*/
|
|
2244
2130
|
export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => {
|
|
2245
2131
|
return (options.client ?? _heyApiClient).get<ListSubgraphsResponses, ListSubgraphsErrors, ThrowOnError>({
|
|
@@ -2259,43 +2145,19 @@ export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2259
2145
|
};
|
|
2260
2146
|
|
|
2261
2147
|
/**
|
|
2262
|
-
* Create
|
|
2263
|
-
* Create a new subgraph
|
|
2148
|
+
* Create Subgraph
|
|
2149
|
+
* Create a new subgraph within a parent graph.
|
|
2264
2150
|
*
|
|
2265
2151
|
* **Requirements:**
|
|
2266
|
-
* -
|
|
2267
|
-
* -
|
|
2268
|
-
* -
|
|
2269
|
-
* -
|
|
2270
|
-
*
|
|
2271
|
-
*
|
|
2272
|
-
* - Shares parent's infrastructure (no additional cost)
|
|
2273
|
-
* - Inherits parent's credit pool
|
|
2274
|
-
* - Isolated database on same instance
|
|
2275
|
-
* - Full Kuzu database capabilities
|
|
2276
|
-
*
|
|
2277
|
-
* **Use Cases:**
|
|
2278
|
-
* - Separate environments (dev/staging/prod)
|
|
2279
|
-
* - Department-specific data isolation
|
|
2280
|
-
* - Multi-tenant applications
|
|
2281
|
-
* - Testing and experimentation
|
|
2282
|
-
*
|
|
2283
|
-
* **Schema Inheritance:**
|
|
2284
|
-
* - Subgraphs can use parent's schema or custom extensions
|
|
2285
|
-
* - Extensions are additive only
|
|
2286
|
-
* - Base schema always included
|
|
2287
|
-
*
|
|
2288
|
-
* **Limits:**
|
|
2289
|
-
* - Standard: Not supported (0 subgraphs)
|
|
2290
|
-
* - Enterprise: Configurable limit (default: 10 subgraphs)
|
|
2291
|
-
* - Premium: Unlimited subgraphs
|
|
2292
|
-
* - Limits are defined in deployment configuration
|
|
2152
|
+
* - Valid authentication
|
|
2153
|
+
* - Parent graph must exist and be accessible to the user
|
|
2154
|
+
* - User must have 'admin' permission on the parent graph
|
|
2155
|
+
* - Parent graph tier must support subgraphs (Enterprise or Premium only)
|
|
2156
|
+
* - Must be within subgraph quota limits
|
|
2157
|
+
* - Subgraph name must be unique within the parent graph
|
|
2293
2158
|
*
|
|
2294
|
-
* **
|
|
2295
|
-
* -
|
|
2296
|
-
* - `parent_graph_id`: Parent graph ID
|
|
2297
|
-
* - `subgraph_name`: Short name within parent
|
|
2298
|
-
* - `status`: Creation status
|
|
2159
|
+
* **Returns:**
|
|
2160
|
+
* - Created subgraph details including its unique ID
|
|
2299
2161
|
*/
|
|
2300
2162
|
export const createSubgraph = <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => {
|
|
2301
2163
|
return (options.client ?? _heyApiClient).post<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError>({
|
|
@@ -2351,7 +2213,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2351
2213
|
type: 'http'
|
|
2352
2214
|
}
|
|
2353
2215
|
],
|
|
2354
|
-
url: '/v1/{graph_id}/subgraphs/{
|
|
2216
|
+
url: '/v1/{graph_id}/subgraphs/{subgraph_id}',
|
|
2355
2217
|
...options,
|
|
2356
2218
|
headers: {
|
|
2357
2219
|
'Content-Type': 'application/json',
|
|
@@ -2360,6 +2222,45 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2360
2222
|
});
|
|
2361
2223
|
};
|
|
2362
2224
|
|
|
2225
|
+
/**
|
|
2226
|
+
* Get Subgraph Details
|
|
2227
|
+
* Get detailed information about a specific subgraph.
|
|
2228
|
+
*
|
|
2229
|
+
* **Requirements:**
|
|
2230
|
+
* - User must have read access to parent graph
|
|
2231
|
+
*
|
|
2232
|
+
* **Response includes:**
|
|
2233
|
+
* - Full subgraph metadata
|
|
2234
|
+
* - Database statistics (nodes, edges)
|
|
2235
|
+
* - Size information
|
|
2236
|
+
* - Schema configuration
|
|
2237
|
+
* - Creation/modification timestamps
|
|
2238
|
+
* - Last access time (when available)
|
|
2239
|
+
*
|
|
2240
|
+
* **Statistics:**
|
|
2241
|
+
* Real-time statistics queried from Kuzu:
|
|
2242
|
+
* - Node count
|
|
2243
|
+
* - Edge count
|
|
2244
|
+
* - Database size on disk
|
|
2245
|
+
* - Schema information
|
|
2246
|
+
*/
|
|
2247
|
+
export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => {
|
|
2248
|
+
return (options.client ?? _heyApiClient).get<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError>({
|
|
2249
|
+
security: [
|
|
2250
|
+
{
|
|
2251
|
+
name: 'X-API-Key',
|
|
2252
|
+
type: 'apiKey'
|
|
2253
|
+
},
|
|
2254
|
+
{
|
|
2255
|
+
scheme: 'bearer',
|
|
2256
|
+
type: 'http'
|
|
2257
|
+
}
|
|
2258
|
+
],
|
|
2259
|
+
url: '/v1/{graph_id}/subgraphs/{subgraph_id}/info',
|
|
2260
|
+
...options
|
|
2261
|
+
});
|
|
2262
|
+
};
|
|
2263
|
+
|
|
2363
2264
|
/**
|
|
2364
2265
|
* Get Subgraph Quota
|
|
2365
2266
|
* Get subgraph quota and usage information for a parent graph.
|
|
@@ -2398,29 +2299,67 @@ export const getSubgraphQuota = <ThrowOnError extends boolean = false>(options:
|
|
|
2398
2299
|
};
|
|
2399
2300
|
|
|
2400
2301
|
/**
|
|
2401
|
-
*
|
|
2402
|
-
*
|
|
2302
|
+
* Copy Data to Graph
|
|
2303
|
+
* Copy data from external sources into the graph database.
|
|
2403
2304
|
*
|
|
2404
|
-
*
|
|
2405
|
-
* -
|
|
2305
|
+
* This endpoint supports multiple data sources through a unified interface:
|
|
2306
|
+
* - **S3**: Copy from S3 buckets with user-provided credentials
|
|
2307
|
+
* - **URL** (future): Copy from HTTP(S) URLs
|
|
2308
|
+
* - **DataFrame** (future): Copy from uploaded DataFrames
|
|
2406
2309
|
*
|
|
2407
|
-
* **
|
|
2408
|
-
* -
|
|
2409
|
-
* -
|
|
2410
|
-
* -
|
|
2411
|
-
* -
|
|
2412
|
-
* - Creation/modification timestamps
|
|
2413
|
-
* - Last access time (when available)
|
|
2310
|
+
* **Security:**
|
|
2311
|
+
* - Requires write permissions to the target graph
|
|
2312
|
+
* - **Not allowed on shared repositories** (sec, industry, economic) - these are read-only
|
|
2313
|
+
* - User must provide their own AWS credentials for S3 access
|
|
2314
|
+
* - All operations are logged for audit purposes
|
|
2414
2315
|
*
|
|
2415
|
-
* **
|
|
2416
|
-
*
|
|
2417
|
-
* -
|
|
2418
|
-
* -
|
|
2419
|
-
*
|
|
2420
|
-
*
|
|
2316
|
+
* **Tier Limits:**
|
|
2317
|
+
* - Standard: 10GB max file size, 15 min timeout
|
|
2318
|
+
* - Enterprise: 50GB max file size, 30 min timeout
|
|
2319
|
+
* - Premium: 100GB max file size, 60 min timeout
|
|
2320
|
+
*
|
|
2321
|
+
* **Copy Options:**
|
|
2322
|
+
* - `ignore_errors`: Skip duplicate/invalid rows (enables upsert-like behavior). Note: When enabled, row counts may not be accurately reported
|
|
2323
|
+
* - `extended_timeout`: Use extended timeout for large datasets
|
|
2324
|
+
* - `validate_schema`: Validate source schema against target table
|
|
2325
|
+
*
|
|
2326
|
+
* **Asynchronous Execution with SSE:**
|
|
2327
|
+
* For large data imports, this endpoint returns immediately with an operation ID
|
|
2328
|
+
* and SSE monitoring endpoint. Connect to the returned stream URL for real-time updates:
|
|
2329
|
+
*
|
|
2330
|
+
* ```javascript
|
|
2331
|
+
* const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
|
|
2332
|
+
* eventSource.onmessage = (event) => {
|
|
2333
|
+
* const data = JSON.parse(event.data);
|
|
2334
|
+
* console.log('Progress:', data.message);
|
|
2335
|
+
* };
|
|
2336
|
+
* ```
|
|
2337
|
+
*
|
|
2338
|
+
* **SSE Events Emitted:**
|
|
2339
|
+
* - `operation_started`: Copy operation begins
|
|
2340
|
+
* - `operation_progress`: Progress updates during data transfer
|
|
2341
|
+
* - `operation_completed`: Copy successful with statistics
|
|
2342
|
+
* - `operation_error`: Copy failed with error details
|
|
2343
|
+
*
|
|
2344
|
+
* **SSE Connection Limits:**
|
|
2345
|
+
* - Maximum 5 concurrent SSE connections per user
|
|
2346
|
+
* - Rate limited to 10 new connections per minute
|
|
2347
|
+
* - Automatic circuit breaker for Redis failures
|
|
2348
|
+
* - Graceful degradation if event system unavailable
|
|
2349
|
+
*
|
|
2350
|
+
* **Error Handling:**
|
|
2351
|
+
* - `403 Forbidden`: Attempted copy to shared repository
|
|
2352
|
+
* - `408 Request Timeout`: Operation exceeded timeout limit
|
|
2353
|
+
* - `429 Too Many Requests`: Rate limit exceeded
|
|
2354
|
+
* - `503 Service Unavailable`: Circuit breaker open or service unavailable
|
|
2355
|
+
* - Clients should implement exponential backoff on errors
|
|
2356
|
+
*
|
|
2357
|
+
* **Note:**
|
|
2358
|
+
* Copy operations are FREE - no credit consumption required.
|
|
2359
|
+
* All copy operations are performed asynchronously with progress monitoring.
|
|
2421
2360
|
*/
|
|
2422
|
-
export const
|
|
2423
|
-
return (options.client ?? _heyApiClient).
|
|
2361
|
+
export const copyDataToGraph = <ThrowOnError extends boolean = false>(options: Options<CopyDataToGraphData, ThrowOnError>) => {
|
|
2362
|
+
return (options.client ?? _heyApiClient).post<CopyDataToGraphResponses, CopyDataToGraphErrors, ThrowOnError>({
|
|
2424
2363
|
security: [
|
|
2425
2364
|
{
|
|
2426
2365
|
name: 'X-API-Key',
|
|
@@ -2431,8 +2370,12 @@ export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
2431
2370
|
type: 'http'
|
|
2432
2371
|
}
|
|
2433
2372
|
],
|
|
2434
|
-
url: '/v1/{graph_id}/
|
|
2435
|
-
...options
|
|
2373
|
+
url: '/v1/{graph_id}/copy',
|
|
2374
|
+
...options,
|
|
2375
|
+
headers: {
|
|
2376
|
+
'Content-Type': 'application/json',
|
|
2377
|
+
...options.headers
|
|
2378
|
+
}
|
|
2436
2379
|
});
|
|
2437
2380
|
};
|
|
2438
2381
|
|