@robosystems/client 1.12.0 → 1.12.1
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/graphql/generated/graphql.d.ts +13 -2
- package/artifacts/graphql/generated/graphql.ts +13 -2
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +2 -1
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +9 -3
- package/sdk/sdk.gen.js +19 -4
- package/sdk/sdk.gen.ts +18 -3
- package/sdk/types.gen.d.ts +142 -11
- package/sdk/types.gen.ts +149 -11
- package/sdk.gen.d.ts +9 -3
- package/sdk.gen.js +19 -4
- package/sdk.gen.ts +18 -3
- package/types.gen.d.ts +142 -11
- package/types.gen.ts +149 -11
package/sdk.gen.js
CHANGED
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.resendOrgInvitation = exports.revokeOrgInvitation = exports.createOrgInvitation = exports.listOrgInvitations = exports.updateOrgMemberRole = exports.removeOrgMember = exports.listOrgMembers = exports.listOrgGraphs = exports.updateOrg = exports.getOrg = exports.listUserOrgs = exports.revokeUserOAuthGrant = exports.listUserOAuthGrants = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getAuthProviders = exports.getCaptchaConfig = exports.regenerateMfaRecoveryCodes = exports.getMfaStatus = exports.verifyMfa = exports.getMfaOptions = exports.verifyPasskeyLogin = exports.getPasskeyLoginOptions = exports.deleteUserPasskey = exports.getPasskeyReauthOptions = exports.listUserPasskeys = exports.verifyPasskeyRegistration = exports.getPasskeyRegistrationOptions = exports.completeSsoAuth = exports.ssoTokenExchange = exports.generateSsoToken = exports.resetPassword = exports.validateResetToken = exports.forgotPassword = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.getInvitationPreview = exports.verifyEmail = exports.resendVerificationEmail = exports.refreshAuthSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
|
|
5
5
|
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.getSubgraphInfo = exports.listSubgraphs = exports.updateGraphMemberRole = exports.removeGraphMember = exports.addGraphMember = exports.listGraphMembers = 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.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 = void 0;
|
|
6
|
-
exports.
|
|
7
|
-
exports.deleteSecurity = exports.updateSecurity = exports.createSecurity = exports.deletePortfolioBlock = exports.updatePortfolioBlock = exports.createPortfolioBlock = exports.financialStatementAnalysis = exports.buildFactGrid = exports.liveFinancialStatement = exports.unblockSourceGraph = exports.blockSourceGraph = exports.removePublishListMember = exports.addPublishListMembers = exports.deletePublishList = exports.updatePublishList = exports.createPublishList = exports.transitionFilingStatus = exports.fileReport = exports.revokeReportShare = exports.shareReport = exports.deleteReport = exports.regenerateReport = exports.createReport = exports.backfillPlanHistory = exports.reopenPeriod = exports.closePeriod = exports.setCloseTarget = exports.terminateSchedule = exports.rebuildSchedule = exports.promoteObligations = exports.deleteJournalEntry = exports.updateJournalEntry = exports.resolveReconcilingItem = exports.previewReconcilingItem = exports.previewEventBlock = exports.updateEventHandler = exports.createEventHandler = exports.executeEventBlock = exports.updateEventBlock = exports.createEventBlock = exports.updateAgent = exports.createAgent = exports.bindTextBlock = exports.computeForecast = exports.assertMetrics = exports.computeMetrics = void 0;
|
|
6
|
+
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.resumeOperation = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.validateSchema = exports.selectGraph = exports.getGraphCapacity = exports.getAvailableGraphTiers = 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.updateGraphMetadata = exports.changeTier = exports.createBackup = void 0;
|
|
7
|
+
exports.deleteSecurity = exports.updateSecurity = exports.createSecurity = exports.deletePortfolioBlock = exports.updatePortfolioBlock = exports.createPortfolioBlock = exports.financialStatementAnalysis = exports.buildFactGrid = exports.liveFinancialStatement = exports.unblockSourceGraph = exports.blockSourceGraph = exports.removePublishListMember = exports.addPublishListMembers = exports.deletePublishList = exports.updatePublishList = exports.createPublishList = exports.transitionFilingStatus = exports.fileReport = exports.revokeReportShare = exports.shareReport = exports.deleteReport = exports.regenerateReport = exports.createReport = exports.backfillPlanHistory = exports.reopenPeriod = exports.closePeriod = exports.setCloseTarget = exports.terminateSchedule = exports.rebuildSchedule = exports.promoteObligations = exports.deleteJournalEntry = exports.updateJournalEntry = exports.resolveReconcilingItem = exports.previewReconcilingItem = exports.previewEventBlock = exports.updateEventHandler = exports.createEventHandler = exports.executeEventBlock = exports.updateEventBlock = exports.createEventBlock = exports.updateAgent = exports.createAgent = exports.bindTextBlock = exports.computeForecast = exports.assertMetrics = exports.computeMetrics = exports.evaluateRules = void 0;
|
|
8
8
|
const client_gen_1 = require("./client.gen");
|
|
9
9
|
/**
|
|
10
10
|
* Register New User
|
|
@@ -708,7 +708,7 @@ exports.listOperators = listOperators;
|
|
|
708
708
|
/**
|
|
709
709
|
* Auto-select Operator for Query
|
|
710
710
|
*
|
|
711
|
-
* Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode.
|
|
711
|
+
* Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
712
712
|
*/
|
|
713
713
|
const autoSelectOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
714
714
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -732,7 +732,7 @@ exports.getOperatorMetadata = getOperatorMetadata;
|
|
|
732
732
|
/**
|
|
733
733
|
* Execute Specific Operator
|
|
734
734
|
*
|
|
735
|
-
* Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered.
|
|
735
|
+
* Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
736
736
|
*/
|
|
737
737
|
const executeSpecificOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
738
738
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1500,6 +1500,21 @@ const cancelOperation = (options) => (options.client ?? client_gen_1.client).del
|
|
|
1500
1500
|
...options
|
|
1501
1501
|
});
|
|
1502
1502
|
exports.cancelOperation = cancelOperation;
|
|
1503
|
+
/**
|
|
1504
|
+
* Resume Operation
|
|
1505
|
+
*
|
|
1506
|
+
* Answers an operation that paused at a checkpoint (status `awaiting_input`) and puts it back on the worker queue with the answer. The operation keeps its id, so the stream, status and cancel links stay valid; reconnect to `/stream` to follow the resumed run. Consumes no credits.
|
|
1507
|
+
*/
|
|
1508
|
+
const resumeOperation = (options) => (options.client ?? client_gen_1.client).post({
|
|
1509
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1510
|
+
url: '/v1/operations/{operation_id}/resume',
|
|
1511
|
+
...options,
|
|
1512
|
+
headers: {
|
|
1513
|
+
'Content-Type': 'application/json',
|
|
1514
|
+
...options.headers
|
|
1515
|
+
}
|
|
1516
|
+
});
|
|
1517
|
+
exports.resumeOperation = resumeOperation;
|
|
1503
1518
|
/**
|
|
1504
1519
|
* Get Organization Customer Info
|
|
1505
1520
|
*
|
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 { AddGraphMemberData, AddGraphMemberErrors, AddGraphMemberResponses, AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AssertMetricsData, AssertMetricsErrors, AssertMetricsResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BlockSourceGraphData, BlockSourceGraphErrors, BlockSourceGraphResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, 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, CreateOrgInvitationData, CreateOrgInvitationErrors, CreateOrgInvitationResponses, 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, DeleteUserPasskeyData, DeleteUserPasskeyErrors, DeleteUserPasskeyResponses, 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, GetAuthProvidersData, GetAuthProvidersErrors, GetAuthProvidersResponses, 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, GetInvitationPreviewData, GetInvitationPreviewErrors, GetInvitationPreviewResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetMfaOptionsData, GetMfaOptionsErrors, GetMfaOptionsResponses, GetMfaStatusData, GetMfaStatusErrors, GetMfaStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasskeyLoginOptionsData, GetPasskeyLoginOptionsErrors, GetPasskeyLoginOptionsResponses, GetPasskeyReauthOptionsData, GetPasskeyReauthOptionsErrors, GetPasskeyReauthOptionsResponses, GetPasskeyRegistrationOptionsData, GetPasskeyRegistrationOptionsErrors, GetPasskeyRegistrationOptionsResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListGraphMembersData, ListGraphMembersErrors, ListGraphMembersResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvitationsData, ListOrgInvitationsErrors, ListOrgInvitationsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOAuthGrantsData, ListUserOAuthGrantsErrors, ListUserOAuthGrantsResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, ListUserPasskeysData, ListUserPasskeysErrors, ListUserPasskeysResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PreviewReconcilingItemData, PreviewReconcilingItemErrors, PreviewReconcilingItemResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegenerateMfaRecoveryCodesData, RegenerateMfaRecoveryCodesErrors, RegenerateMfaRecoveryCodesResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveGraphMemberData, RemoveGraphMemberErrors, RemoveGraphMemberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendOrgInvitationData, ResendOrgInvitationErrors, ResendOrgInvitationResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, ResolveReconcilingItemData, ResolveReconcilingItemErrors, ResolveReconcilingItemResponses, RevokeOrgInvitationData, RevokeOrgInvitationErrors, RevokeOrgInvitationResponses, RevokeReportShareData, RevokeReportShareErrors, RevokeReportShareResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, RevokeUserOAuthGrantData, RevokeUserOAuthGrantErrors, RevokeUserOAuthGrantResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TerminateScheduleData, TerminateScheduleErrors, TerminateScheduleResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UnblockSourceGraphData, UnblockSourceGraphErrors, UnblockSourceGraphResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateGraphMemberRoleData, UpdateGraphMemberRoleErrors, UpdateGraphMemberRoleResponses, UpdateGraphMetadataData, UpdateGraphMetadataErrors, UpdateGraphMetadataResponses, 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, VerifyMfaData, VerifyMfaErrors, VerifyMfaResponses, VerifyPasskeyLoginData, VerifyPasskeyLoginErrors, VerifyPasskeyLoginResponses, VerifyPasskeyRegistrationData, VerifyPasskeyRegistrationErrors, VerifyPasskeyRegistrationResponses } from './types.gen';
|
|
5
|
+
import type { AddGraphMemberData, AddGraphMemberErrors, AddGraphMemberResponses, AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AssertMetricsData, AssertMetricsErrors, AssertMetricsResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BlockSourceGraphData, BlockSourceGraphErrors, BlockSourceGraphResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, 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, CreateOrgInvitationData, CreateOrgInvitationErrors, CreateOrgInvitationResponses, 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, DeleteUserPasskeyData, DeleteUserPasskeyErrors, DeleteUserPasskeyResponses, 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, GetAuthProvidersData, GetAuthProvidersErrors, GetAuthProvidersResponses, 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, GetInvitationPreviewData, GetInvitationPreviewErrors, GetInvitationPreviewResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetMfaOptionsData, GetMfaOptionsErrors, GetMfaOptionsResponses, GetMfaStatusData, GetMfaStatusErrors, GetMfaStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasskeyLoginOptionsData, GetPasskeyLoginOptionsErrors, GetPasskeyLoginOptionsResponses, GetPasskeyReauthOptionsData, GetPasskeyReauthOptionsErrors, GetPasskeyReauthOptionsResponses, GetPasskeyRegistrationOptionsData, GetPasskeyRegistrationOptionsErrors, GetPasskeyRegistrationOptionsResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListGraphMembersData, ListGraphMembersErrors, ListGraphMembersResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvitationsData, ListOrgInvitationsErrors, ListOrgInvitationsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOAuthGrantsData, ListUserOAuthGrantsErrors, ListUserOAuthGrantsResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, ListUserPasskeysData, ListUserPasskeysErrors, ListUserPasskeysResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PreviewReconcilingItemData, PreviewReconcilingItemErrors, PreviewReconcilingItemResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegenerateMfaRecoveryCodesData, RegenerateMfaRecoveryCodesErrors, RegenerateMfaRecoveryCodesResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveGraphMemberData, RemoveGraphMemberErrors, RemoveGraphMemberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendOrgInvitationData, ResendOrgInvitationErrors, ResendOrgInvitationResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, ResolveReconcilingItemData, ResolveReconcilingItemErrors, ResolveReconcilingItemResponses, ResumeOperationData, ResumeOperationErrors, ResumeOperationResponses, RevokeOrgInvitationData, RevokeOrgInvitationErrors, RevokeOrgInvitationResponses, RevokeReportShareData, RevokeReportShareErrors, RevokeReportShareResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, RevokeUserOAuthGrantData, RevokeUserOAuthGrantErrors, RevokeUserOAuthGrantResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TerminateScheduleData, TerminateScheduleErrors, TerminateScheduleResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UnblockSourceGraphData, UnblockSourceGraphErrors, UnblockSourceGraphResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateGraphMemberRoleData, UpdateGraphMemberRoleErrors, UpdateGraphMemberRoleResponses, UpdateGraphMetadataData, UpdateGraphMetadataErrors, UpdateGraphMetadataResponses, 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, VerifyMfaData, VerifyMfaErrors, VerifyMfaResponses, VerifyPasskeyLoginData, VerifyPasskeyLoginErrors, VerifyPasskeyLoginResponses, VerifyPasskeyRegistrationData, VerifyPasskeyRegistrationErrors, VerifyPasskeyRegistrationResponses } 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
|
/**
|
|
@@ -720,7 +720,7 @@ export const listOperators = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
720
720
|
/**
|
|
721
721
|
* Auto-select Operator for Query
|
|
722
722
|
*
|
|
723
|
-
* Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode.
|
|
723
|
+
* Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
724
724
|
*/
|
|
725
725
|
export const autoSelectOperator = <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => (options.client ?? client).post<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError>({
|
|
726
726
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -744,7 +744,7 @@ export const getOperatorMetadata = <ThrowOnError extends boolean = false>(option
|
|
|
744
744
|
/**
|
|
745
745
|
* Execute Specific Operator
|
|
746
746
|
*
|
|
747
|
-
* Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered.
|
|
747
|
+
* Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
748
748
|
*/
|
|
749
749
|
export const executeSpecificOperator = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => (options.client ?? client).post<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError>({
|
|
750
750
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1512,6 +1512,21 @@ export const cancelOperation = <ThrowOnError extends boolean = false>(options: O
|
|
|
1512
1512
|
...options
|
|
1513
1513
|
});
|
|
1514
1514
|
|
|
1515
|
+
/**
|
|
1516
|
+
* Resume Operation
|
|
1517
|
+
*
|
|
1518
|
+
* Answers an operation that paused at a checkpoint (status `awaiting_input`) and puts it back on the worker queue with the answer. The operation keeps its id, so the stream, status and cancel links stay valid; reconnect to `/stream` to follow the resumed run. Consumes no credits.
|
|
1519
|
+
*/
|
|
1520
|
+
export const resumeOperation = <ThrowOnError extends boolean = false>(options: Options<ResumeOperationData, ThrowOnError>) => (options.client ?? client).post<ResumeOperationResponses, ResumeOperationErrors, ThrowOnError>({
|
|
1521
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1522
|
+
url: '/v1/operations/{operation_id}/resume',
|
|
1523
|
+
...options,
|
|
1524
|
+
headers: {
|
|
1525
|
+
'Content-Type': 'application/json',
|
|
1526
|
+
...options.headers
|
|
1527
|
+
}
|
|
1528
|
+
});
|
|
1529
|
+
|
|
1515
1530
|
/**
|
|
1516
1531
|
* Get Organization Customer Info
|
|
1517
1532
|
*
|
package/types.gen.d.ts
CHANGED
|
@@ -4546,15 +4546,15 @@ export type ElementSummary = {
|
|
|
4546
4546
|
/**
|
|
4547
4547
|
* Total
|
|
4548
4548
|
*
|
|
4549
|
-
* Sum of values across the returned facts
|
|
4549
|
+
* Sum of values across the returned facts. Duration elements only — a balance summed across periods is not a balance, so instants omit it.
|
|
4550
4550
|
*/
|
|
4551
|
-
total
|
|
4551
|
+
total?: number | null;
|
|
4552
4552
|
/**
|
|
4553
4553
|
* Average
|
|
4554
4554
|
*
|
|
4555
|
-
* Mean value across the returned facts
|
|
4555
|
+
* Mean value across the returned facts. Duration elements only; omitted for instants.
|
|
4556
4556
|
*/
|
|
4557
|
-
average
|
|
4557
|
+
average?: number | null;
|
|
4558
4558
|
/**
|
|
4559
4559
|
* Min
|
|
4560
4560
|
*
|
|
@@ -8339,7 +8339,7 @@ export type LiveFinancialStatementRequest = {
|
|
|
8339
8339
|
/**
|
|
8340
8340
|
* Statement Type
|
|
8341
8341
|
*
|
|
8342
|
-
* income_statement | balance_sheet | cash_flow_statement | equity_statement
|
|
8342
|
+
* income_statement | balance_sheet | cash_flow_statement | equity_statement. ``equity_statement`` is provisional — equity balances, not a rollforward — and is not offered on the MCP surface until it articulates.
|
|
8343
8343
|
*/
|
|
8344
8344
|
statement_type: string;
|
|
8345
8345
|
/**
|
|
@@ -8369,7 +8369,7 @@ export type LiveFinancialStatementRequest = {
|
|
|
8369
8369
|
/**
|
|
8370
8370
|
* Limit
|
|
8371
8371
|
*
|
|
8372
|
-
* Max fact rows returned
|
|
8372
|
+
* Max fact rows returned. Defaults to the ceiling so a statement is never cut mid-section — visible rows would stop footing to visible subtotals. Lower it only for a preview.
|
|
8373
8373
|
*/
|
|
8374
8374
|
limit?: number;
|
|
8375
8375
|
};
|
|
@@ -8389,6 +8389,8 @@ export type LiveFinancialStatementResponse = {
|
|
|
8389
8389
|
statement_type: string;
|
|
8390
8390
|
/**
|
|
8391
8391
|
* Periods
|
|
8392
|
+
*
|
|
8393
|
+
* Rendered columns, aligned with each row's ``values``. Current and prior for income_statement and balance_sheet; current only for cash_flow_statement — the prior period is pivoted as the indirect-method delta basis and not rendered.
|
|
8392
8394
|
*/
|
|
8393
8395
|
periods: Array<PeriodSpec>;
|
|
8394
8396
|
/**
|
|
@@ -8399,6 +8401,10 @@ export type LiveFinancialStatementResponse = {
|
|
|
8399
8401
|
* Fact Count
|
|
8400
8402
|
*/
|
|
8401
8403
|
fact_count: number;
|
|
8404
|
+
/**
|
|
8405
|
+
* Guard-rail outcome for the rendered columns — accounting equation, net-income equation, totals footing, operating-plug size. Null only when no structure rendered.
|
|
8406
|
+
*/
|
|
8407
|
+
validation?: ValidationCheckResponse | null;
|
|
8402
8408
|
/**
|
|
8403
8409
|
* Unmapped Count
|
|
8404
8410
|
*/
|
|
@@ -11038,6 +11044,21 @@ export type OperationEnvelopeListPublishListMemberResponse = {
|
|
|
11038
11044
|
*/
|
|
11039
11045
|
idempotentReplay?: boolean;
|
|
11040
11046
|
};
|
|
11047
|
+
/**
|
|
11048
|
+
* OperationResumeRequest
|
|
11049
|
+
*
|
|
11050
|
+
* Answer for an operation paused at a checkpoint (`awaiting_input`).
|
|
11051
|
+
*/
|
|
11052
|
+
export type OperationResumeRequest = {
|
|
11053
|
+
/**
|
|
11054
|
+
* Input
|
|
11055
|
+
*
|
|
11056
|
+
* The decision the paused run asked for, in whatever shape its prompt described. Delivered to the task as `params['resume']['input']`.
|
|
11057
|
+
*/
|
|
11058
|
+
input?: {
|
|
11059
|
+
[key: string]: unknown;
|
|
11060
|
+
};
|
|
11061
|
+
};
|
|
11041
11062
|
/**
|
|
11042
11063
|
* OperatorListResponse
|
|
11043
11064
|
*
|
|
@@ -11205,6 +11226,12 @@ export type OperatorRequest = {
|
|
|
11205
11226
|
* Enable streaming response
|
|
11206
11227
|
*/
|
|
11207
11228
|
stream?: boolean;
|
|
11229
|
+
/**
|
|
11230
|
+
* Max Credits
|
|
11231
|
+
*
|
|
11232
|
+
* Per-question credit ceiling. Once the run's consumed credits reach this number, no further tool step starts and the operator answers from what it has (the wrap-up itself may carry the total slightly past the ceiling). Omit for the mode's default step-bounded behavior.
|
|
11233
|
+
*/
|
|
11234
|
+
max_credits?: number | null;
|
|
11208
11235
|
};
|
|
11209
11236
|
/**
|
|
11210
11237
|
* OperatorResponse
|
|
@@ -17195,6 +17222,47 @@ export type UserResponse = {
|
|
|
17195
17222
|
*/
|
|
17196
17223
|
accounts?: Array<AccountInfo>;
|
|
17197
17224
|
};
|
|
17225
|
+
/**
|
|
17226
|
+
* ValidationCheckResponse
|
|
17227
|
+
*
|
|
17228
|
+
* Aggregate result of running reporting rules over a structure.
|
|
17229
|
+
*
|
|
17230
|
+
* Every rule runs once per rendered period column; on a multi-column
|
|
17231
|
+
* statement each failure and warning is prefixed with the column it was
|
|
17232
|
+
* found in (``[Prior] …``).
|
|
17233
|
+
*/
|
|
17234
|
+
export type ValidationCheckResponse = {
|
|
17235
|
+
/**
|
|
17236
|
+
* Passed
|
|
17237
|
+
*
|
|
17238
|
+
* True iff at least one rule ran and every rule produced zero failures on every rendered column. False when nothing was checked (`status == 'inconclusive'`).
|
|
17239
|
+
*/
|
|
17240
|
+
passed: boolean;
|
|
17241
|
+
/**
|
|
17242
|
+
* Status
|
|
17243
|
+
*
|
|
17244
|
+
* `passed` — every rule ran on every column with zero failures; `failed` — at least one rule failed; `inconclusive` — no validation rules exist for this block type, so nothing was checked.
|
|
17245
|
+
*/
|
|
17246
|
+
status: string;
|
|
17247
|
+
/**
|
|
17248
|
+
* Checks
|
|
17249
|
+
*
|
|
17250
|
+
* Names of rules that were evaluated.
|
|
17251
|
+
*/
|
|
17252
|
+
checks: Array<string>;
|
|
17253
|
+
/**
|
|
17254
|
+
* Failures
|
|
17255
|
+
*
|
|
17256
|
+
* Human-readable descriptions of rule failures.
|
|
17257
|
+
*/
|
|
17258
|
+
failures: Array<string>;
|
|
17259
|
+
/**
|
|
17260
|
+
* Warnings
|
|
17261
|
+
*
|
|
17262
|
+
* Non-blocking advisories from rule evaluation.
|
|
17263
|
+
*/
|
|
17264
|
+
warnings: Array<string>;
|
|
17265
|
+
};
|
|
17198
17266
|
/**
|
|
17199
17267
|
* ValidationError
|
|
17200
17268
|
*/
|
|
@@ -17237,6 +17305,10 @@ export type ValidationLite = {
|
|
|
17237
17305
|
* Passed
|
|
17238
17306
|
*/
|
|
17239
17307
|
passed?: boolean;
|
|
17308
|
+
/**
|
|
17309
|
+
* Status
|
|
17310
|
+
*/
|
|
17311
|
+
status?: string;
|
|
17240
17312
|
/**
|
|
17241
17313
|
* Checks
|
|
17242
17314
|
*/
|
|
@@ -17520,7 +17592,7 @@ export type ViewResponse = {
|
|
|
17520
17592
|
/**
|
|
17521
17593
|
* Summary
|
|
17522
17594
|
*
|
|
17523
|
-
* Per-element aggregates, only when include_summary=true.
|
|
17595
|
+
* Per-element aggregates, only when include_summary=true. `total` and `average` span every returned period, so they are present for duration elements only — instants omit both (a balance summed across periods is not a balance). Overlapping duration windows sharing a period_end (quarter + year-to-date) contribute only the narrowest window, so a quarter is never double-counted inside its own YTD figure.
|
|
17524
17596
|
*/
|
|
17525
17597
|
summary?: {
|
|
17526
17598
|
[key: string]: ElementSummary;
|
|
@@ -20397,7 +20469,7 @@ export type AutoSelectOperatorData = {
|
|
|
20397
20469
|
/**
|
|
20398
20470
|
* Mode
|
|
20399
20471
|
*
|
|
20400
|
-
*
|
|
20472
|
+
* `sync` waits up to 50s for the answer and returns 200 with it (202 with the operation links if the worker is still busy). Anything else — `async`, `stream`, `auto` or unset — queues the run and returns 202; follow `_links.stream` for progress and the result.
|
|
20401
20473
|
*/
|
|
20402
20474
|
mode?: ResponseMode | null;
|
|
20403
20475
|
};
|
|
@@ -20444,7 +20516,7 @@ export type AutoSelectOperatorResponses = {
|
|
|
20444
20516
|
*/
|
|
20445
20517
|
200: OperatorResponse;
|
|
20446
20518
|
/**
|
|
20447
|
-
*
|
|
20519
|
+
* Run queued on the worker — follow `_links.stream`
|
|
20448
20520
|
*/
|
|
20449
20521
|
202: unknown;
|
|
20450
20522
|
};
|
|
@@ -20520,7 +20592,7 @@ export type ExecuteSpecificOperatorData = {
|
|
|
20520
20592
|
/**
|
|
20521
20593
|
* Mode
|
|
20522
20594
|
*
|
|
20523
|
-
*
|
|
20595
|
+
* `sync` waits up to 50s for the answer and returns 200 with it (202 with the operation links if the worker is still busy). Anything else — `async`, `stream`, `auto` or unset — queues the run and returns 202; follow `_links.stream` for progress and the result.
|
|
20524
20596
|
*/
|
|
20525
20597
|
mode?: ResponseMode | null;
|
|
20526
20598
|
};
|
|
@@ -20567,7 +20639,7 @@ export type ExecuteSpecificOperatorResponses = {
|
|
|
20567
20639
|
*/
|
|
20568
20640
|
200: OperatorResponse;
|
|
20569
20641
|
/**
|
|
20570
|
-
*
|
|
20642
|
+
* Run queued on the worker — follow `_links.stream`
|
|
20571
20643
|
*/
|
|
20572
20644
|
202: unknown;
|
|
20573
20645
|
};
|
|
@@ -23892,6 +23964,65 @@ export type CancelOperationResponses = {
|
|
|
23892
23964
|
};
|
|
23893
23965
|
};
|
|
23894
23966
|
export type CancelOperationResponse = CancelOperationResponses[keyof CancelOperationResponses];
|
|
23967
|
+
export type ResumeOperationData = {
|
|
23968
|
+
body: OperationResumeRequest;
|
|
23969
|
+
path: {
|
|
23970
|
+
/**
|
|
23971
|
+
* Operation Id
|
|
23972
|
+
*
|
|
23973
|
+
* Operation identifier
|
|
23974
|
+
*/
|
|
23975
|
+
operation_id: string;
|
|
23976
|
+
};
|
|
23977
|
+
query?: never;
|
|
23978
|
+
url: '/v1/operations/{operation_id}/resume';
|
|
23979
|
+
};
|
|
23980
|
+
export type ResumeOperationErrors = {
|
|
23981
|
+
/**
|
|
23982
|
+
* Invalid request
|
|
23983
|
+
*/
|
|
23984
|
+
400: ErrorResponse;
|
|
23985
|
+
/**
|
|
23986
|
+
* Authentication required
|
|
23987
|
+
*/
|
|
23988
|
+
401: ErrorResponse;
|
|
23989
|
+
/**
|
|
23990
|
+
* Access denied
|
|
23991
|
+
*/
|
|
23992
|
+
403: ErrorResponse;
|
|
23993
|
+
/**
|
|
23994
|
+
* Resource not found
|
|
23995
|
+
*/
|
|
23996
|
+
404: ErrorResponse;
|
|
23997
|
+
/**
|
|
23998
|
+
* Operation is not waiting for input
|
|
23999
|
+
*/
|
|
24000
|
+
409: unknown;
|
|
24001
|
+
/**
|
|
24002
|
+
* Validation Error
|
|
24003
|
+
*/
|
|
24004
|
+
422: HttpValidationError;
|
|
24005
|
+
/**
|
|
24006
|
+
* Rate limit exceeded
|
|
24007
|
+
*/
|
|
24008
|
+
429: ErrorResponse;
|
|
24009
|
+
/**
|
|
24010
|
+
* Internal server error
|
|
24011
|
+
*/
|
|
24012
|
+
500: ErrorResponse;
|
|
24013
|
+
};
|
|
24014
|
+
export type ResumeOperationError = ResumeOperationErrors[keyof ResumeOperationErrors];
|
|
24015
|
+
export type ResumeOperationResponses = {
|
|
24016
|
+
/**
|
|
24017
|
+
* Response Resumeoperation
|
|
24018
|
+
*
|
|
24019
|
+
* Successful Response
|
|
24020
|
+
*/
|
|
24021
|
+
202: {
|
|
24022
|
+
[key: string]: unknown;
|
|
24023
|
+
};
|
|
24024
|
+
};
|
|
24025
|
+
export type ResumeOperationResponse = ResumeOperationResponses[keyof ResumeOperationResponses];
|
|
23895
24026
|
export type GetOrgBillingCustomerData = {
|
|
23896
24027
|
body?: never;
|
|
23897
24028
|
path: {
|