@robosystems/client 0.1.14 → 0.1.15
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/README.md +3 -5
- package/package.json +2 -2
- package/prepare.js +15 -16
- package/sdk.gen.d.ts +46 -48
- package/sdk.gen.js +83 -69
- package/sdk.gen.ts +82 -68
- package/types.gen.d.ts +74 -90
- package/types.gen.ts +84 -93
package/README.md
CHANGED
|
@@ -439,17 +439,15 @@ client.setConfig({
|
|
|
439
439
|
|
|
440
440
|
## API Reference
|
|
441
441
|
|
|
442
|
-
- Full API documentation: [https://api.robosystems.ai
|
|
442
|
+
- Full API documentation: [https://api.robosystems.ai](https://api.robosystems.ai)
|
|
443
443
|
- OpenAPI specification: [https://api.robosystems.ai/openapi.json](https://api.robosystems.ai/openapi.json)
|
|
444
444
|
|
|
445
445
|
## Support
|
|
446
446
|
|
|
447
|
-
-
|
|
448
|
-
- Issues: [GitHub Issues](https://github.com/HarbingerFinLab/robosystems-typescript-client/issues)
|
|
449
|
-
- Email: support@robosystems.ai
|
|
447
|
+
- Issues: [GitHub Issues](https://github.com/RoboFinSystems/robosystems-typescript-client/issues)
|
|
450
448
|
|
|
451
449
|
## License
|
|
452
450
|
|
|
453
451
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
454
452
|
|
|
455
|
-
MIT ©
|
|
453
|
+
MIT © 2025 Harbinger FinLab
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@robosystems/client",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.15",
|
|
4
4
|
"description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"types": "index.d.ts",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"scripts": {
|
|
19
19
|
"generate": "npm run generate:clean && npm run generate:sdk && npm run generate:fix && npm run format && npm run lint:fix",
|
|
20
20
|
"generate:clean": "rm -rf sdk",
|
|
21
|
-
"generate:sdk": "
|
|
21
|
+
"generate:sdk": "npx @hey-api/openapi-ts -f openapi-ts.config.js",
|
|
22
22
|
"generate:fix": "node scripts/fix-sdk-types.js",
|
|
23
23
|
"format": "prettier . --write",
|
|
24
24
|
"format:check": "prettier . --check",
|
package/prepare.js
CHANGED
|
@@ -93,30 +93,29 @@ if (fs.existsSync(extensionsSourceDir)) {
|
|
|
93
93
|
// The TypeScript compiler will have already built these files
|
|
94
94
|
// Just copy the compiled .js and .d.ts files
|
|
95
95
|
const sdkExtensionsBuilt = fs.readdirSync(extensionsSourceDir)
|
|
96
|
-
|
|
96
|
+
|
|
97
97
|
sdkExtensionsBuilt.forEach((file) => {
|
|
98
98
|
const sourcePath = path.join(extensionsSourceDir, file)
|
|
99
99
|
const destPath = path.join(extensionsDestDir, file)
|
|
100
|
-
|
|
100
|
+
|
|
101
101
|
if (file.endsWith('.js') || file.endsWith('.d.ts')) {
|
|
102
102
|
// Copy compiled JavaScript and declaration files
|
|
103
103
|
let content = fs.readFileSync(sourcePath, 'utf8')
|
|
104
|
-
|
|
104
|
+
|
|
105
105
|
// Fix imports for published package structure (../sdk/ -> ../)
|
|
106
106
|
content = content
|
|
107
107
|
.replace(/require\("\.\.\/sdk\//g, 'require("../')
|
|
108
108
|
.replace(/from ['"]\.\.\/sdk\//g, "from '../")
|
|
109
|
-
|
|
109
|
+
|
|
110
110
|
fs.writeFileSync(destPath, content)
|
|
111
111
|
console.log(` ✓ Copied and fixed ${file}`)
|
|
112
112
|
} else if (file.endsWith('.ts') && !file.endsWith('.d.ts')) {
|
|
113
113
|
// Copy TypeScript source files for reference
|
|
114
114
|
let content = fs.readFileSync(sourcePath, 'utf8')
|
|
115
|
-
|
|
115
|
+
|
|
116
116
|
// Adjust imports for published package structure
|
|
117
|
-
content = content
|
|
118
|
-
|
|
119
|
-
|
|
117
|
+
content = content.replace(/from ['"]\.\.\/sdk\//g, "from '../")
|
|
118
|
+
|
|
120
119
|
fs.writeFileSync(destPath, content)
|
|
121
120
|
console.log(` ✓ Copied ${file}`)
|
|
122
121
|
}
|
|
@@ -131,20 +130,20 @@ if (fs.existsSync(extensionsSourceDir)) {
|
|
|
131
130
|
// Create README if it doesn't exist
|
|
132
131
|
const readmePath = path.join(currentDir, 'README.md')
|
|
133
132
|
if (!fs.existsSync(readmePath)) {
|
|
134
|
-
const readmeContent = `# RoboSystems TypeScript
|
|
133
|
+
const readmeContent = `# RoboSystems TypeScript Client
|
|
135
134
|
|
|
136
|
-
Official TypeScript
|
|
135
|
+
Official TypeScript Client for the RoboSystems Financial Knowledge Graph API with SSE support.
|
|
137
136
|
|
|
138
137
|
## Installation
|
|
139
138
|
|
|
140
139
|
\`\`\`bash
|
|
141
|
-
npm install @robosystems/
|
|
140
|
+
npm install @robosystems/client
|
|
142
141
|
\`\`\`
|
|
143
142
|
|
|
144
143
|
## Quick Start
|
|
145
144
|
|
|
146
145
|
\`\`\`typescript
|
|
147
|
-
import { client, getCurrentUser, extensions } from '@robosystems/
|
|
146
|
+
import { client, getCurrentUser, extensions } from '@robosystems/client';
|
|
148
147
|
|
|
149
148
|
// Configure the client
|
|
150
149
|
client.setConfig({
|
|
@@ -152,10 +151,10 @@ client.setConfig({
|
|
|
152
151
|
credentials: 'include'
|
|
153
152
|
});
|
|
154
153
|
|
|
155
|
-
// Use the
|
|
154
|
+
// Use the Client
|
|
156
155
|
const { data: user } = await getCurrentUser();
|
|
157
156
|
|
|
158
|
-
// Use
|
|
157
|
+
// Use Client Extensions for enhanced features
|
|
159
158
|
const result = await extensions.query.query('graph_123', 'MATCH (n) RETURN n LIMIT 10');
|
|
160
159
|
|
|
161
160
|
// Monitor async operations with SSE
|
|
@@ -166,7 +165,7 @@ const opResult = await extensions.operations.monitorOperation('operation_123', {
|
|
|
166
165
|
|
|
167
166
|
## Features
|
|
168
167
|
|
|
169
|
-
- **Generated
|
|
168
|
+
- **Generated Client**: Auto-generated from OpenAPI spec
|
|
170
169
|
- **SSE Support**: Real-time updates for async operations
|
|
171
170
|
- **Query Client**: Enhanced query execution with streaming
|
|
172
171
|
- **Operation Monitoring**: Track long-running operations
|
|
@@ -174,7 +173,7 @@ const opResult = await extensions.operations.monitorOperation('operation_123', {
|
|
|
174
173
|
|
|
175
174
|
## Documentation
|
|
176
175
|
|
|
177
|
-
Full documentation available at [https://api.robosystems.ai
|
|
176
|
+
Full documentation available at [https://api.robosystems.ai](https://api.robosystems.ai)
|
|
178
177
|
`
|
|
179
178
|
|
|
180
179
|
fs.writeFileSync(readmePath, readmeContent)
|
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, LogoutUserErrors, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshSessionData, RefreshSessionResponses, RefreshSessionErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoLoginData, SsoLoginResponses, SsoLoginErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, GetServiceStatusData, GetServiceStatusResponses,
|
|
2
|
+
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, GetCaptchaConfigData, GetCaptchaConfigResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, 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, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetUserUsageOverviewErrors, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, QueryFinancialAgentData, QueryFinancialAgentResponses, QueryFinancialAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, ExportBackupData, ExportBackupResponses, ExportBackupErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, KuzuBackupHealthData, KuzuBackupHealthResponses, KuzuBackupHealthErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaInfoData, GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ListSchemaExtensionsData, ListSchemaExtensionsResponses, ListSchemaExtensionsErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphPricingInfoV1GraphIdBillingPricingGetData, GetGraphPricingInfoV1GraphIdBillingPricingGetResponses, GetGraphPricingInfoV1GraphIdBillingPricingGetErrors, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostData, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostResponses, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostErrors, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetData, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetResponses, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetErrors, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetData, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetResponses, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetErrors, GetCreditBillingInfoV1GraphIdBillingCreditsGetData, GetCreditBillingInfoV1GraphIdBillingCreditsGetResponses, GetCreditBillingInfoV1GraphIdBillingCreditsGetErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } 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
|
|
@@ -78,11 +78,6 @@ export declare const checkPasswordStrength: <ThrowOnError extends boolean = fals
|
|
|
78
78
|
* Service health check endpoint for monitoring and load balancers
|
|
79
79
|
*/
|
|
80
80
|
export declare const getServiceStatus: <ThrowOnError extends boolean = false>(options?: Options<GetServiceStatusData, ThrowOnError>) => import("./client").RequestResult<GetServiceStatusResponses, unknown, ThrowOnError, "fields">;
|
|
81
|
-
/**
|
|
82
|
-
* MCP System Health Check
|
|
83
|
-
* Basic health check for MCP system components
|
|
84
|
-
*/
|
|
85
|
-
export declare const getMcpHealth: <ThrowOnError extends boolean = false>(options?: Options<GetMcpHealthData, ThrowOnError>) => import("./client").RequestResult<GetMcpHealthResponses, unknown, ThrowOnError, "fields">;
|
|
86
81
|
/**
|
|
87
82
|
* Get Current User
|
|
88
83
|
* Returns information about the currently authenticated user.
|
|
@@ -149,6 +144,24 @@ export declare const getUserLimits: <ThrowOnError extends boolean = false>(optio
|
|
|
149
144
|
* Retrieve current usage statistics and remaining limits for the authenticated user
|
|
150
145
|
*/
|
|
151
146
|
export declare const getUserUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageResponses, GetUserUsageErrors, ThrowOnError, "fields">;
|
|
147
|
+
/**
|
|
148
|
+
* Get shared repository rate limit status
|
|
149
|
+
* Get current rate limit status and usage for a shared repository.
|
|
150
|
+
*
|
|
151
|
+
* Returns:
|
|
152
|
+
* - Current usage across different time windows
|
|
153
|
+
* - Rate limits based on subscription tier
|
|
154
|
+
* - Remaining quota
|
|
155
|
+
* - Reset times
|
|
156
|
+
*
|
|
157
|
+
* Note: All queries are FREE - this only shows rate limit status.
|
|
158
|
+
*/
|
|
159
|
+
export declare const getSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options: Options<GetSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
|
|
160
|
+
/**
|
|
161
|
+
* Get all shared repository limits
|
|
162
|
+
* Get rate limit status for all shared repositories the user has access to.
|
|
163
|
+
*/
|
|
164
|
+
export declare const getAllSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
|
|
152
165
|
/**
|
|
153
166
|
* Get User Usage Overview
|
|
154
167
|
* Get a high-level overview of usage statistics for the current user.
|
|
@@ -186,7 +199,7 @@ export declare const cancelSharedRepositorySubscription: <ThrowOnError extends b
|
|
|
186
199
|
export declare const getSharedRepositoryCredits: <ThrowOnError extends boolean = false>(options?: Options<GetSharedRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, ThrowOnError, "fields">;
|
|
187
200
|
/**
|
|
188
201
|
* Get Repository Credits
|
|
189
|
-
* Get credit balance for a specific shared repository
|
|
202
|
+
* Get credit balance for a specific shared repository
|
|
190
203
|
*/
|
|
191
204
|
export declare const getRepositoryCredits: <ThrowOnError extends boolean = false>(options: Options<GetRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ThrowOnError, "fields">;
|
|
192
205
|
/**
|
|
@@ -252,10 +265,8 @@ export declare const listConnections: <ThrowOnError extends boolean = false>(opt
|
|
|
252
265
|
* - User completes bank authentication
|
|
253
266
|
* - Exchange public token for access
|
|
254
267
|
*
|
|
255
|
-
*
|
|
256
|
-
* -
|
|
257
|
-
* - Multiplied by graph tier
|
|
258
|
-
* - Additional credits consumed during data sync
|
|
268
|
+
* Note:
|
|
269
|
+
* This operation is FREE - no credit consumption required.
|
|
259
270
|
*/
|
|
260
271
|
export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => import("./client").RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError, "fields">;
|
|
261
272
|
/**
|
|
@@ -268,9 +279,8 @@ export declare const createConnection: <ThrowOnError extends boolean = false>(op
|
|
|
268
279
|
* - Performs provider-specific cleanup
|
|
269
280
|
* - Revokes stored credentials
|
|
270
281
|
*
|
|
271
|
-
*
|
|
272
|
-
* -
|
|
273
|
-
* - Multiplied by graph tier
|
|
282
|
+
* Note:
|
|
283
|
+
* This operation is FREE - no credit consumption required.
|
|
274
284
|
*
|
|
275
285
|
* Only users with admin role can delete connections.
|
|
276
286
|
*/
|
|
@@ -311,10 +321,8 @@ export declare const getConnection: <ThrowOnError extends boolean = false>(optio
|
|
|
311
321
|
* - Updates account balances
|
|
312
322
|
* - Categorizes new transactions
|
|
313
323
|
*
|
|
314
|
-
*
|
|
315
|
-
* -
|
|
316
|
-
* - Multiplied by graph tier
|
|
317
|
-
* - Additional credits may be consumed during processing
|
|
324
|
+
* Note:
|
|
325
|
+
* This operation is FREE - no credit consumption required.
|
|
318
326
|
*
|
|
319
327
|
* Returns a task ID for monitoring sync progress.
|
|
320
328
|
*/
|
|
@@ -434,10 +442,10 @@ export declare const oauthCallback: <ThrowOnError extends boolean = false>(optio
|
|
|
434
442
|
* - Fallback to status polling endpoint if SSE unavailable
|
|
435
443
|
*
|
|
436
444
|
* **Credit Consumption:**
|
|
437
|
-
* -
|
|
438
|
-
* -
|
|
439
|
-
* -
|
|
440
|
-
* -
|
|
445
|
+
* - AI operations consume credits based on actual token usage
|
|
446
|
+
* - Claude 4 Opus: ~15 credits per 1K input tokens, ~75 credits per 1K output tokens
|
|
447
|
+
* - Claude 4 Sonnet: ~3 credits per 1K input tokens, ~15 credits per 1K output tokens
|
|
448
|
+
* - Credits are consumed after operation completes based on actual usage
|
|
441
449
|
*
|
|
442
450
|
* The agent automatically determines query complexity or you can force extended analysis.
|
|
443
451
|
*/
|
|
@@ -495,11 +503,8 @@ export declare const listMcpTools: <ThrowOnError extends boolean = false>(option
|
|
|
495
503
|
* - `408 Request Timeout`: Tool execution exceeded timeout
|
|
496
504
|
* - Clients should implement exponential backoff on errors
|
|
497
505
|
*
|
|
498
|
-
* **
|
|
499
|
-
*
|
|
500
|
-
* - Schema tools: 5-10 credits
|
|
501
|
-
* - Query tools: 10-50 credits (based on complexity)
|
|
502
|
-
* - Multiplied by graph tier
|
|
506
|
+
* **Note:**
|
|
507
|
+
* MCP tool calls are currently FREE and do not consume credits.
|
|
503
508
|
*/
|
|
504
509
|
export declare const callMcpTool: <ThrowOnError extends boolean = false>(options: Options<CallMcpToolData, ThrowOnError>) => import("./client").RequestResult<CallMcpToolResponses, CallMcpToolErrors, ThrowOnError, "fields">;
|
|
505
510
|
/**
|
|
@@ -636,9 +641,8 @@ export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false
|
|
|
636
641
|
* - Capacity planning
|
|
637
642
|
* - Performance optimization
|
|
638
643
|
*
|
|
639
|
-
*
|
|
640
|
-
* -
|
|
641
|
-
* - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
|
|
644
|
+
* Note:
|
|
645
|
+
* This operation is FREE - no credit consumption required.
|
|
642
646
|
*/
|
|
643
647
|
export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => import("./client").RequestResult<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError, "fields">;
|
|
644
648
|
/**
|
|
@@ -664,9 +668,8 @@ export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(opt
|
|
|
664
668
|
* - Usage trend analysis
|
|
665
669
|
* - Performance tuning
|
|
666
670
|
*
|
|
667
|
-
*
|
|
668
|
-
* -
|
|
669
|
-
* - Multiplied by graph tier
|
|
671
|
+
* Note:
|
|
672
|
+
* This operation is FREE - no credit consumption required.
|
|
670
673
|
*/
|
|
671
674
|
export declare const getGraphUsageStats: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageStatsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ThrowOnError, "fields">;
|
|
672
675
|
/**
|
|
@@ -682,7 +685,7 @@ export declare const getGraphUsageStats: <ThrowOnError extends boolean = false>(
|
|
|
682
685
|
* **Response Modes:**
|
|
683
686
|
* - `auto` (default): Intelligent automatic selection
|
|
684
687
|
* - `sync`: Force synchronous JSON response (best for testing)
|
|
685
|
-
* - `async`: Force queued response with polling
|
|
688
|
+
* - `async`: Force queued response with SSE monitoring endpoints (no polling needed)
|
|
686
689
|
* - `stream`: Force streaming response (SSE or NDJSON)
|
|
687
690
|
*
|
|
688
691
|
* **Client Detection:**
|
|
@@ -705,19 +708,19 @@ export declare const getGraphUsageStats: <ThrowOnError extends boolean = false>(
|
|
|
705
708
|
*
|
|
706
709
|
* **Queue Management:**
|
|
707
710
|
* - Automatic queuing under high load
|
|
708
|
-
* -
|
|
711
|
+
* - Real-time monitoring via SSE events (no polling needed)
|
|
709
712
|
* - Priority based on subscription tier
|
|
710
|
-
* - Queue position updates via SSE
|
|
713
|
+
* - Queue position and progress updates pushed via SSE
|
|
714
|
+
* - Connect to returned `/v1/operations/{id}/stream` endpoint for updates
|
|
711
715
|
*
|
|
712
716
|
* **Error Handling:**
|
|
713
717
|
* - `429 Too Many Requests`: Rate limit or connection limit exceeded
|
|
714
718
|
* - `503 Service Unavailable`: Circuit breaker open or SSE disabled
|
|
715
719
|
* - Clients should implement exponential backoff
|
|
716
720
|
*
|
|
717
|
-
* **
|
|
718
|
-
*
|
|
719
|
-
*
|
|
720
|
-
* - Queue position based on subscription tier
|
|
721
|
+
* **Note:**
|
|
722
|
+
* Query operations are FREE - no credit consumption required.
|
|
723
|
+
* Queue position is based on subscription tier for priority.
|
|
721
724
|
*/
|
|
722
725
|
export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherQueryData, ThrowOnError>) => import("./client").RequestResult<ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, ThrowOnError, "fields">;
|
|
723
726
|
/**
|
|
@@ -732,10 +735,7 @@ export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(
|
|
|
732
735
|
* This is different from custom schema management - it shows what actually exists in the database,
|
|
733
736
|
* useful for understanding the current graph structure before writing queries.
|
|
734
737
|
*
|
|
735
|
-
*
|
|
736
|
-
* - Base cost: 2.0 credits
|
|
737
|
-
* - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
|
|
738
|
-
* - Schema information is cached for performance
|
|
738
|
+
* This operation is FREE - no credit consumption required.
|
|
739
739
|
*/
|
|
740
740
|
export declare const getGraphSchemaInfo: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaInfoData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ThrowOnError, "fields">;
|
|
741
741
|
/**
|
|
@@ -761,9 +761,7 @@ export declare const getGraphSchemaInfo: <ThrowOnError extends boolean = false>(
|
|
|
761
761
|
* - Performance problems
|
|
762
762
|
* - Naming conflicts
|
|
763
763
|
*
|
|
764
|
-
*
|
|
765
|
-
* - Base cost: 5.0 credits
|
|
766
|
-
* - Multiplied by graph tier
|
|
764
|
+
* This operation is FREE - no credit consumption required.
|
|
767
765
|
*/
|
|
768
766
|
export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
|
|
769
767
|
/**
|
|
@@ -1051,7 +1049,7 @@ export declare const getAvailableExtensions: <ThrowOnError extends boolean = fal
|
|
|
1051
1049
|
* applications to display subscription options.
|
|
1052
1050
|
*
|
|
1053
1051
|
* Includes:
|
|
1054
|
-
* - Graph subscription tiers (
|
|
1052
|
+
* - Graph subscription tiers (standard, enterprise, premium)
|
|
1055
1053
|
* - Shared repository subscriptions (SEC, industry, economic data)
|
|
1056
1054
|
* - Operation costs and credit information
|
|
1057
1055
|
* - Features and capabilities for each tier
|