@robosystems/client 0.5.9 → 0.5.11
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/artifacts/LedgerClient.d.ts +10 -0
- package/artifacts/LedgerClient.js +22 -5
- package/artifacts/LedgerClient.ts +41 -12
- package/artifacts/graphql/generated/graphql.d.ts +161 -0
- package/artifacts/graphql/generated/graphql.js +380 -2
- package/artifacts/graphql/generated/graphql.ts +525 -0
- package/artifacts/graphql/queries/ledger/informationBlock.d.ts +12 -0
- package/artifacts/graphql/queries/ledger/informationBlock.js +177 -1
- package/artifacts/graphql/queries/ledger/informationBlock.ts +177 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +2 -2
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +3 -3
- package/sdk/sdk.gen.js +6 -6
- package/sdk/sdk.gen.ts +5 -5
- package/sdk/types.gen.d.ts +174 -11
- package/sdk/types.gen.ts +177 -11
- package/sdk.gen.d.ts +3 -3
- package/sdk.gen.js +6 -6
- package/sdk.gen.ts +5 -5
- package/types.gen.d.ts +174 -11
- package/types.gen.ts +177 -11
package/sdk.gen.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.listMcpTools = exports.recommendOperator = exports.batchProcessQueries = exports.executeSpecificOperator = exports.getOperatorMetadata = exports.autoSelectOperator = exports.listOperators = exports.setConnectionWritePolicy = exports.getConnection = exports.deleteConnection = exports.createConnection = exports.listConnections = exports.oauthCallback = exports.initOAuth = exports.getConnectionOptions = exports.syncConnection = 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.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.getFile = exports.listFiles = exports.deleteFile = exports.ingestFile = exports.createFileUpload = exports.deleteDocument = exports.indexDocument = exports.updateMemory = exports.forget = exports.remember = exports.materialize = exports.changeTier = exports.restoreBackup = exports.createBackup = exports.deleteGraph = exports.deleteSubgraph = exports.createSubgraph = exports.recallMemory = exports.getMemory = exports.listMemories = exports.getDocument = exports.listDocuments = exports.getDocumentSection = exports.searchDocuments = exports.listTables = exports.cancelRepositorySubscription = exports.createRepositorySubscription = exports.changeSubscriptionPlan = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.listCreditTransactions = exports.getCreditSummary = exports.exportGraphSchema = exports.getGraphSchema = exports.executeSql = exports.executeCypher = exports.
|
|
5
|
+
exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.getFile = exports.listFiles = exports.deleteFile = exports.ingestFile = exports.createFileUpload = exports.deleteDocument = exports.indexDocument = exports.updateMemory = exports.forget = exports.remember = exports.materialize = exports.changeTier = exports.restoreBackup = exports.createBackup = exports.deleteGraph = exports.deleteSubgraph = exports.createSubgraph = exports.recallMemory = exports.getMemory = exports.listMemories = exports.getDocument = exports.listDocuments = exports.getDocumentSection = exports.searchDocuments = exports.listTables = exports.cancelRepositorySubscription = exports.createRepositorySubscription = exports.changeSubscriptionPlan = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.listCreditTransactions = exports.getCreditSummary = exports.exportGraphSchema = exports.getGraphSchema = exports.executeSql = exports.executeCypher = exports.getGraphUsage = exports.getGraphMetrics = exports.getBackupStats = exports.getBackupDownloadUrl = exports.listBackups = exports.callMcpTool = void 0;
|
|
6
6
|
exports.closePeriod = exports.setCloseTarget = exports.rebuildSchedule = exports.promoteObligations = exports.deleteJournalEntry = exports.updateJournalEntry = exports.previewEventBlock = exports.updateEventHandler = exports.createEventHandler = exports.executeEventBlock = exports.updateEventBlock = exports.createEventBlock = exports.updateAgent = exports.createAgent = exports.bindTextBlock = exports.computeForecast = exports.computeMetrics = exports.evaluateRules = exports.deleteInformationBlock = exports.updateInformationBlock = exports.createInformationBlock = exports.autoMapElements = exports.deleteMappingAssociation = exports.createMappingAssociation = exports.linkEntityTaxonomy = exports.deleteTaxonomyBlock = exports.updateTaxonomyBlock = exports.createTaxonomyBlock = exports.changeReportingStyle = exports.updateEntity = exports.initializeLedger = exports.handleHttpPostExtensionsGraphIdGraphqlPost = exports.handleHttpGetExtensionsGraphIdGraphqlGet = exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.validateSchema = exports.selectGraph = exports.getGraphCapacity = exports.getAvailableGraphTiers = void 0;
|
|
7
7
|
exports.deleteSecurity = exports.updateSecurity = exports.createSecurity = exports.deletePortfolioBlock = exports.updatePortfolioBlock = exports.createPortfolioBlock = exports.financialStatementAnalysis = exports.buildFactGrid = exports.liveFinancialStatement = exports.removePublishListMember = exports.addPublishListMembers = exports.deletePublishList = exports.updatePublishList = exports.createPublishList = exports.transitionFilingStatus = exports.fileReport = exports.shareReport = exports.deleteReport = exports.regenerateReport = exports.createReport = exports.backfillPlanHistory = exports.reopenPeriod = void 0;
|
|
8
8
|
const client_gen_1 = require("./client.gen");
|
|
@@ -623,21 +623,21 @@ exports.getBackupStats = getBackupStats;
|
|
|
623
623
|
*/
|
|
624
624
|
const getGraphMetrics = (options) => (options.client ?? client_gen_1.client).get({
|
|
625
625
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
626
|
-
url: '/v1/graphs/{graph_id}/
|
|
626
|
+
url: '/v1/graphs/{graph_id}/metrics',
|
|
627
627
|
...options
|
|
628
628
|
});
|
|
629
629
|
exports.getGraphMetrics = getGraphMetrics;
|
|
630
630
|
/**
|
|
631
|
-
* Get Graph Usage
|
|
631
|
+
* Get Graph Usage
|
|
632
632
|
*
|
|
633
633
|
* Time ranges: 24h, 7d, 30d, current_month, last_month. Toggle storage, credits, performance, and events sections via query params.
|
|
634
634
|
*/
|
|
635
|
-
const
|
|
635
|
+
const getGraphUsage = (options) => (options.client ?? client_gen_1.client).get({
|
|
636
636
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
637
|
-
url: '/v1/graphs/{graph_id}/
|
|
637
|
+
url: '/v1/graphs/{graph_id}/usage',
|
|
638
638
|
...options
|
|
639
639
|
});
|
|
640
|
-
exports.
|
|
640
|
+
exports.getGraphUsage = getGraphUsage;
|
|
641
641
|
/**
|
|
642
642
|
* Execute Cypher Statement
|
|
643
643
|
*
|
package/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, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeReportingStyleData, ChangeReportingStyleErrors, ChangeReportingStyleResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, ChangeTierData, ChangeTierErrors, ChangeTierResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, ClosePeriodData, ClosePeriodErrors, ClosePeriodResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, ComputeForecastData, ComputeForecastErrors, ComputeForecastResponses, ComputeMetricsData, ComputeMetricsErrors, ComputeMetricsResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateEventBlockData, CreateEventBlockErrors, CreateEventBlockResponses, CreateEventHandlerData, CreateEventHandlerErrors, CreateEventHandlerResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateInformationBlockData, CreateInformationBlockErrors, CreateInformationBlockResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioBlockData, CreatePortfolioBlockErrors, CreatePortfolioBlockResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyBlockData, CreateTaxonomyBlockErrors, CreateTaxonomyBlockResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteGraphData, DeleteGraphErrors, DeleteGraphResponses, DeleteInformationBlockData, DeleteInformationBlockErrors, DeleteInformationBlockResponses, DeleteJournalEntryData, DeleteJournalEntryErrors, DeleteJournalEntryResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioBlockData, DeletePortfolioBlockErrors, DeletePortfolioBlockResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, DeleteTaxonomyBlockData, DeleteTaxonomyBlockErrors, DeleteTaxonomyBlockResponses, EvaluateRulesData, EvaluateRulesErrors, EvaluateRulesResponses, ExecuteCypherData, ExecuteCypherErrors, ExecuteCypherResponses, ExecuteEventBlockData, ExecuteEventBlockErrors, ExecuteEventBlockResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, FileReportData, FileReportErrors, FileReportResponses, FinancialStatementAnalysisData, FinancialStatementAnalysisErrors, FinancialStatementAnalysisResponses, ForgetData, ForgetErrors, ForgetResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, 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, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateInformationBlockData, UpdateInformationBlockErrors, UpdateInformationBlockResponses, UpdateJournalEntryData, UpdateJournalEntryErrors, UpdateJournalEntryResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioBlockData, UpdatePortfolioBlockErrors, UpdatePortfolioBlockResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateTaxonomyBlockData, UpdateTaxonomyBlockErrors, UpdateTaxonomyBlockResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
5
|
+
import type { AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeReportingStyleData, ChangeReportingStyleErrors, ChangeReportingStyleResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, ChangeTierData, ChangeTierErrors, ChangeTierResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, ClosePeriodData, ClosePeriodErrors, ClosePeriodResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, ComputeForecastData, ComputeForecastErrors, ComputeForecastResponses, ComputeMetricsData, ComputeMetricsErrors, ComputeMetricsResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateEventBlockData, CreateEventBlockErrors, CreateEventBlockResponses, CreateEventHandlerData, CreateEventHandlerErrors, CreateEventHandlerResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateInformationBlockData, CreateInformationBlockErrors, CreateInformationBlockResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioBlockData, CreatePortfolioBlockErrors, CreatePortfolioBlockResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyBlockData, CreateTaxonomyBlockErrors, CreateTaxonomyBlockResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteGraphData, DeleteGraphErrors, DeleteGraphResponses, DeleteInformationBlockData, DeleteInformationBlockErrors, DeleteInformationBlockResponses, DeleteJournalEntryData, DeleteJournalEntryErrors, DeleteJournalEntryResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioBlockData, DeletePortfolioBlockErrors, DeletePortfolioBlockResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, DeleteTaxonomyBlockData, DeleteTaxonomyBlockErrors, DeleteTaxonomyBlockResponses, EvaluateRulesData, EvaluateRulesErrors, EvaluateRulesResponses, ExecuteCypherData, ExecuteCypherErrors, ExecuteCypherResponses, ExecuteEventBlockData, ExecuteEventBlockErrors, ExecuteEventBlockResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, FileReportData, FileReportErrors, FileReportResponses, FinancialStatementAnalysisData, FinancialStatementAnalysisErrors, FinancialStatementAnalysisResponses, ForgetData, ForgetErrors, ForgetResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, 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, GetGraphUsageData, GetGraphUsageErrors, GetGraphUsageResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateInformationBlockData, UpdateInformationBlockErrors, UpdateInformationBlockResponses, UpdateJournalEntryData, UpdateJournalEntryErrors, UpdateJournalEntryResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioBlockData, UpdatePortfolioBlockErrors, UpdatePortfolioBlockResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateTaxonomyBlockData, UpdateTaxonomyBlockErrors, UpdateTaxonomyBlockResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, 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, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
8
8
|
/**
|
|
@@ -635,18 +635,18 @@ export const getBackupStats = <ThrowOnError extends boolean = false>(options: Op
|
|
|
635
635
|
*/
|
|
636
636
|
export const getGraphMetrics = <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => (options.client ?? client).get<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError>({
|
|
637
637
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
638
|
-
url: '/v1/graphs/{graph_id}/
|
|
638
|
+
url: '/v1/graphs/{graph_id}/metrics',
|
|
639
639
|
...options
|
|
640
640
|
});
|
|
641
641
|
|
|
642
642
|
/**
|
|
643
|
-
* Get Graph Usage
|
|
643
|
+
* Get Graph Usage
|
|
644
644
|
*
|
|
645
645
|
* Time ranges: 24h, 7d, 30d, current_month, last_month. Toggle storage, credits, performance, and events sections via query params.
|
|
646
646
|
*/
|
|
647
|
-
export const
|
|
647
|
+
export const getGraphUsage = <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageData, ThrowOnError>) => (options.client ?? client).get<GetGraphUsageResponses, GetGraphUsageErrors, ThrowOnError>({
|
|
648
648
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
649
|
-
url: '/v1/graphs/{graph_id}/
|
|
649
|
+
url: '/v1/graphs/{graph_id}/usage',
|
|
650
650
|
...options
|
|
651
651
|
});
|
|
652
652
|
|
package/types.gen.d.ts
CHANGED
|
@@ -433,6 +433,12 @@ export type BackfillPlanHistoryOperation = {
|
|
|
433
433
|
* Override the sync-currency gate on each reclose. Historical months predate the last sync in the normal case, so this is rarely needed.
|
|
434
434
|
*/
|
|
435
435
|
allow_stale_sync?: boolean;
|
|
436
|
+
/**
|
|
437
|
+
* Restamp
|
|
438
|
+
*
|
|
439
|
+
* Also re-derive months that ALREADY have canonical statement sets (default: skip them). Use after an engine improvement changes what a stamp produces — each month reruns the full reopen → reclose cycle and replaces its sets. A restamp run is not self-resuming (every month in range stays a candidate); advance `start_period` between chunks.
|
|
440
|
+
*/
|
|
441
|
+
restamp?: boolean;
|
|
436
442
|
/**
|
|
437
443
|
* Note
|
|
438
444
|
*
|
|
@@ -2297,6 +2303,12 @@ export type CreateForecastRequest = {
|
|
|
2297
2303
|
* Direct statement-line assertions (manual overrides). Each names a calc-DAG leaf and wins over driver rules and carry-forward for the months it asserts.
|
|
2298
2304
|
*/
|
|
2299
2305
|
line_assertions?: Array<LineAssertionRequest>;
|
|
2306
|
+
/**
|
|
2307
|
+
* Line Growth
|
|
2308
|
+
*
|
|
2309
|
+
* Per-line growth trajectories. Each names an income-statement leaf and grows it month-over-month at the asserted rate — the generic form of the revenue growth lever, for lines the catalog doesn't drive (opex trajectories, cost-cut ramps).
|
|
2310
|
+
*/
|
|
2311
|
+
line_growth?: Array<LineGrowthRequest>;
|
|
2300
2312
|
/**
|
|
2301
2313
|
* Entity Id
|
|
2302
2314
|
*
|
|
@@ -3154,9 +3166,27 @@ export type DatabaseHealthResponse = {
|
|
|
3154
3166
|
/**
|
|
3155
3167
|
* Memory Usage Mb
|
|
3156
3168
|
*
|
|
3157
|
-
*
|
|
3169
|
+
* Instance memory in use, MB. Only populated for dedicated single-tenant instances; null on shared repositories and packed tiers.
|
|
3158
3170
|
*/
|
|
3159
3171
|
memory_usage_mb?: number | null;
|
|
3172
|
+
/**
|
|
3173
|
+
* Memory Usage Percent
|
|
3174
|
+
*
|
|
3175
|
+
* Instance memory in use, percent. Expect high values during materialization — the engine deliberately boosts to near the whole instance while rebuilding. Read `resource_status` rather than this number alone. Dedicated instances only.
|
|
3176
|
+
*/
|
|
3177
|
+
memory_usage_percent?: number | null;
|
|
3178
|
+
/**
|
|
3179
|
+
* Cpu Usage Percent
|
|
3180
|
+
*
|
|
3181
|
+
* Instance CPU in use, percent. Dedicated single-tenant instances only.
|
|
3182
|
+
*/
|
|
3183
|
+
cpu_usage_percent?: number | null;
|
|
3184
|
+
/**
|
|
3185
|
+
* Resource Status
|
|
3186
|
+
*
|
|
3187
|
+
* Interpreted instance load: 'idle' (headroom), 'busy' (working normally — typical while materializing), 'constrained' (sustained pressure worth acting on). Null when resource metrics are not exposed.
|
|
3188
|
+
*/
|
|
3189
|
+
resource_status?: string | null;
|
|
3160
3190
|
/**
|
|
3161
3191
|
* Storage Usage Mb
|
|
3162
3192
|
*
|
|
@@ -5169,6 +5199,12 @@ export type ForecastMechanics = {
|
|
|
5169
5199
|
* Direct statement-line assertions (authoring order) — manual overrides that win over driver rules and carry-forward for the months they name.
|
|
5170
5200
|
*/
|
|
5171
5201
|
line_assertions?: Array<LineAssertionLite>;
|
|
5202
|
+
/**
|
|
5203
|
+
* Line Growth
|
|
5204
|
+
*
|
|
5205
|
+
* Per-line growth trajectories (authoring order) — each grows an income-statement leaf month-over-month at the asserted rate, compounding from the base month.
|
|
5206
|
+
*/
|
|
5207
|
+
line_growth?: Array<LineGrowthLite>;
|
|
5172
5208
|
/**
|
|
5173
5209
|
* Computed Months
|
|
5174
5210
|
*
|
|
@@ -5591,11 +5627,11 @@ export type GraphMetricsResponse = {
|
|
|
5591
5627
|
[key: string]: number;
|
|
5592
5628
|
};
|
|
5593
5629
|
/**
|
|
5594
|
-
*
|
|
5630
|
+
* Storage
|
|
5595
5631
|
*
|
|
5596
|
-
*
|
|
5632
|
+
* Measured on-disk storage: total_bytes/kb/mb/gb plus itemized `items` (graph, memory, subgraph, vectors, staging). Carries `error` instead if the instance could not be reached — the fields are absent rather than estimated.
|
|
5597
5633
|
*/
|
|
5598
|
-
|
|
5634
|
+
storage: {
|
|
5599
5635
|
[key: string]: unknown;
|
|
5600
5636
|
};
|
|
5601
5637
|
/**
|
|
@@ -6483,6 +6519,12 @@ export type InstanceUsage = {
|
|
|
6483
6519
|
* Per-database storage breakdown
|
|
6484
6520
|
*/
|
|
6485
6521
|
databases?: Array<DatabaseStorageEntry>;
|
|
6522
|
+
/**
|
|
6523
|
+
* Items
|
|
6524
|
+
*
|
|
6525
|
+
* Itemized storage by type — graph, memory, subgraph, vectors, staging. Sums to total_storage_gb.
|
|
6526
|
+
*/
|
|
6527
|
+
items?: Array<StorageItem>;
|
|
6486
6528
|
};
|
|
6487
6529
|
/**
|
|
6488
6530
|
* InviteMemberRequest
|
|
@@ -7230,6 +7272,96 @@ export type LineAssertionRequest = {
|
|
|
7230
7272
|
[key: string]: number;
|
|
7231
7273
|
} | null;
|
|
7232
7274
|
};
|
|
7275
|
+
/**
|
|
7276
|
+
* LineGrowthLite
|
|
7277
|
+
*
|
|
7278
|
+
* One statement line's persisted growth trajectory inside
|
|
7279
|
+
* ``ForecastMechanics``.
|
|
7280
|
+
*
|
|
7281
|
+
* The generic per-line form of the revenue growth lever: grows an
|
|
7282
|
+
* income-statement leaf month-over-month at the asserted rate
|
|
7283
|
+
* (``line[t] = line[t-1] * (1 + rate[t])``), compounding from the base
|
|
7284
|
+
* month's value. Months without a rate keep the engine's carry-forward.
|
|
7285
|
+
* Duration leaves only; disjoint from ``line_assertions`` and from any
|
|
7286
|
+
* active catalog rule's target (one owner per line).
|
|
7287
|
+
*
|
|
7288
|
+
* Persistence deviates from levers/assertions deliberately: rates are
|
|
7289
|
+
* NOT duplicated as facts in the scenario FactSet — a growth rate on a
|
|
7290
|
+
* monetary statement element would be a unit-lying fact. This mechanics
|
|
7291
|
+
* copy is the single authored store; ``compute-forecast`` binds rates
|
|
7292
|
+
* from here.
|
|
7293
|
+
*/
|
|
7294
|
+
export type LineGrowthLite = {
|
|
7295
|
+
/**
|
|
7296
|
+
* Qname
|
|
7297
|
+
*
|
|
7298
|
+
* Grown statement-leaf qname.
|
|
7299
|
+
*/
|
|
7300
|
+
qname: string;
|
|
7301
|
+
/**
|
|
7302
|
+
* Element Id
|
|
7303
|
+
*
|
|
7304
|
+
* Resolved tenant element id.
|
|
7305
|
+
*/
|
|
7306
|
+
element_id: string;
|
|
7307
|
+
/**
|
|
7308
|
+
* Item Type
|
|
7309
|
+
*
|
|
7310
|
+
* Always 'percent' — the grid row renders rates, not values.
|
|
7311
|
+
*/
|
|
7312
|
+
item_type?: string;
|
|
7313
|
+
/**
|
|
7314
|
+
* Values By Period
|
|
7315
|
+
*
|
|
7316
|
+
* Expanded per-month growth rates keyed by ``YYYY-MM``.
|
|
7317
|
+
*/
|
|
7318
|
+
values_by_period: {
|
|
7319
|
+
[key: string]: number;
|
|
7320
|
+
};
|
|
7321
|
+
};
|
|
7322
|
+
/**
|
|
7323
|
+
* LineGrowthRequest
|
|
7324
|
+
*
|
|
7325
|
+
* One statement line's asserted growth trajectory for the scenario.
|
|
7326
|
+
*
|
|
7327
|
+
* The generic per-line sibling of ``rs-driver:RevenueGrowthRate``: where
|
|
7328
|
+
* the catalog lever grows *revenue* through its seeded rule, a line
|
|
7329
|
+
* growth entry grows **any income-statement leaf** at a month-over-month
|
|
7330
|
+
* rate — ``value`` -0.05 cuts the line 5% per month, compounding from
|
|
7331
|
+
* the base month's value. This is what expense trajectories ("opex +2%/mo
|
|
7332
|
+
* with inflation", "cut costs 5%/mo starting October") use; without it
|
|
7333
|
+
* every unmodeled line just carries flat.
|
|
7334
|
+
*
|
|
7335
|
+
* Semantics per month: ``line[t] = line[t-1] * (1 + rate[t])``. Months
|
|
7336
|
+
* the entry doesn't name keep the engine's carry-forward (grow-then-hold
|
|
7337
|
+
* ramps fall out of ``values_by_period`` naturally). **Duration leaves
|
|
7338
|
+
* only**: balance-sheet lines roll from the IS and the working-capital
|
|
7339
|
+
* levers — grow the driving IS line instead. A line already driven by an
|
|
7340
|
+
* active catalog rule (e.g. Revenues with ``RevenueGrowthRate`` set) or
|
|
7341
|
+
* named by a ``line_assertions`` entry is rejected — one owner per line.
|
|
7342
|
+
*/
|
|
7343
|
+
export type LineGrowthRequest = {
|
|
7344
|
+
/**
|
|
7345
|
+
* Qname
|
|
7346
|
+
*
|
|
7347
|
+
* QName of the income-statement leaf to grow (e.g. ``rs-gaap:ResearchAndDevelopmentExpense``). Must be a calc-DAG duration leaf.
|
|
7348
|
+
*/
|
|
7349
|
+
qname: string;
|
|
7350
|
+
/**
|
|
7351
|
+
* Value
|
|
7352
|
+
*
|
|
7353
|
+
* Uniform month-over-month growth rate for every month of the horizon (decimal: 0.02 = +2%/mo, -0.05 = -5%/mo).
|
|
7354
|
+
*/
|
|
7355
|
+
value?: number | null;
|
|
7356
|
+
/**
|
|
7357
|
+
* Values By Period
|
|
7358
|
+
*
|
|
7359
|
+
* Per-month rate overrides keyed by ``YYYY-MM``. Wins over ``value`` for the months it names; months named by neither carry the line's prior value (rate 0).
|
|
7360
|
+
*/
|
|
7361
|
+
values_by_period?: {
|
|
7362
|
+
[key: string]: number;
|
|
7363
|
+
} | null;
|
|
7364
|
+
};
|
|
7233
7365
|
/**
|
|
7234
7366
|
* LineItemMetadataPredicate
|
|
7235
7367
|
*
|
|
@@ -12674,6 +12806,31 @@ export type StatementMechanics = {
|
|
|
12674
12806
|
*/
|
|
12675
12807
|
period_comparisons?: number;
|
|
12676
12808
|
};
|
|
12809
|
+
/**
|
|
12810
|
+
* StorageItem
|
|
12811
|
+
*
|
|
12812
|
+
* One itemized piece of a graph's on-disk footprint.
|
|
12813
|
+
*/
|
|
12814
|
+
export type StorageItem = {
|
|
12815
|
+
/**
|
|
12816
|
+
* Type
|
|
12817
|
+
*
|
|
12818
|
+
* One of: graph, memory, subgraph, vectors, staging
|
|
12819
|
+
*/
|
|
12820
|
+
type: string;
|
|
12821
|
+
/**
|
|
12822
|
+
* Id
|
|
12823
|
+
*
|
|
12824
|
+
* Database or index identifier
|
|
12825
|
+
*/
|
|
12826
|
+
id: string;
|
|
12827
|
+
/**
|
|
12828
|
+
* Bytes
|
|
12829
|
+
*
|
|
12830
|
+
* Size in bytes
|
|
12831
|
+
*/
|
|
12832
|
+
bytes: number;
|
|
12833
|
+
};
|
|
12677
12834
|
/**
|
|
12678
12835
|
* StorageLimits
|
|
12679
12836
|
*
|
|
@@ -14278,6 +14435,12 @@ export type UpdateForecastRequest = {
|
|
|
14278
14435
|
* Full replacement of the line-assertion set when provided. Pass an empty list to clear every assertion.
|
|
14279
14436
|
*/
|
|
14280
14437
|
line_assertions?: Array<LineAssertionRequest> | null;
|
|
14438
|
+
/**
|
|
14439
|
+
* Line Growth
|
|
14440
|
+
*
|
|
14441
|
+
* Full replacement of the line-growth set when provided. Pass an empty list to clear every growth entry.
|
|
14442
|
+
*/
|
|
14443
|
+
line_growth?: Array<LineGrowthRequest> | null;
|
|
14281
14444
|
};
|
|
14282
14445
|
/**
|
|
14283
14446
|
* UpdateInformationBlockRequest
|
|
@@ -17836,7 +17999,7 @@ export type GetGraphMetricsData = {
|
|
|
17836
17999
|
graph_id: string;
|
|
17837
18000
|
};
|
|
17838
18001
|
query?: never;
|
|
17839
|
-
url: '/v1/graphs/{graph_id}/
|
|
18002
|
+
url: '/v1/graphs/{graph_id}/metrics';
|
|
17840
18003
|
};
|
|
17841
18004
|
export type GetGraphMetricsErrors = {
|
|
17842
18005
|
/**
|
|
@@ -17876,7 +18039,7 @@ export type GetGraphMetricsResponses = {
|
|
|
17876
18039
|
200: GraphMetricsResponse;
|
|
17877
18040
|
};
|
|
17878
18041
|
export type GetGraphMetricsResponse = GetGraphMetricsResponses[keyof GetGraphMetricsResponses];
|
|
17879
|
-
export type
|
|
18042
|
+
export type GetGraphUsageData = {
|
|
17880
18043
|
body?: never;
|
|
17881
18044
|
path: {
|
|
17882
18045
|
/**
|
|
@@ -17916,9 +18079,9 @@ export type GetGraphUsageAnalyticsData = {
|
|
|
17916
18079
|
*/
|
|
17917
18080
|
include_events?: boolean;
|
|
17918
18081
|
};
|
|
17919
|
-
url: '/v1/graphs/{graph_id}/
|
|
18082
|
+
url: '/v1/graphs/{graph_id}/usage';
|
|
17920
18083
|
};
|
|
17921
|
-
export type
|
|
18084
|
+
export type GetGraphUsageErrors = {
|
|
17922
18085
|
/**
|
|
17923
18086
|
* Invalid request
|
|
17924
18087
|
*/
|
|
@@ -17948,14 +18111,14 @@ export type GetGraphUsageAnalyticsErrors = {
|
|
|
17948
18111
|
*/
|
|
17949
18112
|
500: ErrorResponse;
|
|
17950
18113
|
};
|
|
17951
|
-
export type
|
|
17952
|
-
export type
|
|
18114
|
+
export type GetGraphUsageError = GetGraphUsageErrors[keyof GetGraphUsageErrors];
|
|
18115
|
+
export type GetGraphUsageResponses = {
|
|
17953
18116
|
/**
|
|
17954
18117
|
* Successful Response
|
|
17955
18118
|
*/
|
|
17956
18119
|
200: GraphUsageResponse;
|
|
17957
18120
|
};
|
|
17958
|
-
export type
|
|
18121
|
+
export type GetGraphUsageResponse = GetGraphUsageResponses[keyof GetGraphUsageResponses];
|
|
17959
18122
|
export type ExecuteCypherData = {
|
|
17960
18123
|
body: CypherStatementRequest;
|
|
17961
18124
|
path: {
|