@robosystems/client 0.2.44 → 0.2.46
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/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +4 -7
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +3 -50
- package/sdk/sdk.gen.js +7 -69
- package/sdk/sdk.gen.ts +5 -67
- package/sdk/types.gen.d.ts +86 -225
- package/sdk/types.gen.ts +88 -241
- package/sdk.gen.d.ts +3 -50
- package/sdk.gen.js +7 -69
- package/sdk.gen.ts +5 -67
- package/types.gen.d.ts +86 -225
- package/types.gen.ts +88 -241
package/sdk/sdk.gen.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = exports.batchProcessQueries = exports.executeSpecificAgent = exports.getAgentMetadata = exports.autoSelectAgent = exports.listAgents = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.oauthCallback = exports.initOAuth = exports.getConnectionOptions = exports.createConnection = exports.listConnections = exports.getOrgUsage = exports.getOrgLimits = exports.updateOrgMemberRole = exports.removeOrgMember = exports.inviteOrgMember = exports.listOrgMembers = exports.listOrgGraphs = exports.updateOrg = exports.getOrg = exports.listUserOrgs = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getCaptchaConfig = exports.completeSsoAuth = exports.ssoTokenExchange = exports.generateSsoToken = exports.resetPassword = exports.validateResetToken = exports.forgotPassword = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.verifyEmail = exports.resendVerificationEmail = exports.refreshAuthSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
|
|
5
|
-
exports.getGraphCapacity = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.updateFile = exports.getFile = exports.deleteFile = exports.createFileUpload = exports.listFiles = exports.materializeGraph = exports.getMaterializationStatus = exports.uploadDocumentsBulk = exports.updateDocument = exports.getDocument = exports.deleteDocument = exports.uploadDocument = exports.listDocuments = exports.getDocumentSection = exports.searchDocuments = exports.createView = exports.queryTables = exports.listTables = exports.createRepositorySubscription = exports.changeRepositoryPlan = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.
|
|
6
|
-
exports.listPublishLists = exports.createClosingEntry = exports.getPeriodCloseStatus = exports.getScheduleFacts = exports.createSchedule = exports.listSchedules = exports.shareReport = exports.regenerateReport = exports.getStatement = exports.getReport = exports.deleteReport = exports.createReport = exports.listReports = exports.getLedgerSummary = exports.getLedgerTrialBalance = exports.getLedgerTransaction = exports.listLedgerTransactions = exports.autoMapElements = exports.getMappedTrialBalance = exports.getMappingCoverage = exports.deleteMappingAssociation = exports.createMappingAssociation = exports.getMappingDetail = exports.listMappings = exports.createStructure = exports.listStructures = exports.listUnmappedElements = exports.listElements = exports.getReportingTaxonomy = exports.createTaxonomy = exports.listTaxonomies = exports.getLedgerAccountTree = exports.listLedgerAccounts = exports.listLedgerEntities = exports.updateLedgerEntity = exports.getLedgerEntity = exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus =
|
|
7
|
-
exports.listHoldings = exports.updatePosition = exports.getPosition = exports.deletePosition = exports.createPosition = exports.listPositions = exports.updateSecurity = exports.getSecurity = exports.deleteSecurity = exports.createSecurity = exports.listSecurities = exports.updatePortfolio = exports.getPortfolio = exports.deletePortfolio = exports.createPortfolio = exports.listPortfolios = exports.removePublishListMember = exports.addPublishListMembers = exports.updatePublishList =
|
|
5
|
+
exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getGraphCapacity = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.updateFile = exports.getFile = exports.deleteFile = exports.createFileUpload = exports.listFiles = exports.materializeGraph = exports.getMaterializationStatus = exports.uploadDocumentsBulk = exports.updateDocument = exports.getDocument = exports.deleteDocument = exports.uploadDocument = exports.listDocuments = exports.getDocumentSection = exports.searchDocuments = exports.createView = exports.queryTables = exports.listTables = exports.createRepositorySubscription = exports.changeRepositoryPlan = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.listCreditTransactions = exports.getCreditSummary = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = exports.getGraphUsageAnalytics = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.createBackup = exports.listBackups = void 0;
|
|
6
|
+
exports.getPublishList = exports.deletePublishList = exports.createPublishList = exports.listPublishLists = exports.createClosingEntry = exports.getPeriodCloseStatus = exports.getScheduleFacts = exports.createSchedule = exports.listSchedules = exports.shareReport = exports.regenerateReport = exports.getStatement = exports.getReport = exports.deleteReport = exports.createReport = exports.listReports = exports.getLedgerSummary = exports.getLedgerTrialBalance = exports.getLedgerTransaction = exports.listLedgerTransactions = exports.autoMapElements = exports.getMappedTrialBalance = exports.getMappingCoverage = exports.deleteMappingAssociation = exports.createMappingAssociation = exports.getMappingDetail = exports.listMappings = exports.createStructure = exports.listStructures = exports.listUnmappedElements = exports.listElements = exports.getReportingTaxonomy = exports.createTaxonomy = exports.listTaxonomies = exports.getLedgerAccountTree = exports.listLedgerAccounts = exports.listLedgerEntities = exports.updateLedgerEntity = exports.getLedgerEntity = exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus = void 0;
|
|
7
|
+
exports.listHoldings = exports.updatePosition = exports.getPosition = exports.deletePosition = exports.createPosition = exports.listPositions = exports.updateSecurity = exports.getSecurity = exports.deleteSecurity = exports.createSecurity = exports.listSecurities = exports.updatePortfolio = exports.getPortfolio = exports.deletePortfolio = exports.createPortfolio = exports.listPortfolios = exports.removePublishListMember = exports.addPublishListMembers = exports.updatePublishList = void 0;
|
|
8
8
|
const client_gen_1 = require("./client.gen");
|
|
9
9
|
/**
|
|
10
10
|
* Register New User
|
|
@@ -1398,7 +1398,7 @@ exports.validateSchema = validateSchema;
|
|
|
1398
1398
|
*/
|
|
1399
1399
|
const getCreditSummary = (options) => (options.client ?? client_gen_1.client).get({
|
|
1400
1400
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1401
|
-
url: '/v1/graphs/{graph_id}/credits
|
|
1401
|
+
url: '/v1/graphs/{graph_id}/credits',
|
|
1402
1402
|
...options
|
|
1403
1403
|
});
|
|
1404
1404
|
exports.getCreditSummary = getCreditSummary;
|
|
@@ -1427,67 +1427,6 @@ const listCreditTransactions = (options) => (options.client ?? client_gen_1.clie
|
|
|
1427
1427
|
...options
|
|
1428
1428
|
});
|
|
1429
1429
|
exports.listCreditTransactions = listCreditTransactions;
|
|
1430
|
-
/**
|
|
1431
|
-
* Check Credit Balance
|
|
1432
|
-
*
|
|
1433
|
-
* Check if the graph has sufficient credits for a planned operation.
|
|
1434
|
-
*
|
|
1435
|
-
* This endpoint allows you to verify credit availability before performing
|
|
1436
|
-
* an operation, helping prevent failed operations due to insufficient credits.
|
|
1437
|
-
*
|
|
1438
|
-
* The check considers:
|
|
1439
|
-
* - Base operation cost
|
|
1440
|
-
* - Graph tier multiplier
|
|
1441
|
-
* - Current credit balance
|
|
1442
|
-
*
|
|
1443
|
-
* No credits are consumed for checking availability.
|
|
1444
|
-
*/
|
|
1445
|
-
const checkCreditBalance = (options) => (options.client ?? client_gen_1.client).get({
|
|
1446
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1447
|
-
url: '/v1/graphs/{graph_id}/credits/balance/check',
|
|
1448
|
-
...options
|
|
1449
|
-
});
|
|
1450
|
-
exports.checkCreditBalance = checkCreditBalance;
|
|
1451
|
-
/**
|
|
1452
|
-
* Get Storage Usage
|
|
1453
|
-
*
|
|
1454
|
-
* Get storage usage history for a graph.
|
|
1455
|
-
*
|
|
1456
|
-
* Returns detailed storage usage information including:
|
|
1457
|
-
* - Daily average storage consumption
|
|
1458
|
-
* - Storage trends over time
|
|
1459
|
-
* - Credit costs for storage
|
|
1460
|
-
* - Current storage billing information
|
|
1461
|
-
*
|
|
1462
|
-
* This endpoint helps users understand their storage patterns
|
|
1463
|
-
* and associated credit costs.
|
|
1464
|
-
*/
|
|
1465
|
-
const getStorageUsage = (options) => (options.client ?? client_gen_1.client).get({
|
|
1466
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1467
|
-
url: '/v1/graphs/{graph_id}/credits/storage/usage',
|
|
1468
|
-
...options
|
|
1469
|
-
});
|
|
1470
|
-
exports.getStorageUsage = getStorageUsage;
|
|
1471
|
-
/**
|
|
1472
|
-
* Check Storage Limits
|
|
1473
|
-
*
|
|
1474
|
-
* Check storage limits and usage for a graph.
|
|
1475
|
-
*
|
|
1476
|
-
* Returns comprehensive storage limit information including:
|
|
1477
|
-
* - Current storage usage
|
|
1478
|
-
* - Effective limit (override or default)
|
|
1479
|
-
* - Usage percentage and warnings
|
|
1480
|
-
* - Recommendations for limit management
|
|
1481
|
-
*
|
|
1482
|
-
* This endpoint helps users monitor storage usage and plan for potential
|
|
1483
|
-
* limit increases. No credits are consumed for checking storage limits.
|
|
1484
|
-
*/
|
|
1485
|
-
const checkStorageLimits = (options) => (options.client ?? client_gen_1.client).get({
|
|
1486
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1487
|
-
url: '/v1/graphs/{graph_id}/credits/storage/limits',
|
|
1488
|
-
...options
|
|
1489
|
-
});
|
|
1490
|
-
exports.checkStorageLimits = checkStorageLimits;
|
|
1491
1430
|
/**
|
|
1492
1431
|
* Database Health Check
|
|
1493
1432
|
*
|
|
@@ -1569,9 +1508,8 @@ exports.getDatabaseInfo = getDatabaseInfo;
|
|
|
1569
1508
|
* - **Backup Limits**: Frequency, retention, size limits
|
|
1570
1509
|
* - **Rate Limits**: Requests per minute/hour based on tier
|
|
1571
1510
|
* - **Credit Limits**: AI operation credits (if applicable)
|
|
1572
|
-
* - **Content Limits**:
|
|
1573
|
-
*
|
|
1574
|
-
* This unified endpoint provides all limits in one place for easier client integration.
|
|
1511
|
+
* - **Content Limits**: Per-operation materialization limits (if applicable)
|
|
1512
|
+
* - **Instance Usage**: Aggregate storage across parent + subgraphs (user graphs only)
|
|
1575
1513
|
*
|
|
1576
1514
|
* **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
|
|
1577
1515
|
*/
|
|
@@ -2070,7 +2008,7 @@ exports.uploadDocumentsBulk = uploadDocumentsBulk;
|
|
|
2070
2008
|
*/
|
|
2071
2009
|
const getMaterializationStatus = (options) => (options.client ?? client_gen_1.client).get({
|
|
2072
2010
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2073
|
-
url: '/v1/graphs/{graph_id}/materialize
|
|
2011
|
+
url: '/v1/graphs/{graph_id}/materialize',
|
|
2074
2012
|
...options
|
|
2075
2013
|
});
|
|
2076
2014
|
exports.getMaterializationStatus = getMaterializationStatus;
|
package/sdk/sdk.gen.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
4
4
|
import { client } from './client.gen';
|
|
5
|
-
import type { AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectAgentData, AutoSelectAgentErrors, AutoSelectAgentResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, ChangeRepositoryPlanData, ChangeRepositoryPlanErrors, ChangeRepositoryPlanResponses, CheckCreditBalanceData, CheckCreditBalanceErrors, CheckCreditBalanceResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CheckStorageLimitsData, CheckStorageLimitsErrors, CheckStorageLimitsResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateClosingEntryData, CreateClosingEntryErrors, CreateClosingEntryResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioData, CreatePortfolioErrors, CreatePortfolioResponses, CreatePositionData, CreatePositionErrors, CreatePositionResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateScheduleData, CreateScheduleErrors, CreateScheduleResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateStructureData, CreateStructureErrors, CreateStructureResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyData, CreateTaxonomyErrors, CreateTaxonomyResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, CreateViewData, CreateViewErrors, CreateViewResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioData, DeletePortfolioErrors, DeletePortfolioResponses, DeletePositionData, DeletePositionErrors, DeletePositionResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificAgentData, ExecuteSpecificAgentErrors, ExecuteSpecificAgentResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAgentMetadataData, GetAgentMetadataErrors, GetAgentMetadataResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetLedgerAccountTreeData, GetLedgerAccountTreeErrors, GetLedgerAccountTreeResponses, GetLedgerEntityData, GetLedgerEntityErrors, GetLedgerEntityResponses, GetLedgerSummaryData, GetLedgerSummaryErrors, GetLedgerSummaryResponses, GetLedgerTransactionData, GetLedgerTransactionErrors, GetLedgerTransactionResponses, GetLedgerTrialBalanceData, GetLedgerTrialBalanceErrors, GetLedgerTrialBalanceResponses, GetMappedTrialBalanceData, GetMappedTrialBalanceErrors, GetMappedTrialBalanceResponses, GetMappingCoverageData, GetMappingCoverageErrors, GetMappingCoverageResponses, GetMappingDetailData, GetMappingDetailErrors, GetMappingDetailResponses, GetMaterializationStatusData, GetMaterializationStatusErrors, GetMaterializationStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, GetPeriodCloseStatusData, GetPeriodCloseStatusErrors, GetPeriodCloseStatusResponses, GetPortfolioData, GetPortfolioErrors, GetPortfolioResponses, GetPositionData, GetPositionErrors, GetPositionResponses, GetPublishListData, GetPublishListErrors, GetPublishListResponses, GetReportData, GetReportErrors, GetReportingTaxonomyData, GetReportingTaxonomyErrors, GetReportingTaxonomyResponses, GetReportResponses, GetScheduleFactsData, GetScheduleFactsErrors, GetScheduleFactsResponses, GetSecurityData, GetSecurityErrors, GetSecurityResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetStatementData, GetStatementErrors, GetStatementResponses, GetStorageUsageData, GetStorageUsageErrors, GetStorageUsageResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListElementsData, ListElementsErrors, ListElementsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListHoldingsData, ListHoldingsErrors, ListHoldingsResponses, ListLedgerAccountsData, ListLedgerAccountsErrors, ListLedgerAccountsResponses, ListLedgerEntitiesData, ListLedgerEntitiesErrors, ListLedgerEntitiesResponses, ListLedgerTransactionsData, ListLedgerTransactionsErrors, ListLedgerTransactionsResponses, ListMappingsData, ListMappingsErrors, ListMappingsResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListPortfoliosData, ListPortfoliosErrors, ListPortfoliosResponses, ListPositionsData, ListPositionsErrors, ListPositionsResponses, ListPublishListsData, ListPublishListsErrors, ListPublishListsResponses, ListReportsData, ListReportsErrors, ListReportsResponses, ListSchedulesData, ListSchedulesErrors, ListSchedulesResponses, ListSecuritiesData, ListSecuritiesErrors, ListSecuritiesResponses, ListStructuresData, ListStructuresErrors, ListStructuresResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListTaxonomiesData, ListTaxonomiesErrors, ListTaxonomiesResponses, ListUnmappedElementsData, ListUnmappedElementsErrors, ListUnmappedElementsResponses, ListUserApiKeysData, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserResponses, MaterializeGraphData, MaterializeGraphErrors, MaterializeGraphResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendAgentData, RecommendAgentErrors, RecommendAgentResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateLedgerEntityData, UpdateLedgerEntityErrors, UpdateLedgerEntityResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioData, UpdatePortfolioErrors, UpdatePortfolioResponses, UpdatePositionData, UpdatePositionErrors, UpdatePositionResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, UploadDocumentsBulkData, UploadDocumentsBulkErrors, UploadDocumentsBulkResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
5
|
+
import type { AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectAgentData, AutoSelectAgentErrors, AutoSelectAgentResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, ChangeRepositoryPlanData, ChangeRepositoryPlanErrors, ChangeRepositoryPlanResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateClosingEntryData, CreateClosingEntryErrors, CreateClosingEntryResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioData, CreatePortfolioErrors, CreatePortfolioResponses, CreatePositionData, CreatePositionErrors, CreatePositionResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateScheduleData, CreateScheduleErrors, CreateScheduleResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateStructureData, CreateStructureErrors, CreateStructureResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyData, CreateTaxonomyErrors, CreateTaxonomyResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, CreateViewData, CreateViewErrors, CreateViewResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioData, DeletePortfolioErrors, DeletePortfolioResponses, DeletePositionData, DeletePositionErrors, DeletePositionResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificAgentData, ExecuteSpecificAgentErrors, ExecuteSpecificAgentResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAgentMetadataData, GetAgentMetadataErrors, GetAgentMetadataResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetLedgerAccountTreeData, GetLedgerAccountTreeErrors, GetLedgerAccountTreeResponses, GetLedgerEntityData, GetLedgerEntityErrors, GetLedgerEntityResponses, GetLedgerSummaryData, GetLedgerSummaryErrors, GetLedgerSummaryResponses, GetLedgerTransactionData, GetLedgerTransactionErrors, GetLedgerTransactionResponses, GetLedgerTrialBalanceData, GetLedgerTrialBalanceErrors, GetLedgerTrialBalanceResponses, GetMappedTrialBalanceData, GetMappedTrialBalanceErrors, GetMappedTrialBalanceResponses, GetMappingCoverageData, GetMappingCoverageErrors, GetMappingCoverageResponses, GetMappingDetailData, GetMappingDetailErrors, GetMappingDetailResponses, GetMaterializationStatusData, GetMaterializationStatusErrors, GetMaterializationStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, GetPeriodCloseStatusData, GetPeriodCloseStatusErrors, GetPeriodCloseStatusResponses, GetPortfolioData, GetPortfolioErrors, GetPortfolioResponses, GetPositionData, GetPositionErrors, GetPositionResponses, GetPublishListData, GetPublishListErrors, GetPublishListResponses, GetReportData, GetReportErrors, GetReportingTaxonomyData, GetReportingTaxonomyErrors, GetReportingTaxonomyResponses, GetReportResponses, GetScheduleFactsData, GetScheduleFactsErrors, GetScheduleFactsResponses, GetSecurityData, GetSecurityErrors, GetSecurityResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetStatementData, GetStatementErrors, GetStatementResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListElementsData, ListElementsErrors, ListElementsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListHoldingsData, ListHoldingsErrors, ListHoldingsResponses, ListLedgerAccountsData, ListLedgerAccountsErrors, ListLedgerAccountsResponses, ListLedgerEntitiesData, ListLedgerEntitiesErrors, ListLedgerEntitiesResponses, ListLedgerTransactionsData, ListLedgerTransactionsErrors, ListLedgerTransactionsResponses, ListMappingsData, ListMappingsErrors, ListMappingsResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListPortfoliosData, ListPortfoliosErrors, ListPortfoliosResponses, ListPositionsData, ListPositionsErrors, ListPositionsResponses, ListPublishListsData, ListPublishListsErrors, ListPublishListsResponses, ListReportsData, ListReportsErrors, ListReportsResponses, ListSchedulesData, ListSchedulesErrors, ListSchedulesResponses, ListSecuritiesData, ListSecuritiesErrors, ListSecuritiesResponses, ListStructuresData, ListStructuresErrors, ListStructuresResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListTaxonomiesData, ListTaxonomiesErrors, ListTaxonomiesResponses, ListUnmappedElementsData, ListUnmappedElementsErrors, ListUnmappedElementsResponses, ListUserApiKeysData, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserResponses, MaterializeGraphData, MaterializeGraphErrors, MaterializeGraphResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendAgentData, RecommendAgentErrors, RecommendAgentResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateLedgerEntityData, UpdateLedgerEntityErrors, UpdateLedgerEntityResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioData, UpdatePortfolioErrors, UpdatePortfolioResponses, UpdatePositionData, UpdatePositionErrors, UpdatePositionResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, UploadDocumentsBulkData, UploadDocumentsBulkErrors, UploadDocumentsBulkResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
8
8
|
/**
|
|
@@ -1410,7 +1410,7 @@ export const validateSchema = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1410
1410
|
*/
|
|
1411
1411
|
export const getCreditSummary = <ThrowOnError extends boolean = false>(options: Options<GetCreditSummaryData, ThrowOnError>) => (options.client ?? client).get<GetCreditSummaryResponses, GetCreditSummaryErrors, ThrowOnError>({
|
|
1412
1412
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1413
|
-
url: '/v1/graphs/{graph_id}/credits
|
|
1413
|
+
url: '/v1/graphs/{graph_id}/credits',
|
|
1414
1414
|
...options
|
|
1415
1415
|
});
|
|
1416
1416
|
|
|
@@ -1439,67 +1439,6 @@ export const listCreditTransactions = <ThrowOnError extends boolean = false>(opt
|
|
|
1439
1439
|
...options
|
|
1440
1440
|
});
|
|
1441
1441
|
|
|
1442
|
-
/**
|
|
1443
|
-
* Check Credit Balance
|
|
1444
|
-
*
|
|
1445
|
-
* Check if the graph has sufficient credits for a planned operation.
|
|
1446
|
-
*
|
|
1447
|
-
* This endpoint allows you to verify credit availability before performing
|
|
1448
|
-
* an operation, helping prevent failed operations due to insufficient credits.
|
|
1449
|
-
*
|
|
1450
|
-
* The check considers:
|
|
1451
|
-
* - Base operation cost
|
|
1452
|
-
* - Graph tier multiplier
|
|
1453
|
-
* - Current credit balance
|
|
1454
|
-
*
|
|
1455
|
-
* No credits are consumed for checking availability.
|
|
1456
|
-
*/
|
|
1457
|
-
export const checkCreditBalance = <ThrowOnError extends boolean = false>(options: Options<CheckCreditBalanceData, ThrowOnError>) => (options.client ?? client).get<CheckCreditBalanceResponses, CheckCreditBalanceErrors, ThrowOnError>({
|
|
1458
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1459
|
-
url: '/v1/graphs/{graph_id}/credits/balance/check',
|
|
1460
|
-
...options
|
|
1461
|
-
});
|
|
1462
|
-
|
|
1463
|
-
/**
|
|
1464
|
-
* Get Storage Usage
|
|
1465
|
-
*
|
|
1466
|
-
* Get storage usage history for a graph.
|
|
1467
|
-
*
|
|
1468
|
-
* Returns detailed storage usage information including:
|
|
1469
|
-
* - Daily average storage consumption
|
|
1470
|
-
* - Storage trends over time
|
|
1471
|
-
* - Credit costs for storage
|
|
1472
|
-
* - Current storage billing information
|
|
1473
|
-
*
|
|
1474
|
-
* This endpoint helps users understand their storage patterns
|
|
1475
|
-
* and associated credit costs.
|
|
1476
|
-
*/
|
|
1477
|
-
export const getStorageUsage = <ThrowOnError extends boolean = false>(options: Options<GetStorageUsageData, ThrowOnError>) => (options.client ?? client).get<GetStorageUsageResponses, GetStorageUsageErrors, ThrowOnError>({
|
|
1478
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1479
|
-
url: '/v1/graphs/{graph_id}/credits/storage/usage',
|
|
1480
|
-
...options
|
|
1481
|
-
});
|
|
1482
|
-
|
|
1483
|
-
/**
|
|
1484
|
-
* Check Storage Limits
|
|
1485
|
-
*
|
|
1486
|
-
* Check storage limits and usage for a graph.
|
|
1487
|
-
*
|
|
1488
|
-
* Returns comprehensive storage limit information including:
|
|
1489
|
-
* - Current storage usage
|
|
1490
|
-
* - Effective limit (override or default)
|
|
1491
|
-
* - Usage percentage and warnings
|
|
1492
|
-
* - Recommendations for limit management
|
|
1493
|
-
*
|
|
1494
|
-
* This endpoint helps users monitor storage usage and plan for potential
|
|
1495
|
-
* limit increases. No credits are consumed for checking storage limits.
|
|
1496
|
-
*/
|
|
1497
|
-
export const checkStorageLimits = <ThrowOnError extends boolean = false>(options: Options<CheckStorageLimitsData, ThrowOnError>) => (options.client ?? client).get<CheckStorageLimitsResponses, CheckStorageLimitsErrors, ThrowOnError>({
|
|
1498
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1499
|
-
url: '/v1/graphs/{graph_id}/credits/storage/limits',
|
|
1500
|
-
...options
|
|
1501
|
-
});
|
|
1502
|
-
|
|
1503
1442
|
/**
|
|
1504
1443
|
* Database Health Check
|
|
1505
1444
|
*
|
|
@@ -1581,9 +1520,8 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
1581
1520
|
* - **Backup Limits**: Frequency, retention, size limits
|
|
1582
1521
|
* - **Rate Limits**: Requests per minute/hour based on tier
|
|
1583
1522
|
* - **Credit Limits**: AI operation credits (if applicable)
|
|
1584
|
-
* - **Content Limits**:
|
|
1585
|
-
*
|
|
1586
|
-
* This unified endpoint provides all limits in one place for easier client integration.
|
|
1523
|
+
* - **Content Limits**: Per-operation materialization limits (if applicable)
|
|
1524
|
+
* - **Instance Usage**: Aggregate storage across parent + subgraphs (user graphs only)
|
|
1587
1525
|
*
|
|
1588
1526
|
* **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
|
|
1589
1527
|
*/
|
|
@@ -2082,7 +2020,7 @@ export const uploadDocumentsBulk = <ThrowOnError extends boolean = false>(option
|
|
|
2082
2020
|
*/
|
|
2083
2021
|
export const getMaterializationStatus = <ThrowOnError extends boolean = false>(options: Options<GetMaterializationStatusData, ThrowOnError>) => (options.client ?? client).get<GetMaterializationStatusResponses, GetMaterializationStatusErrors, ThrowOnError>({
|
|
2084
2022
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2085
|
-
url: '/v1/graphs/{graph_id}/materialize
|
|
2023
|
+
url: '/v1/graphs/{graph_id}/materialize',
|
|
2086
2024
|
...options
|
|
2087
2025
|
});
|
|
2088
2026
|
|
package/sdk/types.gen.d.ts
CHANGED
|
@@ -1374,33 +1374,9 @@ export type ConnectionResponse = {
|
|
|
1374
1374
|
/**
|
|
1375
1375
|
* ContentLimits
|
|
1376
1376
|
*
|
|
1377
|
-
*
|
|
1377
|
+
* Per-operation materialization limits.
|
|
1378
1378
|
*/
|
|
1379
1379
|
export type ContentLimits = {
|
|
1380
|
-
/**
|
|
1381
|
-
* Max Nodes
|
|
1382
|
-
*
|
|
1383
|
-
* Maximum nodes allowed
|
|
1384
|
-
*/
|
|
1385
|
-
max_nodes: number;
|
|
1386
|
-
/**
|
|
1387
|
-
* Current Nodes
|
|
1388
|
-
*
|
|
1389
|
-
* Current node count
|
|
1390
|
-
*/
|
|
1391
|
-
current_nodes?: number | null;
|
|
1392
|
-
/**
|
|
1393
|
-
* Max Relationships
|
|
1394
|
-
*
|
|
1395
|
-
* Maximum relationships allowed
|
|
1396
|
-
*/
|
|
1397
|
-
max_relationships: number;
|
|
1398
|
-
/**
|
|
1399
|
-
* Current Relationships
|
|
1400
|
-
*
|
|
1401
|
-
* Current relationship count
|
|
1402
|
-
*/
|
|
1403
|
-
current_relationships?: number | null;
|
|
1404
1380
|
/**
|
|
1405
1381
|
* Max Rows Per Copy
|
|
1406
1382
|
*
|
|
@@ -1419,12 +1395,6 @@ export type ContentLimits = {
|
|
|
1419
1395
|
* Rows per materialization chunk
|
|
1420
1396
|
*/
|
|
1421
1397
|
chunk_size_rows: number;
|
|
1422
|
-
/**
|
|
1423
|
-
* Approaching Limits
|
|
1424
|
-
*
|
|
1425
|
-
* List of limits being approached (>80%)
|
|
1426
|
-
*/
|
|
1427
|
-
approaching_limits?: Array<string>;
|
|
1428
1398
|
};
|
|
1429
1399
|
/**
|
|
1430
1400
|
* CopyOperationLimits
|
|
@@ -2428,6 +2398,31 @@ export type DatabaseInfoResponse = {
|
|
|
2428
2398
|
*/
|
|
2429
2399
|
last_backup_date?: string | null;
|
|
2430
2400
|
};
|
|
2401
|
+
/**
|
|
2402
|
+
* DatabaseStorageEntry
|
|
2403
|
+
*
|
|
2404
|
+
* Storage for a single database on the instance.
|
|
2405
|
+
*/
|
|
2406
|
+
export type DatabaseStorageEntry = {
|
|
2407
|
+
/**
|
|
2408
|
+
* Graph Id
|
|
2409
|
+
*
|
|
2410
|
+
* Database identifier
|
|
2411
|
+
*/
|
|
2412
|
+
graph_id: string;
|
|
2413
|
+
/**
|
|
2414
|
+
* Is Parent
|
|
2415
|
+
*
|
|
2416
|
+
* Whether this is the parent graph
|
|
2417
|
+
*/
|
|
2418
|
+
is_parent?: boolean;
|
|
2419
|
+
/**
|
|
2420
|
+
* Size Mb
|
|
2421
|
+
*
|
|
2422
|
+
* Database size in MB
|
|
2423
|
+
*/
|
|
2424
|
+
size_mb?: number | null;
|
|
2425
|
+
};
|
|
2431
2426
|
/**
|
|
2432
2427
|
* DeleteFileResponse
|
|
2433
2428
|
*/
|
|
@@ -3513,7 +3508,7 @@ export type GraphInfo = {
|
|
|
3513
3508
|
/**
|
|
3514
3509
|
* Status
|
|
3515
3510
|
*
|
|
3516
|
-
* Graph lifecycle status:
|
|
3511
|
+
* Graph lifecycle status: active, suspended, deprovisioned
|
|
3517
3512
|
*/
|
|
3518
3513
|
status?: string;
|
|
3519
3514
|
};
|
|
@@ -3572,9 +3567,13 @@ export type GraphLimitsResponse = {
|
|
|
3572
3567
|
*/
|
|
3573
3568
|
credits?: CreditLimits | null;
|
|
3574
3569
|
/**
|
|
3575
|
-
*
|
|
3570
|
+
* Per-operation materialization limits (if applicable)
|
|
3576
3571
|
*/
|
|
3577
3572
|
content?: ContentLimits | null;
|
|
3573
|
+
/**
|
|
3574
|
+
* Aggregate instance storage usage (user graphs only)
|
|
3575
|
+
*/
|
|
3576
|
+
instance?: InstanceUsage | null;
|
|
3578
3577
|
};
|
|
3579
3578
|
/**
|
|
3580
3579
|
* GraphMetadata
|
|
@@ -3836,12 +3835,6 @@ export type GraphSubscriptionTier = {
|
|
|
3836
3835
|
* Whether priority support is included
|
|
3837
3836
|
*/
|
|
3838
3837
|
priority_support: boolean;
|
|
3839
|
-
/**
|
|
3840
|
-
* Max Queries Per Hour
|
|
3841
|
-
*
|
|
3842
|
-
* Maximum queries per hour
|
|
3843
|
-
*/
|
|
3844
|
-
max_queries_per_hour?: number | null;
|
|
3845
3838
|
/**
|
|
3846
3839
|
* Max Subgraphs
|
|
3847
3840
|
*
|
|
@@ -4325,6 +4318,52 @@ export type InitialEntityData = {
|
|
|
4325
4318
|
*/
|
|
4326
4319
|
ein?: string | null;
|
|
4327
4320
|
};
|
|
4321
|
+
/**
|
|
4322
|
+
* InstanceUsage
|
|
4323
|
+
*
|
|
4324
|
+
* Aggregate storage usage across the dedicated instance.
|
|
4325
|
+
*
|
|
4326
|
+
* Covers the parent graph, all subgraphs, DuckDB staging, and
|
|
4327
|
+
* future LanceDB vector indexes.
|
|
4328
|
+
*/
|
|
4329
|
+
export type InstanceUsage = {
|
|
4330
|
+
/**
|
|
4331
|
+
* Node Count
|
|
4332
|
+
*
|
|
4333
|
+
* Current node count (informational, no limit enforced)
|
|
4334
|
+
*/
|
|
4335
|
+
node_count?: number | null;
|
|
4336
|
+
/**
|
|
4337
|
+
* Total Storage Gb
|
|
4338
|
+
*
|
|
4339
|
+
* Total storage used across all databases in GB
|
|
4340
|
+
*/
|
|
4341
|
+
total_storage_gb?: number | null;
|
|
4342
|
+
/**
|
|
4343
|
+
* Limit Gb
|
|
4344
|
+
*
|
|
4345
|
+
* Soft storage limit for this tier in GB
|
|
4346
|
+
*/
|
|
4347
|
+
limit_gb: number;
|
|
4348
|
+
/**
|
|
4349
|
+
* Usage Percentage
|
|
4350
|
+
*
|
|
4351
|
+
* Storage usage as percentage of limit (e.g. 105.2)
|
|
4352
|
+
*/
|
|
4353
|
+
usage_percentage?: number | null;
|
|
4354
|
+
/**
|
|
4355
|
+
* Status
|
|
4356
|
+
*
|
|
4357
|
+
* Instance status: 'healthy' (<80%), 'approaching' (80-100%), 'over_limit' (>100%)
|
|
4358
|
+
*/
|
|
4359
|
+
status: string;
|
|
4360
|
+
/**
|
|
4361
|
+
* Databases
|
|
4362
|
+
*
|
|
4363
|
+
* Per-database storage breakdown
|
|
4364
|
+
*/
|
|
4365
|
+
databases?: Array<DatabaseStorageEntry>;
|
|
4366
|
+
};
|
|
4328
4367
|
/**
|
|
4329
4368
|
* InviteMemberRequest
|
|
4330
4369
|
*
|
|
@@ -7055,6 +7094,12 @@ export type SearchRequest = {
|
|
|
7055
7094
|
* Filter filings on or before date (YYYY-MM-DD)
|
|
7056
7095
|
*/
|
|
7057
7096
|
date_to?: string | null;
|
|
7097
|
+
/**
|
|
7098
|
+
* Semantic
|
|
7099
|
+
*
|
|
7100
|
+
* Enable hybrid semantic search (BM25 + KNN). Default is BM25-only for speed.
|
|
7101
|
+
*/
|
|
7102
|
+
semantic?: boolean;
|
|
7058
7103
|
/**
|
|
7059
7104
|
* Size
|
|
7060
7105
|
*
|
|
@@ -7336,49 +7381,6 @@ export type StatementResponse = {
|
|
|
7336
7381
|
*/
|
|
7337
7382
|
unmapped_count?: number;
|
|
7338
7383
|
};
|
|
7339
|
-
/**
|
|
7340
|
-
* StorageLimitResponse
|
|
7341
|
-
*
|
|
7342
|
-
* Storage limit information response.
|
|
7343
|
-
*/
|
|
7344
|
-
export type StorageLimitResponse = {
|
|
7345
|
-
/**
|
|
7346
|
-
* Graph Id
|
|
7347
|
-
*/
|
|
7348
|
-
graph_id: string;
|
|
7349
|
-
/**
|
|
7350
|
-
* Current Storage Gb
|
|
7351
|
-
*/
|
|
7352
|
-
current_storage_gb: number;
|
|
7353
|
-
/**
|
|
7354
|
-
* Effective Limit Gb
|
|
7355
|
-
*/
|
|
7356
|
-
effective_limit_gb: number;
|
|
7357
|
-
/**
|
|
7358
|
-
* Usage Percentage
|
|
7359
|
-
*/
|
|
7360
|
-
usage_percentage: number;
|
|
7361
|
-
/**
|
|
7362
|
-
* Within Limit
|
|
7363
|
-
*/
|
|
7364
|
-
within_limit: boolean;
|
|
7365
|
-
/**
|
|
7366
|
-
* Approaching Limit
|
|
7367
|
-
*/
|
|
7368
|
-
approaching_limit: boolean;
|
|
7369
|
-
/**
|
|
7370
|
-
* Needs Warning
|
|
7371
|
-
*/
|
|
7372
|
-
needs_warning: boolean;
|
|
7373
|
-
/**
|
|
7374
|
-
* Has Override
|
|
7375
|
-
*/
|
|
7376
|
-
has_override: boolean;
|
|
7377
|
-
/**
|
|
7378
|
-
* Recommendations
|
|
7379
|
-
*/
|
|
7380
|
-
recommendations?: Array<string> | null;
|
|
7381
|
-
};
|
|
7382
7384
|
/**
|
|
7383
7385
|
* StorageLimits
|
|
7384
7386
|
*
|
|
@@ -10664,7 +10666,7 @@ export type GetCreditSummaryData = {
|
|
|
10664
10666
|
graph_id: string;
|
|
10665
10667
|
};
|
|
10666
10668
|
query?: never;
|
|
10667
|
-
url: '/v1/graphs/{graph_id}/credits
|
|
10669
|
+
url: '/v1/graphs/{graph_id}/credits';
|
|
10668
10670
|
};
|
|
10669
10671
|
export type GetCreditSummaryErrors = {
|
|
10670
10672
|
/**
|
|
@@ -10768,147 +10770,6 @@ export type ListCreditTransactionsResponses = {
|
|
|
10768
10770
|
200: DetailedTransactionsResponse;
|
|
10769
10771
|
};
|
|
10770
10772
|
export type ListCreditTransactionsResponse = ListCreditTransactionsResponses[keyof ListCreditTransactionsResponses];
|
|
10771
|
-
export type CheckCreditBalanceData = {
|
|
10772
|
-
body?: never;
|
|
10773
|
-
path: {
|
|
10774
|
-
/**
|
|
10775
|
-
* Graph Id
|
|
10776
|
-
*
|
|
10777
|
-
* Graph database identifier
|
|
10778
|
-
*/
|
|
10779
|
-
graph_id: string;
|
|
10780
|
-
};
|
|
10781
|
-
query: {
|
|
10782
|
-
/**
|
|
10783
|
-
* Operation Type
|
|
10784
|
-
*
|
|
10785
|
-
* Type of operation to check
|
|
10786
|
-
*/
|
|
10787
|
-
operation_type: string;
|
|
10788
|
-
/**
|
|
10789
|
-
* Base Cost
|
|
10790
|
-
*
|
|
10791
|
-
* Custom base cost (uses default if not provided)
|
|
10792
|
-
*/
|
|
10793
|
-
base_cost?: number | string | null;
|
|
10794
|
-
};
|
|
10795
|
-
url: '/v1/graphs/{graph_id}/credits/balance/check';
|
|
10796
|
-
};
|
|
10797
|
-
export type CheckCreditBalanceErrors = {
|
|
10798
|
-
/**
|
|
10799
|
-
* Access denied to graph
|
|
10800
|
-
*/
|
|
10801
|
-
403: ErrorResponse;
|
|
10802
|
-
/**
|
|
10803
|
-
* Credit pool not found
|
|
10804
|
-
*/
|
|
10805
|
-
404: ErrorResponse;
|
|
10806
|
-
/**
|
|
10807
|
-
* Validation Error
|
|
10808
|
-
*/
|
|
10809
|
-
422: HttpValidationError;
|
|
10810
|
-
/**
|
|
10811
|
-
* Credit check failed
|
|
10812
|
-
*/
|
|
10813
|
-
500: ErrorResponse;
|
|
10814
|
-
};
|
|
10815
|
-
export type CheckCreditBalanceError = CheckCreditBalanceErrors[keyof CheckCreditBalanceErrors];
|
|
10816
|
-
export type CheckCreditBalanceResponses = {
|
|
10817
|
-
/**
|
|
10818
|
-
* Response Checkcreditbalance
|
|
10819
|
-
*
|
|
10820
|
-
* Credit check completed
|
|
10821
|
-
*/
|
|
10822
|
-
200: {
|
|
10823
|
-
[key: string]: unknown;
|
|
10824
|
-
};
|
|
10825
|
-
};
|
|
10826
|
-
export type CheckCreditBalanceResponse = CheckCreditBalanceResponses[keyof CheckCreditBalanceResponses];
|
|
10827
|
-
export type GetStorageUsageData = {
|
|
10828
|
-
body?: never;
|
|
10829
|
-
path: {
|
|
10830
|
-
/**
|
|
10831
|
-
* Graph Id
|
|
10832
|
-
*
|
|
10833
|
-
* Graph database identifier
|
|
10834
|
-
*/
|
|
10835
|
-
graph_id: string;
|
|
10836
|
-
};
|
|
10837
|
-
query?: {
|
|
10838
|
-
/**
|
|
10839
|
-
* Days
|
|
10840
|
-
*
|
|
10841
|
-
* Number of days of history to return
|
|
10842
|
-
*/
|
|
10843
|
-
days?: number;
|
|
10844
|
-
};
|
|
10845
|
-
url: '/v1/graphs/{graph_id}/credits/storage/usage';
|
|
10846
|
-
};
|
|
10847
|
-
export type GetStorageUsageErrors = {
|
|
10848
|
-
/**
|
|
10849
|
-
* Access denied to graph
|
|
10850
|
-
*/
|
|
10851
|
-
403: ErrorResponse;
|
|
10852
|
-
/**
|
|
10853
|
-
* Validation Error
|
|
10854
|
-
*/
|
|
10855
|
-
422: HttpValidationError;
|
|
10856
|
-
/**
|
|
10857
|
-
* Failed to retrieve storage usage
|
|
10858
|
-
*/
|
|
10859
|
-
500: ErrorResponse;
|
|
10860
|
-
};
|
|
10861
|
-
export type GetStorageUsageError = GetStorageUsageErrors[keyof GetStorageUsageErrors];
|
|
10862
|
-
export type GetStorageUsageResponses = {
|
|
10863
|
-
/**
|
|
10864
|
-
* Response Getstorageusage
|
|
10865
|
-
*
|
|
10866
|
-
* Storage usage retrieved successfully
|
|
10867
|
-
*/
|
|
10868
|
-
200: {
|
|
10869
|
-
[key: string]: unknown;
|
|
10870
|
-
};
|
|
10871
|
-
};
|
|
10872
|
-
export type GetStorageUsageResponse = GetStorageUsageResponses[keyof GetStorageUsageResponses];
|
|
10873
|
-
export type CheckStorageLimitsData = {
|
|
10874
|
-
body?: never;
|
|
10875
|
-
path: {
|
|
10876
|
-
/**
|
|
10877
|
-
* Graph Id
|
|
10878
|
-
*
|
|
10879
|
-
* Graph database identifier
|
|
10880
|
-
*/
|
|
10881
|
-
graph_id: string;
|
|
10882
|
-
};
|
|
10883
|
-
query?: never;
|
|
10884
|
-
url: '/v1/graphs/{graph_id}/credits/storage/limits';
|
|
10885
|
-
};
|
|
10886
|
-
export type CheckStorageLimitsErrors = {
|
|
10887
|
-
/**
|
|
10888
|
-
* Access denied to graph
|
|
10889
|
-
*/
|
|
10890
|
-
403: ErrorResponse;
|
|
10891
|
-
/**
|
|
10892
|
-
* No credit pool found for graph
|
|
10893
|
-
*/
|
|
10894
|
-
404: ErrorResponse;
|
|
10895
|
-
/**
|
|
10896
|
-
* Validation Error
|
|
10897
|
-
*/
|
|
10898
|
-
422: HttpValidationError;
|
|
10899
|
-
/**
|
|
10900
|
-
* Failed to retrieve storage limits
|
|
10901
|
-
*/
|
|
10902
|
-
500: ErrorResponse;
|
|
10903
|
-
};
|
|
10904
|
-
export type CheckStorageLimitsError = CheckStorageLimitsErrors[keyof CheckStorageLimitsErrors];
|
|
10905
|
-
export type CheckStorageLimitsResponses = {
|
|
10906
|
-
/**
|
|
10907
|
-
* Storage limit information retrieved successfully
|
|
10908
|
-
*/
|
|
10909
|
-
200: StorageLimitResponse;
|
|
10910
|
-
};
|
|
10911
|
-
export type CheckStorageLimitsResponse = CheckStorageLimitsResponses[keyof CheckStorageLimitsResponses];
|
|
10912
10773
|
export type GetDatabaseHealthData = {
|
|
10913
10774
|
body?: never;
|
|
10914
10775
|
path: {
|
|
@@ -11664,7 +11525,7 @@ export type GetMaterializationStatusData = {
|
|
|
11664
11525
|
graph_id: string;
|
|
11665
11526
|
};
|
|
11666
11527
|
query?: never;
|
|
11667
|
-
url: '/v1/graphs/{graph_id}/materialize
|
|
11528
|
+
url: '/v1/graphs/{graph_id}/materialize';
|
|
11668
11529
|
};
|
|
11669
11530
|
export type GetMaterializationStatusErrors = {
|
|
11670
11531
|
/**
|