@robosystems/client 0.2.7 → 0.2.9
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/package.json +1 -1
- package/sdk/sdk.gen.d.ts +92 -186
- package/sdk/sdk.gen.js +165 -451
- package/sdk/sdk.gen.ts +165 -451
- package/sdk/types.gen.d.ts +397 -968
- package/sdk/types.gen.ts +595 -1227
- package/sdk.gen.d.ts +92 -186
- package/sdk.gen.js +165 -451
- package/sdk.gen.ts +165 -451
- package/types.gen.d.ts +397 -968
- package/types.gen.ts +595 -1227
package/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,
|
|
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, GetUserLimitsData, GetUserLimitsResponses, 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, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, 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 } 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> & {
|
|
@@ -283,33 +283,6 @@ export const updateUser = <ThrowOnError extends boolean = false>(options: Option
|
|
|
283
283
|
});
|
|
284
284
|
};
|
|
285
285
|
|
|
286
|
-
/**
|
|
287
|
-
* Get All Credit Summaries
|
|
288
|
-
* Get credit summaries for all graphs owned by the user.
|
|
289
|
-
*
|
|
290
|
-
* This endpoint provides a consolidated view of credit usage across
|
|
291
|
-
* all graphs where the user has access, helping to monitor overall
|
|
292
|
-
* credit consumption and plan usage.
|
|
293
|
-
*
|
|
294
|
-
* No credits are consumed for viewing summaries.
|
|
295
|
-
*/
|
|
296
|
-
export const getAllCreditSummaries = <ThrowOnError extends boolean = false>(options?: Options<GetAllCreditSummariesData, ThrowOnError>) => {
|
|
297
|
-
return (options?.client ?? _heyApiClient).get<GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, ThrowOnError>({
|
|
298
|
-
security: [
|
|
299
|
-
{
|
|
300
|
-
name: 'X-API-Key',
|
|
301
|
-
type: 'apiKey'
|
|
302
|
-
},
|
|
303
|
-
{
|
|
304
|
-
scheme: 'bearer',
|
|
305
|
-
type: 'http'
|
|
306
|
-
}
|
|
307
|
-
],
|
|
308
|
-
url: '/v1/user/credits',
|
|
309
|
-
...options
|
|
310
|
-
});
|
|
311
|
-
};
|
|
312
|
-
|
|
313
286
|
/**
|
|
314
287
|
* Update Password
|
|
315
288
|
* Update the current user's password.
|
|
@@ -428,11 +401,11 @@ export const updateUserApiKey = <ThrowOnError extends boolean = false>(options:
|
|
|
428
401
|
};
|
|
429
402
|
|
|
430
403
|
/**
|
|
431
|
-
* Get user limits
|
|
432
|
-
* Retrieve current limits and
|
|
404
|
+
* Get user limits and usage
|
|
405
|
+
* Retrieve current limits and usage statistics for the authenticated user (simple safety valve for graph creation)
|
|
433
406
|
*/
|
|
434
407
|
export const getUserLimits = <ThrowOnError extends boolean = false>(options?: Options<GetUserLimitsData, ThrowOnError>) => {
|
|
435
|
-
return (options?.client ?? _heyApiClient).get<GetUserLimitsResponses,
|
|
408
|
+
return (options?.client ?? _heyApiClient).get<GetUserLimitsResponses, unknown, ThrowOnError>({
|
|
436
409
|
security: [
|
|
437
410
|
{
|
|
438
411
|
name: 'X-API-Key',
|
|
@@ -448,253 +421,6 @@ export const getUserLimits = <ThrowOnError extends boolean = false>(options?: Op
|
|
|
448
421
|
});
|
|
449
422
|
};
|
|
450
423
|
|
|
451
|
-
/**
|
|
452
|
-
* Get user usage statistics
|
|
453
|
-
* Retrieve current usage statistics and remaining limits for the authenticated user
|
|
454
|
-
*/
|
|
455
|
-
export const getUserUsage = <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageData, ThrowOnError>) => {
|
|
456
|
-
return (options?.client ?? _heyApiClient).get<GetUserUsageResponses, unknown, ThrowOnError>({
|
|
457
|
-
security: [
|
|
458
|
-
{
|
|
459
|
-
name: 'X-API-Key',
|
|
460
|
-
type: 'apiKey'
|
|
461
|
-
},
|
|
462
|
-
{
|
|
463
|
-
scheme: 'bearer',
|
|
464
|
-
type: 'http'
|
|
465
|
-
}
|
|
466
|
-
],
|
|
467
|
-
url: '/v1/user/limits/usage',
|
|
468
|
-
...options
|
|
469
|
-
});
|
|
470
|
-
};
|
|
471
|
-
|
|
472
|
-
/**
|
|
473
|
-
* Get all shared repository limits
|
|
474
|
-
* Get rate limit status for all shared repositories the user has access to.
|
|
475
|
-
*/
|
|
476
|
-
export const getAllSharedRepositoryLimits = <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => {
|
|
477
|
-
return (options?.client ?? _heyApiClient).get<GetAllSharedRepositoryLimitsResponses, unknown, ThrowOnError>({
|
|
478
|
-
security: [
|
|
479
|
-
{
|
|
480
|
-
name: 'X-API-Key',
|
|
481
|
-
type: 'apiKey'
|
|
482
|
-
},
|
|
483
|
-
{
|
|
484
|
-
scheme: 'bearer',
|
|
485
|
-
type: 'http'
|
|
486
|
-
}
|
|
487
|
-
],
|
|
488
|
-
url: '/v1/user/limits/shared-repositories/summary',
|
|
489
|
-
...options
|
|
490
|
-
});
|
|
491
|
-
};
|
|
492
|
-
|
|
493
|
-
/**
|
|
494
|
-
* Get shared repository rate limit status
|
|
495
|
-
* Get current rate limit status and usage for a shared repository.
|
|
496
|
-
*
|
|
497
|
-
* Returns:
|
|
498
|
-
* - Current usage across different time windows
|
|
499
|
-
* - Rate limits based on subscription tier
|
|
500
|
-
* - Remaining quota
|
|
501
|
-
* - Reset times
|
|
502
|
-
*
|
|
503
|
-
* Note: All queries are included - this only shows rate limit status.
|
|
504
|
-
*/
|
|
505
|
-
export const getSharedRepositoryLimits = <ThrowOnError extends boolean = false>(options: Options<GetSharedRepositoryLimitsData, ThrowOnError>) => {
|
|
506
|
-
return (options.client ?? _heyApiClient).get<GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, ThrowOnError>({
|
|
507
|
-
security: [
|
|
508
|
-
{
|
|
509
|
-
name: 'X-API-Key',
|
|
510
|
-
type: 'apiKey'
|
|
511
|
-
},
|
|
512
|
-
{
|
|
513
|
-
scheme: 'bearer',
|
|
514
|
-
type: 'http'
|
|
515
|
-
}
|
|
516
|
-
],
|
|
517
|
-
url: '/v1/user/limits/shared-repositories/{repository}',
|
|
518
|
-
...options
|
|
519
|
-
});
|
|
520
|
-
};
|
|
521
|
-
|
|
522
|
-
/**
|
|
523
|
-
* Get User Usage Overview
|
|
524
|
-
* Get a high-level overview of usage statistics for the current user.
|
|
525
|
-
*/
|
|
526
|
-
export const getUserUsageOverview = <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageOverviewData, ThrowOnError>) => {
|
|
527
|
-
return (options?.client ?? _heyApiClient).get<GetUserUsageOverviewResponses, unknown, ThrowOnError>({
|
|
528
|
-
security: [
|
|
529
|
-
{
|
|
530
|
-
name: 'X-API-Key',
|
|
531
|
-
type: 'apiKey'
|
|
532
|
-
},
|
|
533
|
-
{
|
|
534
|
-
scheme: 'bearer',
|
|
535
|
-
type: 'http'
|
|
536
|
-
}
|
|
537
|
-
],
|
|
538
|
-
url: '/v1/user/analytics/overview',
|
|
539
|
-
...options
|
|
540
|
-
});
|
|
541
|
-
};
|
|
542
|
-
|
|
543
|
-
/**
|
|
544
|
-
* Get Detailed User Analytics
|
|
545
|
-
* Get comprehensive analytics for the current user including API usage and recent activity.
|
|
546
|
-
*/
|
|
547
|
-
export const getDetailedUserAnalytics = <ThrowOnError extends boolean = false>(options?: Options<GetDetailedUserAnalyticsData, ThrowOnError>) => {
|
|
548
|
-
return (options?.client ?? _heyApiClient).get<GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, ThrowOnError>({
|
|
549
|
-
security: [
|
|
550
|
-
{
|
|
551
|
-
name: 'X-API-Key',
|
|
552
|
-
type: 'apiKey'
|
|
553
|
-
},
|
|
554
|
-
{
|
|
555
|
-
scheme: 'bearer',
|
|
556
|
-
type: 'http'
|
|
557
|
-
}
|
|
558
|
-
],
|
|
559
|
-
url: '/v1/user/analytics/detailed',
|
|
560
|
-
...options
|
|
561
|
-
});
|
|
562
|
-
};
|
|
563
|
-
|
|
564
|
-
/**
|
|
565
|
-
* Get User Subscriptions
|
|
566
|
-
* Retrieve user's current shared repository subscriptions with detailed information
|
|
567
|
-
*/
|
|
568
|
-
export const getUserSharedSubscriptions = <ThrowOnError extends boolean = false>(options?: Options<GetUserSharedSubscriptionsData, ThrowOnError>) => {
|
|
569
|
-
return (options?.client ?? _heyApiClient).get<GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, ThrowOnError>({
|
|
570
|
-
security: [
|
|
571
|
-
{
|
|
572
|
-
name: 'X-API-Key',
|
|
573
|
-
type: 'apiKey'
|
|
574
|
-
},
|
|
575
|
-
{
|
|
576
|
-
scheme: 'bearer',
|
|
577
|
-
type: 'http'
|
|
578
|
-
}
|
|
579
|
-
],
|
|
580
|
-
url: '/v1/user/subscriptions/shared-repositories',
|
|
581
|
-
...options
|
|
582
|
-
});
|
|
583
|
-
};
|
|
584
|
-
|
|
585
|
-
/**
|
|
586
|
-
* Subscribe to Shared Repository
|
|
587
|
-
* Create a new subscription to a shared repository add-on with specified tier
|
|
588
|
-
*/
|
|
589
|
-
export const subscribeToSharedRepository = <ThrowOnError extends boolean = false>(options: Options<SubscribeToSharedRepositoryData, ThrowOnError>) => {
|
|
590
|
-
return (options.client ?? _heyApiClient).post<SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, ThrowOnError>({
|
|
591
|
-
security: [
|
|
592
|
-
{
|
|
593
|
-
name: 'X-API-Key',
|
|
594
|
-
type: 'apiKey'
|
|
595
|
-
},
|
|
596
|
-
{
|
|
597
|
-
scheme: 'bearer',
|
|
598
|
-
type: 'http'
|
|
599
|
-
}
|
|
600
|
-
],
|
|
601
|
-
url: '/v1/user/subscriptions/shared-repositories/subscribe',
|
|
602
|
-
...options,
|
|
603
|
-
headers: {
|
|
604
|
-
'Content-Type': 'application/json',
|
|
605
|
-
...options.headers
|
|
606
|
-
}
|
|
607
|
-
});
|
|
608
|
-
};
|
|
609
|
-
|
|
610
|
-
/**
|
|
611
|
-
* Upgrade Subscription Tier
|
|
612
|
-
* Upgrade a subscription to a higher tier with immediate credit adjustment
|
|
613
|
-
*/
|
|
614
|
-
export const upgradeSharedRepositorySubscription = <ThrowOnError extends boolean = false>(options: Options<UpgradeSharedRepositorySubscriptionData, ThrowOnError>) => {
|
|
615
|
-
return (options.client ?? _heyApiClient).put<UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, ThrowOnError>({
|
|
616
|
-
security: [
|
|
617
|
-
{
|
|
618
|
-
name: 'X-API-Key',
|
|
619
|
-
type: 'apiKey'
|
|
620
|
-
},
|
|
621
|
-
{
|
|
622
|
-
scheme: 'bearer',
|
|
623
|
-
type: 'http'
|
|
624
|
-
}
|
|
625
|
-
],
|
|
626
|
-
url: '/v1/user/subscriptions/shared-repositories/{subscription_id}/upgrade',
|
|
627
|
-
...options,
|
|
628
|
-
headers: {
|
|
629
|
-
'Content-Type': 'application/json',
|
|
630
|
-
...options.headers
|
|
631
|
-
}
|
|
632
|
-
});
|
|
633
|
-
};
|
|
634
|
-
|
|
635
|
-
/**
|
|
636
|
-
* Cancel Subscription
|
|
637
|
-
* Cancel a shared repository subscription and disable associated credit pool
|
|
638
|
-
*/
|
|
639
|
-
export const cancelSharedRepositorySubscription = <ThrowOnError extends boolean = false>(options: Options<CancelSharedRepositorySubscriptionData, ThrowOnError>) => {
|
|
640
|
-
return (options.client ?? _heyApiClient).delete<CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, ThrowOnError>({
|
|
641
|
-
security: [
|
|
642
|
-
{
|
|
643
|
-
name: 'X-API-Key',
|
|
644
|
-
type: 'apiKey'
|
|
645
|
-
},
|
|
646
|
-
{
|
|
647
|
-
scheme: 'bearer',
|
|
648
|
-
type: 'http'
|
|
649
|
-
}
|
|
650
|
-
],
|
|
651
|
-
url: '/v1/user/subscriptions/shared-repositories/{subscription_id}',
|
|
652
|
-
...options
|
|
653
|
-
});
|
|
654
|
-
};
|
|
655
|
-
|
|
656
|
-
/**
|
|
657
|
-
* Get Credit Balances
|
|
658
|
-
* Retrieve credit balances for all shared repository subscriptions
|
|
659
|
-
*/
|
|
660
|
-
export const getSharedRepositoryCredits = <ThrowOnError extends boolean = false>(options?: Options<GetSharedRepositoryCreditsData, ThrowOnError>) => {
|
|
661
|
-
return (options?.client ?? _heyApiClient).get<GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, ThrowOnError>({
|
|
662
|
-
security: [
|
|
663
|
-
{
|
|
664
|
-
name: 'X-API-Key',
|
|
665
|
-
type: 'apiKey'
|
|
666
|
-
},
|
|
667
|
-
{
|
|
668
|
-
scheme: 'bearer',
|
|
669
|
-
type: 'http'
|
|
670
|
-
}
|
|
671
|
-
],
|
|
672
|
-
url: '/v1/user/subscriptions/shared-repositories/credits',
|
|
673
|
-
...options
|
|
674
|
-
});
|
|
675
|
-
};
|
|
676
|
-
|
|
677
|
-
/**
|
|
678
|
-
* Get Repository Credits
|
|
679
|
-
* Get credit balance for a specific shared repository
|
|
680
|
-
*/
|
|
681
|
-
export const getRepositoryCredits = <ThrowOnError extends boolean = false>(options: Options<GetRepositoryCreditsData, ThrowOnError>) => {
|
|
682
|
-
return (options.client ?? _heyApiClient).get<GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ThrowOnError>({
|
|
683
|
-
security: [
|
|
684
|
-
{
|
|
685
|
-
name: 'X-API-Key',
|
|
686
|
-
type: 'apiKey'
|
|
687
|
-
},
|
|
688
|
-
{
|
|
689
|
-
scheme: 'bearer',
|
|
690
|
-
type: 'http'
|
|
691
|
-
}
|
|
692
|
-
],
|
|
693
|
-
url: '/v1/user/subscriptions/shared-repositories/credits/{repository}',
|
|
694
|
-
...options
|
|
695
|
-
});
|
|
696
|
-
};
|
|
697
|
-
|
|
698
424
|
/**
|
|
699
425
|
* List Connections
|
|
700
426
|
* List all data connections in the graph.
|
|
@@ -1679,33 +1405,39 @@ export const getGraphMetrics = <ThrowOnError extends boolean = false>(options: O
|
|
|
1679
1405
|
};
|
|
1680
1406
|
|
|
1681
1407
|
/**
|
|
1682
|
-
* Get Usage
|
|
1683
|
-
* Get
|
|
1408
|
+
* Get Graph Usage Analytics
|
|
1409
|
+
* Get comprehensive usage analytics tracked by the GraphUsageTracking model.
|
|
1684
1410
|
*
|
|
1685
1411
|
* Provides temporal usage patterns including:
|
|
1686
|
-
* - **
|
|
1687
|
-
* - **Credit
|
|
1688
|
-
* - **
|
|
1689
|
-
* - **
|
|
1690
|
-
* - **Peak Usage Times**: Identify high-activity periods
|
|
1412
|
+
* - **Storage Analytics**: GB-hours for billing, breakdown by type (files, tables, graphs, subgraphs)
|
|
1413
|
+
* - **Credit Analytics**: Consumption patterns, operation breakdown, cached vs billable
|
|
1414
|
+
* - **Performance Insights**: Operation stats, slow queries, performance scoring
|
|
1415
|
+
* - **Recent Events**: Latest usage events with full details
|
|
1691
1416
|
*
|
|
1692
1417
|
* Time ranges available:
|
|
1693
|
-
* - Last 24 hours (hourly breakdown)
|
|
1694
|
-
* - Last 7 days (daily breakdown)
|
|
1695
|
-
* - Last 30 days (daily breakdown)
|
|
1696
|
-
* -
|
|
1418
|
+
* - `24h` - Last 24 hours (hourly breakdown)
|
|
1419
|
+
* - `7d` - Last 7 days (daily breakdown)
|
|
1420
|
+
* - `30d` - Last 30 days (daily breakdown)
|
|
1421
|
+
* - `current_month` - Current billing month
|
|
1422
|
+
* - `last_month` - Previous billing month
|
|
1423
|
+
*
|
|
1424
|
+
* Include options:
|
|
1425
|
+
* - `storage` - Storage usage summary (GB-hours, averages, peaks)
|
|
1426
|
+
* - `credits` - Credit consumption analytics
|
|
1427
|
+
* - `performance` - Performance insights and optimization opportunities
|
|
1428
|
+
* - `events` - Recent usage events (last 50)
|
|
1697
1429
|
*
|
|
1698
1430
|
* Useful for:
|
|
1431
|
+
* - Billing and cost analysis
|
|
1699
1432
|
* - Capacity planning
|
|
1700
|
-
* -
|
|
1433
|
+
* - Performance optimization
|
|
1701
1434
|
* - Usage trend analysis
|
|
1702
|
-
* - Performance tuning
|
|
1703
1435
|
*
|
|
1704
1436
|
* Note:
|
|
1705
1437
|
* This operation is included - no credit consumption required.
|
|
1706
1438
|
*/
|
|
1707
|
-
export const
|
|
1708
|
-
return (options.client ?? _heyApiClient).get<
|
|
1439
|
+
export const getGraphUsageAnalytics = <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageAnalyticsData, ThrowOnError>) => {
|
|
1440
|
+
return (options.client ?? _heyApiClient).get<GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ThrowOnError>({
|
|
1709
1441
|
security: [
|
|
1710
1442
|
{
|
|
1711
1443
|
name: 'X-API-Key',
|
|
@@ -1973,141 +1705,6 @@ export const validateSchema = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1973
1705
|
});
|
|
1974
1706
|
};
|
|
1975
1707
|
|
|
1976
|
-
/**
|
|
1977
|
-
* Get Current Bill
|
|
1978
|
-
* Get current month's billing details for the graph.
|
|
1979
|
-
*
|
|
1980
|
-
* Returns comprehensive billing information including:
|
|
1981
|
-
* - **Credit Usage**: Consumed vs. allocated credits
|
|
1982
|
-
* - **Storage Charges**: Current storage usage and costs
|
|
1983
|
-
* - **Subscription Tier**: Current plan and features
|
|
1984
|
-
* - **Pro-rated Charges**: If plan changed mid-month
|
|
1985
|
-
* - **Estimated Total**: Current charges to date
|
|
1986
|
-
*
|
|
1987
|
-
* Billing calculations are updated hourly. Storage is measured in GB-months.
|
|
1988
|
-
*
|
|
1989
|
-
* ℹ️ No credits are consumed for viewing billing information.
|
|
1990
|
-
*/
|
|
1991
|
-
export const getCurrentGraphBill = <ThrowOnError extends boolean = false>(options: Options<GetCurrentGraphBillData, ThrowOnError>) => {
|
|
1992
|
-
return (options.client ?? _heyApiClient).get<GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, ThrowOnError>({
|
|
1993
|
-
security: [
|
|
1994
|
-
{
|
|
1995
|
-
name: 'X-API-Key',
|
|
1996
|
-
type: 'apiKey'
|
|
1997
|
-
},
|
|
1998
|
-
{
|
|
1999
|
-
scheme: 'bearer',
|
|
2000
|
-
type: 'http'
|
|
2001
|
-
}
|
|
2002
|
-
],
|
|
2003
|
-
url: '/v1/graphs/{graph_id}/billing/current',
|
|
2004
|
-
...options
|
|
2005
|
-
});
|
|
2006
|
-
};
|
|
2007
|
-
|
|
2008
|
-
/**
|
|
2009
|
-
* Get Usage Details
|
|
2010
|
-
* Get detailed usage metrics for the graph.
|
|
2011
|
-
*
|
|
2012
|
-
* Provides granular usage information including:
|
|
2013
|
-
* - **Daily Credit Consumption**: Track credit usage patterns
|
|
2014
|
-
* - **Storage Growth**: Monitor database size over time
|
|
2015
|
-
* - **Operation Breakdown**: Credits by operation type
|
|
2016
|
-
* - **Peak Usage Times**: Identify high-activity periods
|
|
2017
|
-
* - **API Call Volumes**: Request counts and patterns
|
|
2018
|
-
*
|
|
2019
|
-
* Useful for:
|
|
2020
|
-
* - Optimizing credit consumption
|
|
2021
|
-
* - Capacity planning
|
|
2022
|
-
* - Usage trend analysis
|
|
2023
|
-
* - Cost optimization
|
|
2024
|
-
*
|
|
2025
|
-
* ℹ️ No credits are consumed for viewing usage details.
|
|
2026
|
-
*/
|
|
2027
|
-
export const getGraphUsageDetails = <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageDetailsData, ThrowOnError>) => {
|
|
2028
|
-
return (options.client ?? _heyApiClient).get<GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, ThrowOnError>({
|
|
2029
|
-
security: [
|
|
2030
|
-
{
|
|
2031
|
-
name: 'X-API-Key',
|
|
2032
|
-
type: 'apiKey'
|
|
2033
|
-
},
|
|
2034
|
-
{
|
|
2035
|
-
scheme: 'bearer',
|
|
2036
|
-
type: 'http'
|
|
2037
|
-
}
|
|
2038
|
-
],
|
|
2039
|
-
url: '/v1/graphs/{graph_id}/billing/usage',
|
|
2040
|
-
...options
|
|
2041
|
-
});
|
|
2042
|
-
};
|
|
2043
|
-
|
|
2044
|
-
/**
|
|
2045
|
-
* Get Billing History
|
|
2046
|
-
* Get billing history for the graph.
|
|
2047
|
-
*
|
|
2048
|
-
* Returns a chronological list of monthly bills, perfect for:
|
|
2049
|
-
* - Tracking spending trends over time
|
|
2050
|
-
* - Identifying usage patterns
|
|
2051
|
-
* - Budget forecasting
|
|
2052
|
-
* - Financial reporting
|
|
2053
|
-
*
|
|
2054
|
-
* Each month includes:
|
|
2055
|
-
* - Credit usage and overages
|
|
2056
|
-
* - Storage charges
|
|
2057
|
-
* - Total charges
|
|
2058
|
-
* - Usage metrics
|
|
2059
|
-
*
|
|
2060
|
-
* ℹ️ No credits are consumed for viewing billing history.
|
|
2061
|
-
*/
|
|
2062
|
-
export const getGraphBillingHistory = <ThrowOnError extends boolean = false>(options: Options<GetGraphBillingHistoryData, ThrowOnError>) => {
|
|
2063
|
-
return (options.client ?? _heyApiClient).get<GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, ThrowOnError>({
|
|
2064
|
-
security: [
|
|
2065
|
-
{
|
|
2066
|
-
name: 'X-API-Key',
|
|
2067
|
-
type: 'apiKey'
|
|
2068
|
-
},
|
|
2069
|
-
{
|
|
2070
|
-
scheme: 'bearer',
|
|
2071
|
-
type: 'http'
|
|
2072
|
-
}
|
|
2073
|
-
],
|
|
2074
|
-
url: '/v1/graphs/{graph_id}/billing/history',
|
|
2075
|
-
...options
|
|
2076
|
-
});
|
|
2077
|
-
};
|
|
2078
|
-
|
|
2079
|
-
/**
|
|
2080
|
-
* Get Monthly Bill
|
|
2081
|
-
* Get billing details for a specific month.
|
|
2082
|
-
*
|
|
2083
|
-
* Retrieve historical billing information for any previous month.
|
|
2084
|
-
* Useful for:
|
|
2085
|
-
* - Reconciling past charges
|
|
2086
|
-
* - Tracking usage trends
|
|
2087
|
-
* - Expense reporting
|
|
2088
|
-
* - Budget analysis
|
|
2089
|
-
*
|
|
2090
|
-
* Returns the same detailed breakdown as the current bill endpoint.
|
|
2091
|
-
*
|
|
2092
|
-
* ℹ️ No credits are consumed for viewing billing history.
|
|
2093
|
-
*/
|
|
2094
|
-
export const getGraphMonthlyBill = <ThrowOnError extends boolean = false>(options: Options<GetGraphMonthlyBillData, ThrowOnError>) => {
|
|
2095
|
-
return (options.client ?? _heyApiClient).get<GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, ThrowOnError>({
|
|
2096
|
-
security: [
|
|
2097
|
-
{
|
|
2098
|
-
name: 'X-API-Key',
|
|
2099
|
-
type: 'apiKey'
|
|
2100
|
-
},
|
|
2101
|
-
{
|
|
2102
|
-
scheme: 'bearer',
|
|
2103
|
-
type: 'http'
|
|
2104
|
-
}
|
|
2105
|
-
],
|
|
2106
|
-
url: '/v1/graphs/{graph_id}/billing/history/{year}/{month}',
|
|
2107
|
-
...options
|
|
2108
|
-
});
|
|
2109
|
-
};
|
|
2110
|
-
|
|
2111
1708
|
/**
|
|
2112
1709
|
* Get Credit Summary
|
|
2113
1710
|
* Retrieve comprehensive credit usage summary for the specified graph.
|
|
@@ -2555,6 +2152,116 @@ export const getSubgraphQuota = <ThrowOnError extends boolean = false>(options:
|
|
|
2555
2152
|
});
|
|
2556
2153
|
};
|
|
2557
2154
|
|
|
2155
|
+
/**
|
|
2156
|
+
* Cancel Subscription
|
|
2157
|
+
* Cancel a subscription.
|
|
2158
|
+
*
|
|
2159
|
+
* For shared repositories: Cancels the user's personal subscription
|
|
2160
|
+
* For user graphs: Not allowed - delete the graph instead
|
|
2161
|
+
*
|
|
2162
|
+
* The subscription will be marked as canceled and will end at the current period end date.
|
|
2163
|
+
*/
|
|
2164
|
+
export const cancelSubscription = <ThrowOnError extends boolean = false>(options: Options<CancelSubscriptionData, ThrowOnError>) => {
|
|
2165
|
+
return (options.client ?? _heyApiClient).delete<CancelSubscriptionResponses, CancelSubscriptionErrors, ThrowOnError>({
|
|
2166
|
+
security: [
|
|
2167
|
+
{
|
|
2168
|
+
name: 'X-API-Key',
|
|
2169
|
+
type: 'apiKey'
|
|
2170
|
+
},
|
|
2171
|
+
{
|
|
2172
|
+
scheme: 'bearer',
|
|
2173
|
+
type: 'http'
|
|
2174
|
+
}
|
|
2175
|
+
],
|
|
2176
|
+
url: '/v1/graphs/{graph_id}/subscriptions',
|
|
2177
|
+
...options
|
|
2178
|
+
});
|
|
2179
|
+
};
|
|
2180
|
+
|
|
2181
|
+
/**
|
|
2182
|
+
* Get Subscription
|
|
2183
|
+
* Get subscription details for a graph or shared repository.
|
|
2184
|
+
*
|
|
2185
|
+
* For user graphs (kg*): Returns the graph's subscription (owned by graph creator)
|
|
2186
|
+
* For shared repositories (sec, industry, etc.): Returns user's personal subscription to that repository
|
|
2187
|
+
*
|
|
2188
|
+
* This unified endpoint automatically detects the resource type and returns the appropriate subscription.
|
|
2189
|
+
*/
|
|
2190
|
+
export const getGraphSubscription = <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionData, ThrowOnError>) => {
|
|
2191
|
+
return (options.client ?? _heyApiClient).get<GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, ThrowOnError>({
|
|
2192
|
+
security: [
|
|
2193
|
+
{
|
|
2194
|
+
name: 'X-API-Key',
|
|
2195
|
+
type: 'apiKey'
|
|
2196
|
+
},
|
|
2197
|
+
{
|
|
2198
|
+
scheme: 'bearer',
|
|
2199
|
+
type: 'http'
|
|
2200
|
+
}
|
|
2201
|
+
],
|
|
2202
|
+
url: '/v1/graphs/{graph_id}/subscriptions',
|
|
2203
|
+
...options
|
|
2204
|
+
});
|
|
2205
|
+
};
|
|
2206
|
+
|
|
2207
|
+
/**
|
|
2208
|
+
* Create Repository Subscription
|
|
2209
|
+
* Create a new subscription to a shared repository.
|
|
2210
|
+
*
|
|
2211
|
+
* This endpoint is ONLY for shared repositories (sec, industry, economic).
|
|
2212
|
+
* User graph subscriptions are created automatically when the graph is provisioned.
|
|
2213
|
+
*
|
|
2214
|
+
* The subscription will be created in ACTIVE status immediately and credits will be allocated.
|
|
2215
|
+
*/
|
|
2216
|
+
export const createRepositorySubscription = <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => {
|
|
2217
|
+
return (options.client ?? _heyApiClient).post<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError>({
|
|
2218
|
+
security: [
|
|
2219
|
+
{
|
|
2220
|
+
name: 'X-API-Key',
|
|
2221
|
+
type: 'apiKey'
|
|
2222
|
+
},
|
|
2223
|
+
{
|
|
2224
|
+
scheme: 'bearer',
|
|
2225
|
+
type: 'http'
|
|
2226
|
+
}
|
|
2227
|
+
],
|
|
2228
|
+
url: '/v1/graphs/{graph_id}/subscriptions',
|
|
2229
|
+
...options,
|
|
2230
|
+
headers: {
|
|
2231
|
+
'Content-Type': 'application/json',
|
|
2232
|
+
...options.headers
|
|
2233
|
+
}
|
|
2234
|
+
});
|
|
2235
|
+
};
|
|
2236
|
+
|
|
2237
|
+
/**
|
|
2238
|
+
* Upgrade Subscription
|
|
2239
|
+
* Upgrade a subscription to a different plan.
|
|
2240
|
+
*
|
|
2241
|
+
* Works for both user graphs and shared repositories.
|
|
2242
|
+
* The subscription will be immediately updated to the new plan and pricing.
|
|
2243
|
+
*/
|
|
2244
|
+
export const upgradeSubscription = <ThrowOnError extends boolean = false>(options: Options<UpgradeSubscriptionData, ThrowOnError>) => {
|
|
2245
|
+
return (options.client ?? _heyApiClient).put<UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, ThrowOnError>({
|
|
2246
|
+
security: [
|
|
2247
|
+
{
|
|
2248
|
+
name: 'X-API-Key',
|
|
2249
|
+
type: 'apiKey'
|
|
2250
|
+
},
|
|
2251
|
+
{
|
|
2252
|
+
scheme: 'bearer',
|
|
2253
|
+
type: 'http'
|
|
2254
|
+
}
|
|
2255
|
+
],
|
|
2256
|
+
url: '/v1/graphs/{graph_id}/subscriptions/upgrade',
|
|
2257
|
+
...options,
|
|
2258
|
+
headers: {
|
|
2259
|
+
'Content-Type': 'application/json',
|
|
2260
|
+
...options.headers
|
|
2261
|
+
}
|
|
2262
|
+
});
|
|
2263
|
+
};
|
|
2264
|
+
|
|
2558
2265
|
/**
|
|
2559
2266
|
* List Staging Tables
|
|
2560
2267
|
* List all DuckDB staging tables with comprehensive metrics and status.
|
|
@@ -3020,38 +2727,45 @@ export const queryTables = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
3020
2727
|
};
|
|
3021
2728
|
|
|
3022
2729
|
/**
|
|
3023
|
-
* Get User Graphs
|
|
3024
|
-
* List all graph databases accessible to the current user
|
|
2730
|
+
* Get User Graphs and Repositories
|
|
2731
|
+
* List all graph databases and shared repositories accessible to the current user.
|
|
3025
2732
|
*
|
|
3026
|
-
* Returns a
|
|
3027
|
-
*
|
|
3028
|
-
* the active workspace.
|
|
2733
|
+
* Returns a unified list of both user-created graphs and shared repositories (like SEC data)
|
|
2734
|
+
* that the user has access to, including their role/access level and selection status.
|
|
3029
2735
|
*
|
|
3030
2736
|
* **Returned Information:**
|
|
3031
|
-
* - Graph ID and display name
|
|
3032
|
-
* - User's role (admin/member
|
|
3033
|
-
* - Selection status (
|
|
3034
|
-
* - Creation timestamp
|
|
3035
|
-
*
|
|
3036
|
-
*
|
|
3037
|
-
*
|
|
3038
|
-
* -
|
|
2737
|
+
* - Graph/Repository ID and display name
|
|
2738
|
+
* - User's role/access level (admin/member for graphs, read/write/admin for repositories)
|
|
2739
|
+
* - Selection status (only user graphs can be selected)
|
|
2740
|
+
* - Creation timestamp
|
|
2741
|
+
* - Repository type indicator (isRepository: true for shared repositories)
|
|
2742
|
+
*
|
|
2743
|
+
* **User Graphs (isRepository: false):**
|
|
2744
|
+
* - Collaborative workspaces that can be shared with other users
|
|
2745
|
+
* - Roles: `admin` (full access, can invite users) or `member` (read/write access)
|
|
2746
|
+
* - Can be selected as active workspace
|
|
2747
|
+
* - Graphs you create or have been invited to
|
|
2748
|
+
*
|
|
2749
|
+
* **Shared Repositories (isRepository: true):**
|
|
2750
|
+
* - Read-only data repositories like SEC filings, industry benchmarks
|
|
2751
|
+
* - Access levels: `read`, `write` (for data contributions), `admin`
|
|
2752
|
+
* - Cannot be selected (each has separate subscription)
|
|
2753
|
+
* - Require separate subscriptions (personal, cannot be shared)
|
|
3039
2754
|
*
|
|
3040
2755
|
* **Selected Graph Concept:**
|
|
3041
|
-
* The "selected" graph is the user's currently active workspace
|
|
3042
|
-
* default to the selected graph if no graph_id is provided.
|
|
3043
|
-
* selected graph via
|
|
2756
|
+
* The "selected" graph is the user's currently active workspace (user graphs only).
|
|
2757
|
+
* Many API operations default to the selected graph if no graph_id is provided.
|
|
2758
|
+
* Users can change their selected graph via `POST /v1/graphs/{graph_id}/select`.
|
|
3044
2759
|
*
|
|
3045
2760
|
* **Use Cases:**
|
|
3046
|
-
* - Display graph selector in UI
|
|
3047
|
-
* - Show
|
|
3048
|
-
* - Identify
|
|
3049
|
-
* - Filter
|
|
2761
|
+
* - Display unified graph/repository selector in UI
|
|
2762
|
+
* - Show all accessible data sources (both owned graphs and subscribed repositories)
|
|
2763
|
+
* - Identify currently active workspace
|
|
2764
|
+
* - Filter by type (user graphs vs repositories)
|
|
3050
2765
|
*
|
|
3051
2766
|
* **Empty Response:**
|
|
3052
|
-
* New users
|
|
3053
|
-
*
|
|
3054
|
-
* to an existing graph.
|
|
2767
|
+
* New users receive an empty list with `selectedGraphId: null`. Users should create
|
|
2768
|
+
* a graph or subscribe to a repository.
|
|
3055
2769
|
*
|
|
3056
2770
|
* **Note:**
|
|
3057
2771
|
* Graph listing is included - no credit consumption required.
|