@robosystems/client 0.2.8 → 0.2.10
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 +146 -163
- package/sdk/sdk.gen.js +412 -469
- package/sdk/sdk.gen.ts +412 -469
- package/sdk/types.gen.d.ts +971 -1028
- package/sdk/types.gen.ts +1210 -1278
- package/sdk.gen.d.ts +146 -163
- package/sdk.gen.js +412 -469
- package/sdk.gen.ts +412 -469
- package/types.gen.d.ts +971 -1028
- package/types.gen.ts +1210 -1278
package/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Options as ClientOptions, TDataShape, Client } from './client';
|
|
2
|
-
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors,
|
|
2
|
+
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, 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, CreateCheckoutSessionData, CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, GetCheckoutStatusData, GetCheckoutStatusResponses, GetCheckoutStatusErrors, GetBillingCustomerData, GetBillingCustomerResponses, UpdatePaymentMethodData, UpdatePaymentMethodResponses, UpdatePaymentMethodErrors, ListInvoicesData, ListInvoicesResponses, ListInvoicesErrors, GetUpcomingInvoiceData, GetUpcomingInvoiceResponses, ListSubscriptionsData, ListSubscriptionsResponses, GetSubscriptionData, GetSubscriptionResponses, GetSubscriptionErrors, CancelSubscription2Data, CancelSubscription2Responses, CancelSubscription2Errors } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -108,17 +108,6 @@ export declare const getCurrentUser: <ThrowOnError extends boolean = false>(opti
|
|
|
108
108
|
* Update the current user's profile information.
|
|
109
109
|
*/
|
|
110
110
|
export declare const updateUser: <ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>) => import("./client").RequestResult<UpdateUserResponses, UpdateUserErrors, ThrowOnError, "fields">;
|
|
111
|
-
/**
|
|
112
|
-
* Get All Credit Summaries
|
|
113
|
-
* Get credit summaries for all graphs owned by the user.
|
|
114
|
-
*
|
|
115
|
-
* This endpoint provides a consolidated view of credit usage across
|
|
116
|
-
* all graphs where the user has access, helping to monitor overall
|
|
117
|
-
* credit consumption and plan usage.
|
|
118
|
-
*
|
|
119
|
-
* No credits are consumed for viewing summaries.
|
|
120
|
-
*/
|
|
121
|
-
export declare const getAllCreditSummaries: <ThrowOnError extends boolean = false>(options?: Options<GetAllCreditSummariesData, ThrowOnError>) => import("./client").RequestResult<GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, ThrowOnError, "fields">;
|
|
122
111
|
/**
|
|
123
112
|
* Update Password
|
|
124
113
|
* Update the current user's password.
|
|
@@ -145,73 +134,10 @@ export declare const revokeUserApiKey: <ThrowOnError extends boolean = false>(op
|
|
|
145
134
|
*/
|
|
146
135
|
export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ThrowOnError, "fields">;
|
|
147
136
|
/**
|
|
148
|
-
* Get user limits
|
|
149
|
-
* Retrieve current limits and
|
|
150
|
-
*/
|
|
151
|
-
export declare const getUserLimits: <ThrowOnError extends boolean = false>(options?: Options<GetUserLimitsData, ThrowOnError>) => import("./client").RequestResult<GetUserLimitsResponses, GetUserLimitsErrors, ThrowOnError, "fields">;
|
|
152
|
-
/**
|
|
153
|
-
* Get user usage statistics
|
|
154
|
-
* Retrieve current usage statistics and remaining limits for the authenticated user
|
|
155
|
-
*/
|
|
156
|
-
export declare const getUserUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageResponses, unknown, ThrowOnError, "fields">;
|
|
157
|
-
/**
|
|
158
|
-
* Get all shared repository limits
|
|
159
|
-
* Get rate limit status for all shared repositories the user has access to.
|
|
160
|
-
*/
|
|
161
|
-
export declare const getAllSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetAllSharedRepositoryLimitsResponses, unknown, ThrowOnError, "fields">;
|
|
162
|
-
/**
|
|
163
|
-
* Get shared repository rate limit status
|
|
164
|
-
* Get current rate limit status and usage for a shared repository.
|
|
165
|
-
*
|
|
166
|
-
* Returns:
|
|
167
|
-
* - Current usage across different time windows
|
|
168
|
-
* - Rate limits based on subscription tier
|
|
169
|
-
* - Remaining quota
|
|
170
|
-
* - Reset times
|
|
171
|
-
*
|
|
172
|
-
* Note: All queries are included - this only shows rate limit status.
|
|
173
|
-
*/
|
|
174
|
-
export declare const getSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options: Options<GetSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
|
|
175
|
-
/**
|
|
176
|
-
* Get User Usage Overview
|
|
177
|
-
* Get a high-level overview of usage statistics for the current user.
|
|
178
|
-
*/
|
|
179
|
-
export declare const getUserUsageOverview: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageOverviewData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageOverviewResponses, unknown, ThrowOnError, "fields">;
|
|
180
|
-
/**
|
|
181
|
-
* Get Detailed User Analytics
|
|
182
|
-
* Get comprehensive analytics for the current user including API usage and recent activity.
|
|
183
|
-
*/
|
|
184
|
-
export declare const getDetailedUserAnalytics: <ThrowOnError extends boolean = false>(options?: Options<GetDetailedUserAnalyticsData, ThrowOnError>) => import("./client").RequestResult<GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, ThrowOnError, "fields">;
|
|
185
|
-
/**
|
|
186
|
-
* Get User Subscriptions
|
|
187
|
-
* Retrieve user's current shared repository subscriptions with detailed information
|
|
188
|
-
*/
|
|
189
|
-
export declare const getUserSharedSubscriptions: <ThrowOnError extends boolean = false>(options?: Options<GetUserSharedSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, ThrowOnError, "fields">;
|
|
190
|
-
/**
|
|
191
|
-
* Subscribe to Shared Repository
|
|
192
|
-
* Create a new subscription to a shared repository add-on with specified tier
|
|
137
|
+
* Get user limits and usage
|
|
138
|
+
* Retrieve current limits and usage statistics for the authenticated user (simple safety valve for graph creation)
|
|
193
139
|
*/
|
|
194
|
-
export declare const
|
|
195
|
-
/**
|
|
196
|
-
* Upgrade Subscription Tier
|
|
197
|
-
* Upgrade a subscription to a higher tier with immediate credit adjustment
|
|
198
|
-
*/
|
|
199
|
-
export declare const upgradeSharedRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<UpgradeSharedRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, ThrowOnError, "fields">;
|
|
200
|
-
/**
|
|
201
|
-
* Cancel Subscription
|
|
202
|
-
* Cancel a shared repository subscription and disable associated credit pool
|
|
203
|
-
*/
|
|
204
|
-
export declare const cancelSharedRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CancelSharedRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, ThrowOnError, "fields">;
|
|
205
|
-
/**
|
|
206
|
-
* Get Credit Balances
|
|
207
|
-
* Retrieve credit balances for all shared repository subscriptions
|
|
208
|
-
*/
|
|
209
|
-
export declare const getSharedRepositoryCredits: <ThrowOnError extends boolean = false>(options?: Options<GetSharedRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, ThrowOnError, "fields">;
|
|
210
|
-
/**
|
|
211
|
-
* Get Repository Credits
|
|
212
|
-
* Get credit balance for a specific shared repository
|
|
213
|
-
*/
|
|
214
|
-
export declare const getRepositoryCredits: <ThrowOnError extends boolean = false>(options: Options<GetRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ThrowOnError, "fields">;
|
|
140
|
+
export declare const getUserLimits: <ThrowOnError extends boolean = false>(options?: Options<GetUserLimitsData, ThrowOnError>) => import("./client").RequestResult<GetUserLimitsResponses, unknown, ThrowOnError, "fields">;
|
|
215
141
|
/**
|
|
216
142
|
* List Connections
|
|
217
143
|
* List all data connections in the graph.
|
|
@@ -760,32 +686,38 @@ export declare const getBackupStats: <ThrowOnError extends boolean = false>(opti
|
|
|
760
686
|
*/
|
|
761
687
|
export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => import("./client").RequestResult<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError, "fields">;
|
|
762
688
|
/**
|
|
763
|
-
* Get Usage
|
|
764
|
-
* Get
|
|
689
|
+
* Get Graph Usage Analytics
|
|
690
|
+
* Get comprehensive usage analytics tracked by the GraphUsageTracking model.
|
|
765
691
|
*
|
|
766
692
|
* Provides temporal usage patterns including:
|
|
767
|
-
* - **
|
|
768
|
-
* - **Credit
|
|
769
|
-
* - **
|
|
770
|
-
* - **
|
|
771
|
-
* - **Peak Usage Times**: Identify high-activity periods
|
|
693
|
+
* - **Storage Analytics**: GB-hours for billing, breakdown by type (files, tables, graphs, subgraphs)
|
|
694
|
+
* - **Credit Analytics**: Consumption patterns, operation breakdown, cached vs billable
|
|
695
|
+
* - **Performance Insights**: Operation stats, slow queries, performance scoring
|
|
696
|
+
* - **Recent Events**: Latest usage events with full details
|
|
772
697
|
*
|
|
773
698
|
* Time ranges available:
|
|
774
|
-
* - Last 24 hours (hourly breakdown)
|
|
775
|
-
* - Last 7 days (daily breakdown)
|
|
776
|
-
* - Last 30 days (daily breakdown)
|
|
777
|
-
* -
|
|
699
|
+
* - `24h` - Last 24 hours (hourly breakdown)
|
|
700
|
+
* - `7d` - Last 7 days (daily breakdown)
|
|
701
|
+
* - `30d` - Last 30 days (daily breakdown)
|
|
702
|
+
* - `current_month` - Current billing month
|
|
703
|
+
* - `last_month` - Previous billing month
|
|
704
|
+
*
|
|
705
|
+
* Include options:
|
|
706
|
+
* - `storage` - Storage usage summary (GB-hours, averages, peaks)
|
|
707
|
+
* - `credits` - Credit consumption analytics
|
|
708
|
+
* - `performance` - Performance insights and optimization opportunities
|
|
709
|
+
* - `events` - Recent usage events (last 50)
|
|
778
710
|
*
|
|
779
711
|
* Useful for:
|
|
712
|
+
* - Billing and cost analysis
|
|
780
713
|
* - Capacity planning
|
|
781
|
-
* -
|
|
714
|
+
* - Performance optimization
|
|
782
715
|
* - Usage trend analysis
|
|
783
|
-
* - Performance tuning
|
|
784
716
|
*
|
|
785
717
|
* Note:
|
|
786
718
|
* This operation is included - no credit consumption required.
|
|
787
719
|
*/
|
|
788
|
-
export declare const
|
|
720
|
+
export declare const getGraphUsageAnalytics: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageAnalyticsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ThrowOnError, "fields">;
|
|
789
721
|
/**
|
|
790
722
|
* Execute Cypher Query (Read-Only)
|
|
791
723
|
* Execute a read-only Cypher query with intelligent response optimization.
|
|
@@ -966,77 +898,6 @@ export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(o
|
|
|
966
898
|
* This operation is included - no credit consumption required.
|
|
967
899
|
*/
|
|
968
900
|
export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
|
|
969
|
-
/**
|
|
970
|
-
* Get Current Bill
|
|
971
|
-
* Get current month's billing details for the graph.
|
|
972
|
-
*
|
|
973
|
-
* Returns comprehensive billing information including:
|
|
974
|
-
* - **Credit Usage**: Consumed vs. allocated credits
|
|
975
|
-
* - **Storage Charges**: Current storage usage and costs
|
|
976
|
-
* - **Subscription Tier**: Current plan and features
|
|
977
|
-
* - **Pro-rated Charges**: If plan changed mid-month
|
|
978
|
-
* - **Estimated Total**: Current charges to date
|
|
979
|
-
*
|
|
980
|
-
* Billing calculations are updated hourly. Storage is measured in GB-months.
|
|
981
|
-
*
|
|
982
|
-
* ℹ️ No credits are consumed for viewing billing information.
|
|
983
|
-
*/
|
|
984
|
-
export declare const getCurrentGraphBill: <ThrowOnError extends boolean = false>(options: Options<GetCurrentGraphBillData, ThrowOnError>) => import("./client").RequestResult<GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, ThrowOnError, "fields">;
|
|
985
|
-
/**
|
|
986
|
-
* Get Usage Details
|
|
987
|
-
* Get detailed usage metrics for the graph.
|
|
988
|
-
*
|
|
989
|
-
* Provides granular usage information including:
|
|
990
|
-
* - **Daily Credit Consumption**: Track credit usage patterns
|
|
991
|
-
* - **Storage Growth**: Monitor database size over time
|
|
992
|
-
* - **Operation Breakdown**: Credits by operation type
|
|
993
|
-
* - **Peak Usage Times**: Identify high-activity periods
|
|
994
|
-
* - **API Call Volumes**: Request counts and patterns
|
|
995
|
-
*
|
|
996
|
-
* Useful for:
|
|
997
|
-
* - Optimizing credit consumption
|
|
998
|
-
* - Capacity planning
|
|
999
|
-
* - Usage trend analysis
|
|
1000
|
-
* - Cost optimization
|
|
1001
|
-
*
|
|
1002
|
-
* ℹ️ No credits are consumed for viewing usage details.
|
|
1003
|
-
*/
|
|
1004
|
-
export declare const getGraphUsageDetails: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageDetailsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, ThrowOnError, "fields">;
|
|
1005
|
-
/**
|
|
1006
|
-
* Get Billing History
|
|
1007
|
-
* Get billing history for the graph.
|
|
1008
|
-
*
|
|
1009
|
-
* Returns a chronological list of monthly bills, perfect for:
|
|
1010
|
-
* - Tracking spending trends over time
|
|
1011
|
-
* - Identifying usage patterns
|
|
1012
|
-
* - Budget forecasting
|
|
1013
|
-
* - Financial reporting
|
|
1014
|
-
*
|
|
1015
|
-
* Each month includes:
|
|
1016
|
-
* - Credit usage and overages
|
|
1017
|
-
* - Storage charges
|
|
1018
|
-
* - Total charges
|
|
1019
|
-
* - Usage metrics
|
|
1020
|
-
*
|
|
1021
|
-
* ℹ️ No credits are consumed for viewing billing history.
|
|
1022
|
-
*/
|
|
1023
|
-
export declare const getGraphBillingHistory: <ThrowOnError extends boolean = false>(options: Options<GetGraphBillingHistoryData, ThrowOnError>) => import("./client").RequestResult<GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, ThrowOnError, "fields">;
|
|
1024
|
-
/**
|
|
1025
|
-
* Get Monthly Bill
|
|
1026
|
-
* Get billing details for a specific month.
|
|
1027
|
-
*
|
|
1028
|
-
* Retrieve historical billing information for any previous month.
|
|
1029
|
-
* Useful for:
|
|
1030
|
-
* - Reconciling past charges
|
|
1031
|
-
* - Tracking usage trends
|
|
1032
|
-
* - Expense reporting
|
|
1033
|
-
* - Budget analysis
|
|
1034
|
-
*
|
|
1035
|
-
* Returns the same detailed breakdown as the current bill endpoint.
|
|
1036
|
-
*
|
|
1037
|
-
* ℹ️ No credits are consumed for viewing billing history.
|
|
1038
|
-
*/
|
|
1039
|
-
export declare const getGraphMonthlyBill: <ThrowOnError extends boolean = false>(options: Options<GetGraphMonthlyBillData, ThrowOnError>) => import("./client").RequestResult<GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, ThrowOnError, "fields">;
|
|
1040
901
|
/**
|
|
1041
902
|
* Get Credit Summary
|
|
1042
903
|
* Retrieve comprehensive credit usage summary for the specified graph.
|
|
@@ -1268,6 +1129,44 @@ export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(opt
|
|
|
1268
1129
|
* Individual subgraph sizes shown in list endpoint.
|
|
1269
1130
|
*/
|
|
1270
1131
|
export declare const getSubgraphQuota: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError, "fields">;
|
|
1132
|
+
/**
|
|
1133
|
+
* Cancel Subscription
|
|
1134
|
+
* Cancel a subscription.
|
|
1135
|
+
*
|
|
1136
|
+
* For shared repositories: Cancels the user's personal subscription
|
|
1137
|
+
* For user graphs: Not allowed - delete the graph instead
|
|
1138
|
+
*
|
|
1139
|
+
* The subscription will be marked as canceled and will end at the current period end date.
|
|
1140
|
+
*/
|
|
1141
|
+
export declare const cancelSubscription: <ThrowOnError extends boolean = false>(options: Options<CancelSubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelSubscriptionResponses, CancelSubscriptionErrors, ThrowOnError, "fields">;
|
|
1142
|
+
/**
|
|
1143
|
+
* Get Subscription
|
|
1144
|
+
* Get subscription details for a graph or shared repository.
|
|
1145
|
+
*
|
|
1146
|
+
* For user graphs (kg*): Returns the graph's subscription (owned by graph creator)
|
|
1147
|
+
* For shared repositories (sec, industry, etc.): Returns user's personal subscription to that repository
|
|
1148
|
+
*
|
|
1149
|
+
* This unified endpoint automatically detects the resource type and returns the appropriate subscription.
|
|
1150
|
+
*/
|
|
1151
|
+
export declare const getGraphSubscription: <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionData, ThrowOnError>) => import("./client").RequestResult<GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, ThrowOnError, "fields">;
|
|
1152
|
+
/**
|
|
1153
|
+
* Create Repository Subscription
|
|
1154
|
+
* Create a new subscription to a shared repository.
|
|
1155
|
+
*
|
|
1156
|
+
* This endpoint is ONLY for shared repositories (sec, industry, economic).
|
|
1157
|
+
* User graph subscriptions are created automatically when the graph is provisioned.
|
|
1158
|
+
*
|
|
1159
|
+
* The subscription will be created in ACTIVE status immediately and credits will be allocated.
|
|
1160
|
+
*/
|
|
1161
|
+
export declare const createRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError, "fields">;
|
|
1162
|
+
/**
|
|
1163
|
+
* Upgrade Subscription
|
|
1164
|
+
* Upgrade a subscription to a different plan.
|
|
1165
|
+
*
|
|
1166
|
+
* Works for both user graphs and shared repositories.
|
|
1167
|
+
* The subscription will be immediately updated to the new plan and pricing.
|
|
1168
|
+
*/
|
|
1169
|
+
export declare const upgradeSubscription: <ThrowOnError extends boolean = false>(options: Options<UpgradeSubscriptionData, ThrowOnError>) => import("./client").RequestResult<UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, ThrowOnError, "fields">;
|
|
1271
1170
|
/**
|
|
1272
1171
|
* List Staging Tables
|
|
1273
1172
|
* List all DuckDB staging tables with comprehensive metrics and status.
|
|
@@ -1900,3 +1799,87 @@ export declare const getOperationStatus: <ThrowOnError extends boolean = false>(
|
|
|
1900
1799
|
* **No credits are consumed for cancellation requests.**
|
|
1901
1800
|
*/
|
|
1902
1801
|
export declare const cancelOperation: <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) => import("./client").RequestResult<CancelOperationResponses, CancelOperationErrors, ThrowOnError, "fields">;
|
|
1802
|
+
/**
|
|
1803
|
+
* Create Payment Checkout Session
|
|
1804
|
+
* Create a Stripe checkout session for collecting payment method.
|
|
1805
|
+
*
|
|
1806
|
+
* This endpoint is used when a user needs to add a payment method before
|
|
1807
|
+
* provisioning resources. It creates a pending subscription and redirects
|
|
1808
|
+
* the user to Stripe Checkout to collect payment details.
|
|
1809
|
+
*
|
|
1810
|
+
* **Flow:**
|
|
1811
|
+
* 1. User tries to create a graph but has no payment method
|
|
1812
|
+
* 2. Frontend calls this endpoint with graph configuration
|
|
1813
|
+
* 3. Backend creates a subscription in PENDING_PAYMENT status
|
|
1814
|
+
* 4. Returns Stripe Checkout URL
|
|
1815
|
+
* 5. User completes payment on Stripe
|
|
1816
|
+
* 6. Webhook activates subscription and provisions resource
|
|
1817
|
+
*
|
|
1818
|
+
* **Enterprise customers** (with invoice_billing_enabled) should not call this endpoint.
|
|
1819
|
+
*/
|
|
1820
|
+
export declare const createCheckoutSession: <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionData, ThrowOnError>) => import("./client").RequestResult<CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, ThrowOnError, "fields">;
|
|
1821
|
+
/**
|
|
1822
|
+
* Get Checkout Session Status
|
|
1823
|
+
* Poll the status of a checkout session.
|
|
1824
|
+
*
|
|
1825
|
+
* Frontend should poll this endpoint after user returns from Stripe Checkout
|
|
1826
|
+
* to determine when the resource is ready.
|
|
1827
|
+
*
|
|
1828
|
+
* **Status Values:**
|
|
1829
|
+
* - `pending_payment`: Waiting for payment to complete
|
|
1830
|
+
* - `provisioning`: Payment confirmed, resource being created
|
|
1831
|
+
* - `completed`: Resource is ready (resource_id will be set)
|
|
1832
|
+
* - `failed`: Something went wrong (error field will be set)
|
|
1833
|
+
*
|
|
1834
|
+
* **When status is 'completed':**
|
|
1835
|
+
* - For graphs: `resource_id` will be the graph_id, and `operation_id` can be used to monitor SSE progress
|
|
1836
|
+
* - For repositories: `resource_id` will be the repository name and access is immediately available
|
|
1837
|
+
*/
|
|
1838
|
+
export declare const getCheckoutStatus: <ThrowOnError extends boolean = false>(options: Options<GetCheckoutStatusData, ThrowOnError>) => import("./client").RequestResult<GetCheckoutStatusResponses, GetCheckoutStatusErrors, ThrowOnError, "fields">;
|
|
1839
|
+
/**
|
|
1840
|
+
* Get Customer Info
|
|
1841
|
+
* Get billing customer information including payment methods on file.
|
|
1842
|
+
*
|
|
1843
|
+
* Returns customer details, payment methods, and whether invoice billing is enabled.
|
|
1844
|
+
*/
|
|
1845
|
+
export declare const getBillingCustomer: <ThrowOnError extends boolean = false>(options?: Options<GetBillingCustomerData, ThrowOnError>) => import("./client").RequestResult<GetBillingCustomerResponses, unknown, ThrowOnError, "fields">;
|
|
1846
|
+
/**
|
|
1847
|
+
* Update Default Payment Method
|
|
1848
|
+
* Update the default payment method for the customer.
|
|
1849
|
+
*
|
|
1850
|
+
* This changes which payment method will be used for future subscription charges.
|
|
1851
|
+
*/
|
|
1852
|
+
export declare const updatePaymentMethod: <ThrowOnError extends boolean = false>(options: Options<UpdatePaymentMethodData, ThrowOnError>) => import("./client").RequestResult<UpdatePaymentMethodResponses, UpdatePaymentMethodErrors, ThrowOnError, "fields">;
|
|
1853
|
+
/**
|
|
1854
|
+
* List Invoices
|
|
1855
|
+
* List payment history and invoices.
|
|
1856
|
+
*
|
|
1857
|
+
* Returns past invoices with payment status, amounts, and line items.
|
|
1858
|
+
*/
|
|
1859
|
+
export declare const listInvoices: <ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>) => import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
1860
|
+
/**
|
|
1861
|
+
* Get Upcoming Invoice
|
|
1862
|
+
* Get preview of the next invoice.
|
|
1863
|
+
*
|
|
1864
|
+
* Returns estimated charges for the next billing period.
|
|
1865
|
+
*/
|
|
1866
|
+
export declare const getUpcomingInvoice: <ThrowOnError extends boolean = false>(options?: Options<GetUpcomingInvoiceData, ThrowOnError>) => import("./client").RequestResult<GetUpcomingInvoiceResponses, unknown, ThrowOnError, "fields">;
|
|
1867
|
+
/**
|
|
1868
|
+
* List All Subscriptions
|
|
1869
|
+
* List all active and past subscriptions for the user.
|
|
1870
|
+
*
|
|
1871
|
+
* Includes both graph and repository subscriptions with their status, pricing, and billing information.
|
|
1872
|
+
*/
|
|
1873
|
+
export declare const listSubscriptions: <ThrowOnError extends boolean = false>(options?: Options<ListSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<ListSubscriptionsResponses, unknown, ThrowOnError, "fields">;
|
|
1874
|
+
/**
|
|
1875
|
+
* Get Subscription Details
|
|
1876
|
+
* Get detailed information about a specific subscription.
|
|
1877
|
+
*/
|
|
1878
|
+
export declare const getSubscription: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionData, ThrowOnError>) => import("./client").RequestResult<GetSubscriptionResponses, GetSubscriptionErrors, ThrowOnError, "fields">;
|
|
1879
|
+
/**
|
|
1880
|
+
* Cancel Subscription
|
|
1881
|
+
* Cancel a subscription.
|
|
1882
|
+
*
|
|
1883
|
+
* The subscription will remain active until the end of the current billing period.
|
|
1884
|
+
*/
|
|
1885
|
+
export declare const cancelSubscription2: <ThrowOnError extends boolean = false>(options: Options<CancelSubscription2Data, ThrowOnError>) => import("./client").RequestResult<CancelSubscription2Responses, CancelSubscription2Errors, ThrowOnError, "fields">;
|