@robosystems/client 0.3.6 → 0.3.8

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/sdk.gen.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { Client, Options as Options2, TDataShape } from './client';
2
- import type { AutoSelectAgentData, AutoSelectAgentErrors, AutoSelectAgentResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificAgentData, ExecuteSpecificAgentErrors, ExecuteSpecificAgentResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAgentMetadataData, GetAgentMetadataErrors, GetAgentMetadataResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, OpAddPublishListMembersData, OpAddPublishListMembersErrors, OpAddPublishListMembersResponses, OpAutoMapElementsData, OpAutoMapElementsErrors, OpAutoMapElementsResponses, OpBuildFactGridData, OpBuildFactGridErrors, OpBuildFactGridResponses, OpChangeTierData, OpChangeTierErrors, OpChangeTierResponses, OpClosePeriodData, OpClosePeriodErrors, OpClosePeriodResponses, OpCreateAssociationsData, OpCreateAssociationsErrors, OpCreateAssociationsResponses, OpCreateBackupData, OpCreateBackupErrors, OpCreateBackupResponses, OpCreateClosingEntryData, OpCreateClosingEntryErrors, OpCreateClosingEntryResponses, OpCreateElementData, OpCreateElementErrors, OpCreateElementResponses, OpCreateJournalEntryData, OpCreateJournalEntryErrors, OpCreateJournalEntryResponses, OpCreateManualClosingEntryData, OpCreateManualClosingEntryErrors, OpCreateManualClosingEntryResponses, OpCreateMappingAssociationData, OpCreateMappingAssociationErrors, OpCreateMappingAssociationResponses, OpCreatePortfolioData, OpCreatePortfolioErrors, OpCreatePortfolioResponses, OpCreatePositionData, OpCreatePositionErrors, OpCreatePositionResponses, OpCreatePublishListData, OpCreatePublishListErrors, OpCreatePublishListResponses, OpCreateReportData, OpCreateReportErrors, OpCreateReportResponses, OpCreateScheduleData, OpCreateScheduleErrors, OpCreateScheduleResponses, OpCreateSecurityData, OpCreateSecurityErrors, OpCreateSecurityResponses, OpCreateStructureData, OpCreateStructureErrors, OpCreateStructureResponses, OpCreateSubgraphData, OpCreateSubgraphErrors, OpCreateSubgraphResponses, OpCreateTaxonomyData, OpCreateTaxonomyErrors, OpCreateTaxonomyResponses, OpCreateTransactionData, OpCreateTransactionErrors, OpCreateTransactionResponses, OpDeleteAssociationData, OpDeleteAssociationErrors, OpDeleteAssociationResponses, OpDeleteElementData, OpDeleteElementErrors, OpDeleteElementResponses, OpDeleteJournalEntryData, OpDeleteJournalEntryErrors, OpDeleteJournalEntryResponses, OpDeleteMappingAssociationData, OpDeleteMappingAssociationErrors, OpDeleteMappingAssociationResponses, OpDeletePortfolioData, OpDeletePortfolioErrors, OpDeletePortfolioResponses, OpDeletePositionData, OpDeletePositionErrors, OpDeletePositionResponses, OpDeletePublishListData, OpDeletePublishListErrors, OpDeletePublishListResponses, OpDeleteReportData, OpDeleteReportErrors, OpDeleteReportResponses, OpDeleteScheduleData, OpDeleteScheduleErrors, OpDeleteScheduleResponses, OpDeleteSecurityData, OpDeleteSecurityErrors, OpDeleteSecurityResponses, OpDeleteStructureData, OpDeleteStructureErrors, OpDeleteStructureResponses, OpDeleteSubgraphData, OpDeleteSubgraphErrors, OpDeleteSubgraphResponses, OpDeleteTaxonomyData, OpDeleteTaxonomyErrors, OpDeleteTaxonomyResponses, OpInitializeLedgerData, OpInitializeLedgerErrors, OpInitializeLedgerResponses, OpLinkEntityTaxonomyData, OpLinkEntityTaxonomyErrors, OpLinkEntityTaxonomyResponses, OpMaterializeData, OpMaterializeErrors, OpMaterializeResponses, OpRegenerateReportData, OpRegenerateReportErrors, OpRegenerateReportResponses, OpRemovePublishListMemberData, OpRemovePublishListMemberErrors, OpRemovePublishListMemberResponses, OpReopenPeriodData, OpReopenPeriodErrors, OpReopenPeriodResponses, OpRestoreBackupData, OpRestoreBackupErrors, OpRestoreBackupResponses, OpReverseJournalEntryData, OpReverseJournalEntryErrors, OpReverseJournalEntryResponses, OpSetCloseTargetData, OpSetCloseTargetErrors, OpSetCloseTargetResponses, OpShareReportData, OpShareReportErrors, OpShareReportResponses, OpTruncateScheduleData, OpTruncateScheduleErrors, OpTruncateScheduleResponses, OpUpdateAssociationData, OpUpdateAssociationErrors, OpUpdateAssociationResponses, OpUpdateElementData, OpUpdateElementErrors, OpUpdateElementResponses, OpUpdateEntityData, OpUpdateEntityErrors, OpUpdateEntityResponses, OpUpdateJournalEntryData, OpUpdateJournalEntryErrors, OpUpdateJournalEntryResponses, OpUpdatePortfolioData, OpUpdatePortfolioErrors, OpUpdatePortfolioResponses, OpUpdatePositionData, OpUpdatePositionErrors, OpUpdatePositionResponses, OpUpdatePublishListData, OpUpdatePublishListErrors, OpUpdatePublishListResponses, OpUpdateScheduleData, OpUpdateScheduleErrors, OpUpdateScheduleResponses, OpUpdateSecurityData, OpUpdateSecurityErrors, OpUpdateSecurityResponses, OpUpdateStructureData, OpUpdateStructureErrors, OpUpdateStructureResponses, OpUpdateTaxonomyData, OpUpdateTaxonomyErrors, OpUpdateTaxonomyResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendAgentData, RecommendAgentErrors, RecommendAgentResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, UploadDocumentsBulkData, UploadDocumentsBulkErrors, UploadDocumentsBulkResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
2
+ import type { AutoSelectAgentData, AutoSelectAgentErrors, AutoSelectAgentResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificAgentData, ExecuteSpecificAgentErrors, ExecuteSpecificAgentResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAgentMetadataData, GetAgentMetadataErrors, GetAgentMetadataResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, 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, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, 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, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, OpAddPublishListMembersData, OpAddPublishListMembersErrors, OpAddPublishListMembersResponses, OpAutoMapElementsData, OpAutoMapElementsErrors, OpAutoMapElementsResponses, OpBuildFactGridData, OpBuildFactGridErrors, OpBuildFactGridResponses, OpChangeTierData, OpChangeTierErrors, OpChangeTierResponses, OpClosePeriodData, OpClosePeriodErrors, OpClosePeriodResponses, OpCreateAssociationsData, OpCreateAssociationsErrors, OpCreateAssociationsResponses, OpCreateBackupData, OpCreateBackupErrors, OpCreateBackupResponses, OpCreateClosingEntryData, OpCreateClosingEntryErrors, OpCreateClosingEntryResponses, OpCreateElementData, OpCreateElementErrors, OpCreateElementResponses, OpCreateJournalEntryData, OpCreateJournalEntryErrors, OpCreateJournalEntryResponses, OpCreateManualClosingEntryData, OpCreateManualClosingEntryErrors, OpCreateManualClosingEntryResponses, OpCreateMappingAssociationData, OpCreateMappingAssociationErrors, OpCreateMappingAssociationResponses, OpCreatePortfolioData, OpCreatePortfolioErrors, OpCreatePortfolioResponses, OpCreatePositionData, OpCreatePositionErrors, OpCreatePositionResponses, OpCreatePublishListData, OpCreatePublishListErrors, OpCreatePublishListResponses, OpCreateReportData, OpCreateReportErrors, OpCreateReportResponses, OpCreateScheduleData, OpCreateScheduleErrors, OpCreateScheduleResponses, OpCreateSecurityData, OpCreateSecurityErrors, OpCreateSecurityResponses, OpCreateStructureData, OpCreateStructureErrors, OpCreateStructureResponses, OpCreateSubgraphData, OpCreateSubgraphErrors, OpCreateSubgraphResponses, OpCreateTaxonomyData, OpCreateTaxonomyErrors, OpCreateTaxonomyResponses, OpCreateTransactionData, OpCreateTransactionErrors, OpCreateTransactionResponses, OpDeleteAssociationData, OpDeleteAssociationErrors, OpDeleteAssociationResponses, OpDeleteElementData, OpDeleteElementErrors, OpDeleteElementResponses, OpDeleteJournalEntryData, OpDeleteJournalEntryErrors, OpDeleteJournalEntryResponses, OpDeleteMappingAssociationData, OpDeleteMappingAssociationErrors, OpDeleteMappingAssociationResponses, OpDeletePortfolioData, OpDeletePortfolioErrors, OpDeletePortfolioResponses, OpDeletePositionData, OpDeletePositionErrors, OpDeletePositionResponses, OpDeletePublishListData, OpDeletePublishListErrors, OpDeletePublishListResponses, OpDeleteReportData, OpDeleteReportErrors, OpDeleteReportResponses, OpDeleteScheduleData, OpDeleteScheduleErrors, OpDeleteScheduleResponses, OpDeleteSecurityData, OpDeleteSecurityErrors, OpDeleteSecurityResponses, OpDeleteStructureData, OpDeleteStructureErrors, OpDeleteStructureResponses, OpDeleteSubgraphData, OpDeleteSubgraphErrors, OpDeleteSubgraphResponses, OpDeleteTaxonomyData, OpDeleteTaxonomyErrors, OpDeleteTaxonomyResponses, OpFinancialStatementAnalysisData, OpFinancialStatementAnalysisErrors, OpFinancialStatementAnalysisResponses, OpInitializeLedgerData, OpInitializeLedgerErrors, OpInitializeLedgerResponses, OpLinkEntityTaxonomyData, OpLinkEntityTaxonomyErrors, OpLinkEntityTaxonomyResponses, OpLiveFinancialStatementData, OpLiveFinancialStatementErrors, OpLiveFinancialStatementResponses, OpMaterializeData, OpMaterializeErrors, OpMaterializeResponses, OpRegenerateReportData, OpRegenerateReportErrors, OpRegenerateReportResponses, OpRemovePublishListMemberData, OpRemovePublishListMemberErrors, OpRemovePublishListMemberResponses, OpReopenPeriodData, OpReopenPeriodErrors, OpReopenPeriodResponses, OpRestoreBackupData, OpRestoreBackupErrors, OpRestoreBackupResponses, OpReverseJournalEntryData, OpReverseJournalEntryErrors, OpReverseJournalEntryResponses, OpSetCloseTargetData, OpSetCloseTargetErrors, OpSetCloseTargetResponses, OpShareReportData, OpShareReportErrors, OpShareReportResponses, OpTruncateScheduleData, OpTruncateScheduleErrors, OpTruncateScheduleResponses, OpUpdateAssociationData, OpUpdateAssociationErrors, OpUpdateAssociationResponses, OpUpdateElementData, OpUpdateElementErrors, OpUpdateElementResponses, OpUpdateEntityData, OpUpdateEntityErrors, OpUpdateEntityResponses, OpUpdateJournalEntryData, OpUpdateJournalEntryErrors, OpUpdateJournalEntryResponses, OpUpdatePortfolioData, OpUpdatePortfolioErrors, OpUpdatePortfolioResponses, OpUpdatePositionData, OpUpdatePositionErrors, OpUpdatePositionResponses, OpUpdatePublishListData, OpUpdatePublishListErrors, OpUpdatePublishListResponses, OpUpdateScheduleData, OpUpdateScheduleErrors, OpUpdateScheduleResponses, OpUpdateSecurityData, OpUpdateSecurityErrors, OpUpdateSecurityResponses, OpUpdateStructureData, OpUpdateStructureErrors, OpUpdateStructureResponses, OpUpdateTaxonomyData, OpUpdateTaxonomyErrors, OpUpdateTaxonomyResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendAgentData, RecommendAgentErrors, RecommendAgentResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -16,35 +16,27 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
16
16
  /**
17
17
  * Register New User
18
18
  *
19
- * Register a new user account with email and password.
20
- *
21
- * **Organization Creation**: RoboSystems is an org-centric platform. When you register, a personal organization is automatically created for you. All resources (graphs, subscriptions, billing) belong to organizations, not individual users. You can later upgrade your personal org to a team or enterprise organization.
22
- *
23
- * **Security Controls**: CAPTCHA and email verification are disabled in development for API testing, but required in production.
19
+ * Creates the user and a personal organization. CAPTCHA required in production. Sends verification email when email verification is enabled.
24
20
  */
25
21
  export declare const registerUser: <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => import("./client").RequestResult<RegisterUserResponses, RegisterUserErrors, ThrowOnError, "fields">;
26
22
  /**
27
23
  * User Login
28
24
  *
29
- * Authenticate user with email and password.
25
+ * Returns a JWT token on success. IP-based progressive delays apply after repeated failures.
30
26
  */
31
27
  export declare const loginUser: <ThrowOnError extends boolean = false>(options: Options<LoginUserData, ThrowOnError>) => import("./client").RequestResult<LoginUserResponses, LoginUserErrors, ThrowOnError, "fields">;
32
28
  /**
33
29
  * User Logout
34
- *
35
- * Logout user and invalidate session.
36
30
  */
37
- export declare const logoutUser: <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => import("./client").RequestResult<LogoutUserResponses, unknown, ThrowOnError, "fields">;
31
+ export declare const logoutUser: <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => import("./client").RequestResult<LogoutUserResponses, LogoutUserErrors, ThrowOnError, "fields">;
38
32
  /**
39
33
  * Get Current User
40
- *
41
- * Get the currently authenticated user.
42
34
  */
43
35
  export declare const getCurrentAuthUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentAuthUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, ThrowOnError, "fields">;
44
36
  /**
45
37
  * Refresh Session
46
38
  *
47
- * Refresh authentication session with a new JWT token.
39
+ * Revokes the current token and issues a new one. Accepts recently-expired tokens within the grace period.
48
40
  */
49
41
  export declare const refreshAuthSession: <ThrowOnError extends boolean = false>(options?: Options<RefreshAuthSessionData, ThrowOnError>) => import("./client").RequestResult<RefreshAuthSessionResponses, RefreshAuthSessionErrors, ThrowOnError, "fields">;
50
42
  /**
@@ -61,14 +53,10 @@ export declare const resendVerificationEmail: <ThrowOnError extends boolean = fa
61
53
  export declare const verifyEmail: <ThrowOnError extends boolean = false>(options: Options<VerifyEmailData, ThrowOnError>) => import("./client").RequestResult<VerifyEmailResponses, VerifyEmailErrors, ThrowOnError, "fields">;
62
54
  /**
63
55
  * Get Password Policy
64
- *
65
- * Get current password policy requirements for frontend validation
66
56
  */
67
- export declare const getPasswordPolicy: <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => import("./client").RequestResult<GetPasswordPolicyResponses, unknown, ThrowOnError, "fields">;
57
+ export declare const getPasswordPolicy: <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => import("./client").RequestResult<GetPasswordPolicyResponses, GetPasswordPolicyErrors, ThrowOnError, "fields">;
68
58
  /**
69
59
  * Check Password Strength
70
- *
71
- * Check password strength and get validation feedback
72
60
  */
73
61
  export declare const checkPasswordStrength: <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => import("./client").RequestResult<CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ThrowOnError, "fields">;
74
62
  /**
@@ -80,531 +68,219 @@ export declare const forgotPassword: <ThrowOnError extends boolean = false>(opti
80
68
  /**
81
69
  * Validate Reset Token
82
70
  *
83
- * Check if a password reset token is valid without consuming it.
71
+ * Check if a password reset token is valid without consuming it. Returns masked email on success.
84
72
  */
85
73
  export declare const validateResetToken: <ThrowOnError extends boolean = false>(options: Options<ValidateResetTokenData, ThrowOnError>) => import("./client").RequestResult<ValidateResetTokenResponses, ValidateResetTokenErrors, ThrowOnError, "fields">;
86
74
  /**
87
75
  * Reset Password
88
76
  *
89
- * Reset password with token from email. Returns JWT for auto-login.
77
+ * Reset password with token from email. Invalidates all existing sessions. Returns JWT for auto-login.
90
78
  */
91
79
  export declare const resetPassword: <ThrowOnError extends boolean = false>(options: Options<ResetPasswordData, ThrowOnError>) => import("./client").RequestResult<ResetPasswordResponses, ResetPasswordErrors, ThrowOnError, "fields">;
92
80
  /**
93
81
  * Generate SSO Token
94
82
  *
95
- * Generate a temporary SSO token for cross-app authentication.
83
+ * Step 1 of 3 in the cross-app SSO flow. Issues a single-use token (60s TTL) for handoff to a target application.
96
84
  */
97
85
  export declare const generateSsoToken: <ThrowOnError extends boolean = false>(options?: Options<GenerateSsoTokenData, ThrowOnError>) => import("./client").RequestResult<GenerateSsoTokenResponses, GenerateSsoTokenErrors, ThrowOnError, "fields">;
98
86
  /**
99
87
  * SSO Token Exchange
100
88
  *
101
- * Exchange SSO token for secure session handoff to target application.
89
+ * Step 2 of 3. Exchanges the SSO token for a short-lived session ID. Avoids passing tokens in redirect URLs.
102
90
  */
103
91
  export declare const ssoTokenExchange: <ThrowOnError extends boolean = false>(options: Options<SsoTokenExchangeData, ThrowOnError>) => import("./client").RequestResult<SsoTokenExchangeResponses, SsoTokenExchangeErrors, ThrowOnError, "fields">;
104
92
  /**
105
93
  * Complete SSO Authentication
106
94
  *
107
- * Complete SSO authentication using session ID from secure handoff.
95
+ * Step 3 of 3. Exchanges the session ID for a full JWT token. Called by the target app after redirect.
108
96
  */
109
97
  export declare const completeSsoAuth: <ThrowOnError extends boolean = false>(options: Options<CompleteSsoAuthData, ThrowOnError>) => import("./client").RequestResult<CompleteSsoAuthResponses, CompleteSsoAuthErrors, ThrowOnError, "fields">;
110
98
  /**
111
99
  * Get CAPTCHA Configuration
112
100
  *
113
- * Get CAPTCHA configuration including site key and whether CAPTCHA is required.
101
+ * Returns site key and whether CAPTCHA is required. Site key is null when CAPTCHA is disabled.
114
102
  */
115
- export declare const getCaptchaConfig: <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => import("./client").RequestResult<GetCaptchaConfigResponses, unknown, ThrowOnError, "fields">;
103
+ export declare const getCaptchaConfig: <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => import("./client").RequestResult<GetCaptchaConfigResponses, GetCaptchaConfigErrors, ThrowOnError, "fields">;
116
104
  /**
117
105
  * Health Check
118
106
  *
119
- * Service health check endpoint for monitoring and load balancers
107
+ * Unprotected used by load balancers and monitoring. No authentication required.
120
108
  */
121
109
  export declare const getServiceStatus: <ThrowOnError extends boolean = false>(options?: Options<GetServiceStatusData, ThrowOnError>) => import("./client").RequestResult<GetServiceStatusResponses, unknown, ThrowOnError, "fields">;
122
110
  /**
123
111
  * Get Current User
124
- *
125
- * Returns information about the currently authenticated user.
126
112
  */
127
- export declare const getCurrentUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentUserResponses, unknown, ThrowOnError, "fields">;
113
+ export declare const getCurrentUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentUserResponses, GetCurrentUserErrors, ThrowOnError, "fields">;
128
114
  /**
129
115
  * Update User Profile
130
- *
131
- * Update the current user's profile information.
132
116
  */
133
117
  export declare const updateUser: <ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>) => import("./client").RequestResult<UpdateUserResponses, UpdateUserErrors, ThrowOnError, "fields">;
134
118
  /**
135
119
  * Update Password
136
120
  *
137
- * Update the current user's password.
121
+ * Requires current password verification. Not available for SSO-only accounts.
138
122
  */
139
123
  export declare const updateUserPassword: <ThrowOnError extends boolean = false>(options: Options<UpdateUserPasswordData, ThrowOnError>) => import("./client").RequestResult<UpdateUserPasswordResponses, UpdateUserPasswordErrors, ThrowOnError, "fields">;
140
124
  /**
141
125
  * List API Keys
142
- *
143
- * Get all API keys for the current user.
144
126
  */
145
- export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) => import("./client").RequestResult<ListUserApiKeysResponses, unknown, ThrowOnError, "fields">;
127
+ export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) => import("./client").RequestResult<ListUserApiKeysResponses, ListUserApiKeysErrors, ThrowOnError, "fields">;
146
128
  /**
147
129
  * Create API Key
148
130
  *
149
- * Create a new API key for the current user.
131
+ * The raw key value is only returned once at creation time and cannot be retrieved again.
150
132
  */
151
133
  export declare const createUserApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError, "fields">;
152
134
  /**
153
135
  * Revoke API Key
154
136
  *
155
- * Revoke (deactivate) an API key.
137
+ * Deactivates the key immediately. Requests using the revoked key will fail with 401.
156
138
  */
157
139
  export declare const revokeUserApiKey: <ThrowOnError extends boolean = false>(options: Options<RevokeUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, ThrowOnError, "fields">;
158
140
  /**
159
141
  * Update API Key
160
- *
161
- * Update an API key's name or description.
162
142
  */
163
143
  export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ThrowOnError, "fields">;
164
144
  /**
165
145
  * List User's Organizations
166
- *
167
- * Get all organizations the current user belongs to, with their role in each.
168
146
  */
169
- export declare const listUserOrgs: <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => import("./client").RequestResult<ListUserOrgsResponses, unknown, ThrowOnError, "fields">;
147
+ export declare const listUserOrgs: <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => import("./client").RequestResult<ListUserOrgsResponses, ListUserOrgsErrors, ThrowOnError, "fields">;
170
148
  /**
171
149
  * Get Organization
172
- *
173
- * Get detailed information about an organization.
174
150
  */
175
151
  export declare const getOrg: <ThrowOnError extends boolean = false>(options: Options<GetOrgData, ThrowOnError>) => import("./client").RequestResult<GetOrgResponses, GetOrgErrors, ThrowOnError, "fields">;
176
152
  /**
177
153
  * Update Organization
178
154
  *
179
- * Update organization information. Requires admin or owner role.
155
+ * Requires admin or owner role. Only owners can change the org type.
180
156
  */
181
157
  export declare const updateOrg: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgData, ThrowOnError>) => import("./client").RequestResult<UpdateOrgResponses, UpdateOrgErrors, ThrowOnError, "fields">;
182
158
  /**
183
159
  * List Organization Graphs
184
- *
185
- * Get all graphs belonging to an organization.
186
160
  */
187
161
  export declare const listOrgGraphs: <ThrowOnError extends boolean = false>(options: Options<ListOrgGraphsData, ThrowOnError>) => import("./client").RequestResult<ListOrgGraphsResponses, ListOrgGraphsErrors, ThrowOnError, "fields">;
188
162
  /**
189
163
  * List Organization Members
190
- *
191
- * Get all members of an organization with their roles.
192
164
  */
193
165
  export declare const listOrgMembers: <ThrowOnError extends boolean = false>(options: Options<ListOrgMembersData, ThrowOnError>) => import("./client").RequestResult<ListOrgMembersResponses, ListOrgMembersErrors, ThrowOnError, "fields">;
194
166
  /**
195
167
  * Invite Member
196
168
  *
197
- * Invite a user to join the organization. Requires admin or owner role.
198
- *
199
- * **⚠️ FEATURE NOT READY**: This endpoint is disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false).
200
- * Returns 501 NOT IMPLEMENTED when disabled. See endpoint implementation for TODO list before enabling.
169
+ * Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false). Returns 501 when disabled. Requires admin or owner role.
201
170
  */
202
171
  export declare const inviteOrgMember: <ThrowOnError extends boolean = false>(options: Options<InviteOrgMemberData, ThrowOnError>) => import("./client").RequestResult<InviteOrgMemberResponses, InviteOrgMemberErrors, ThrowOnError, "fields">;
203
172
  /**
204
173
  * Remove Member
205
174
  *
206
- * Remove a member from the organization. Requires admin or owner role.
175
+ * Requires admin or owner role. Members may remove themselves.
207
176
  */
208
177
  export declare const removeOrgMember: <ThrowOnError extends boolean = false>(options: Options<RemoveOrgMemberData, ThrowOnError>) => import("./client").RequestResult<RemoveOrgMemberResponses, RemoveOrgMemberErrors, ThrowOnError, "fields">;
209
178
  /**
210
179
  * Update Member Role
211
180
  *
212
- * Update a member's role in the organization. Requires admin or owner role.
181
+ * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
213
182
  */
214
183
  export declare const updateOrgMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) => import("./client").RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError, "fields">;
215
184
  /**
216
185
  * Get Organization Limits
217
- *
218
- * Get the current limits and quotas for an organization.
219
186
  */
220
187
  export declare const getOrgLimits: <ThrowOnError extends boolean = false>(options: Options<GetOrgLimitsData, ThrowOnError>) => import("./client").RequestResult<GetOrgLimitsResponses, GetOrgLimitsErrors, ThrowOnError, "fields">;
221
188
  /**
222
189
  * Get Organization Usage
223
190
  *
224
- * Get detailed usage statistics for an organization aggregated across all graphs.
191
+ * Aggregated across all graphs in the org. Use the `days` query param to control the lookback window (default 30).
225
192
  */
226
193
  export declare const getOrgUsage: <ThrowOnError extends boolean = false>(options: Options<GetOrgUsageData, ThrowOnError>) => import("./client").RequestResult<GetOrgUsageResponses, GetOrgUsageErrors, ThrowOnError, "fields">;
227
194
  /**
228
195
  * List Connections
229
- *
230
- * List all data connections in the graph.
231
- *
232
- * Returns active and inactive connections with their current status.
233
- * Connections can be filtered by:
234
- * - **Entity**: Show connections for a specific entity
235
- * - **Provider**: Filter by connection type (sec, quickbooks)
236
- *
237
- * Each connection shows:
238
- * - Current sync status and health
239
- * - Last successful sync timestamp
240
- * - Configuration metadata
241
- * - Error messages if any
242
- *
243
- * No credits are consumed for listing connections.
244
196
  */
245
197
  export declare const listConnections: <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => import("./client").RequestResult<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError, "fields">;
246
198
  /**
247
199
  * Create Connection
248
200
  *
249
- * Create a new data connection for external system integration.
250
- *
251
- * This endpoint initiates connections to external data sources:
252
- *
253
- * **SEC Connections**:
254
- * - Provide entity CIK for automatic filing retrieval
255
- * - No authentication needed
256
- * - Begins immediate data sync
257
- *
258
- * **QuickBooks Connections**:
259
- * - Returns OAuth URL for authorization
260
- * - Requires admin permissions in QuickBooks
261
- * - Complete with OAuth callback
262
- *
263
- * Note:
264
- * This operation is included - no credit consumption required.
201
+ * SEC: provide entity CIK, no auth needed. QuickBooks: returns an OAuth URL — complete the flow to activate. One connection allowed per provider per graph.
265
202
  */
266
203
  export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => import("./client").RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError, "fields">;
267
204
  /**
268
205
  * List Connection Options
269
206
  *
270
- * Get metadata about all available data connection providers.
271
- *
272
- * This endpoint returns comprehensive information about each supported provider:
273
- *
274
- * **SEC EDGAR**: Public entity financial filings
275
- * - No authentication required (public data)
276
- * - 10-K, 10-Q, 8-K reports with XBRL data
277
- * - Historical and real-time filing access
278
- *
279
- * **QuickBooks Online**: Full accounting system integration
280
- * - OAuth 2.0 authentication
281
- * - Chart of accounts, transactions, trial balance
282
- * - Real-time sync capabilities
283
- *
284
- * No credits are consumed for viewing connection options.
207
+ * Returns available providers and their requirements. Only enabled providers are included (gated by feature flags). SEC requires no auth; QuickBooks requires OAuth 2.0.
285
208
  */
286
209
  export declare const getConnectionOptions: <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => import("./client").RequestResult<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError, "fields">;
287
210
  /**
288
- * Init Oauth
289
- *
290
- * Initialize OAuth flow for a connection.
291
- *
292
- * This generates an authorization URL that the frontend should redirect the user to.
293
- * Currently supports: QuickBooks
211
+ * Initialize OAuth Flow
294
212
  */
295
213
  export declare const initOAuth: <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => import("./client").RequestResult<InitOAuthResponses, InitOAuthErrors, ThrowOnError, "fields">;
296
214
  /**
297
215
  * OAuth Callback
298
216
  *
299
- * Handle OAuth callback from provider after user authorization.
300
- *
301
- * This endpoint completes the OAuth flow:
302
- * 1. Validates the OAuth state parameter
303
- * 2. Exchanges authorization code for access tokens
304
- * 3. Stores tokens securely
305
- * 4. Updates connection status
306
- * 5. Optionally triggers initial sync
307
- *
308
- * Supported providers:
309
- * - **QuickBooks**: Accounting data integration
310
- *
311
- * Security measures:
312
- * - State validation prevents session hijacking
313
- * - User context is verified
314
- * - Tokens are encrypted before storage
315
- * - Full audit trail is maintained
316
- *
317
- * No credits are consumed for OAuth callbacks.
217
+ * Completes the OAuth authorization flow after provider redirect. Exchanges the authorization code for tokens, stores them, and triggers an initial sync. This is a redirect target — not typically called directly.
318
218
  */
319
219
  export declare const oauthCallback: <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => import("./client").RequestResult<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError, "fields">;
320
220
  /**
321
221
  * Delete Connection
322
222
  *
323
- * Delete a data connection and clean up related resources.
324
- *
325
- * This operation:
326
- * - Removes the connection configuration
327
- * - Preserves any imported data in the graph
328
- * - Performs provider-specific cleanup
329
- * - Revokes stored credentials
330
- *
331
- * Note:
332
- * This operation is included - no credit consumption required.
333
- *
334
- * Only users with admin role can delete connections.
223
+ * Removes the connection and revokes credentials. Imported data is preserved in the graph. Requires admin role.
335
224
  */
336
225
  export declare const deleteConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => import("./client").RequestResult<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError, "fields">;
337
226
  /**
338
227
  * Get Connection
339
- *
340
- * Get detailed information about a specific connection.
341
- *
342
- * Returns comprehensive connection details including:
343
- * - Current status and health indicators
344
- * - Authentication state
345
- * - Sync history and statistics
346
- * - Error details if any
347
- * - Provider-specific metadata
348
- *
349
- * No credits are consumed for viewing connection details.
350
228
  */
351
229
  export declare const getConnection: <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => import("./client").RequestResult<GetConnectionResponses, GetConnectionErrors, ThrowOnError, "fields">;
352
230
  /**
353
231
  * Sync Connection
354
232
  *
355
- * Trigger a data synchronization for the connection.
356
- *
357
- * Initiates data sync based on provider type:
358
- *
359
- * **SEC Sync**:
360
- * - Downloads latest filings from EDGAR
361
- * - Parses XBRL data and updates graph
362
- * - Typically completes in 5-10 minutes
363
- *
364
- * **QuickBooks Sync**:
365
- * - Fetches latest transactions and balances
366
- * - Updates chart of accounts
367
- * - Generates fresh trial balance
368
- * - Duration depends on data volume
369
- *
370
- * Note:
371
- * This operation is included - no credit consumption required.
372
- *
373
- * Returns an `OperationEnvelope` with an `operationId` for tracking sync progress.
374
- * Supports `Idempotency-Key` header to safely retry without triggering duplicate syncs.
233
+ * SEC: downloads latest EDGAR filings (5-10 min). QuickBooks: fetches transactions, balances, and chart of accounts. Returns an `OperationEnvelope` — monitor progress via SSE at `/v1/operations/{operation_id}/stream`. Supports `Idempotency-Key`.
375
234
  */
376
235
  export declare const syncConnection: <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => import("./client").RequestResult<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError, "fields">;
377
236
  /**
378
- * List available agents
379
- *
380
- * Get a comprehensive list of all available agents with their metadata.
237
+ * List Available Agents
381
238
  *
382
- * **Returns:**
383
- * - Agent types and names
384
- * - Capabilities and supported modes
385
- * - Version information
386
- * - Credit requirements
387
- *
388
- * Use the optional `capability` filter to find agents with specific capabilities.
239
+ * Filter by capability using the `capability` query param (e.g., `financial_analysis`, `rag_search`).
389
240
  */
390
241
  export declare const listAgents: <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => import("./client").RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError, "fields">;
391
242
  /**
392
- * Auto-select agent for query
393
- *
394
- * Automatically select the best agent for your query with intelligent execution strategy.
395
- *
396
- * **Agent Selection Process:**
397
- *
398
- * The orchestrator intelligently routes your query by:
399
- * 1. Analyzing query intent and complexity
400
- * 2. Enriching context with RAG if enabled
401
- * 3. Evaluating all available agents against selection criteria
402
- * 4. Selecting the best match based on confidence scores
403
- * 5. Choosing execution strategy (sync/SSE/async) based on expected time
404
- * 6. Executing the query with the selected agent
405
- *
406
- * **Available Agent Types:**
407
- * - `financial`: Financial analysis, SEC filings, company metrics
408
- * - `research`: General research, data exploration, trend analysis
409
- * - `rag`: Knowledge base search using RAG enrichment
410
- *
411
- * **Execution Modes:**
412
- * - `quick`: Fast responses (~2-5s), suitable for simple queries
413
- * - `standard`: Balanced approach (~5-15s), default mode
414
- * - `extended`: Comprehensive analysis (~15-60s), deep research
415
- * - `streaming`: Real-time response streaming
416
- *
417
- * **Execution Strategies (automatic):**
418
- * - Fast operations (<5s): Immediate synchronous response
419
- * - Medium operations (5-30s): SSE streaming with progress updates
420
- * - Long operations (>30s): Background queue with operation tracking
421
- *
422
- * **Response Mode Override:**
423
- * Use query parameter `?mode=sync|async` to override automatic strategy selection.
424
- *
425
- * **Confidence Score Interpretation:**
426
- * - `0.9-1.0`: High confidence, agent is ideal match
427
- * - `0.7-0.9`: Good confidence, agent is suitable
428
- * - `0.5-0.7`: Moderate confidence, agent can handle but may not be optimal
429
- * - `0.3-0.5`: Low confidence, fallback agent used
430
- * - `<0.3`: Very low confidence, consider using specific agent endpoint
431
- *
432
- * **Credit Costs:**
433
- * - Quick mode: 5-10 credits per query
434
- * - Standard mode: 15-25 credits per query
435
- * - Extended mode: 30-75 credits per query
436
- * - RAG enrichment: +5-15 credits (if enabled)
437
- *
438
- * **Use Cases:**
439
- * - Ask questions without specifying agent type
440
- * - Get intelligent routing for complex multi-domain queries
441
- * - Leverage conversation history for contextual understanding
442
- * - Enable RAG for knowledge base enrichment
443
- *
444
- * **Subgraph Support:**
445
- * This endpoint accepts both parent graph IDs and subgraph IDs.
446
- * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
447
- * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
448
- * Agents operate on the specified graph/subgraph's data independently. RAG enrichment
449
- * and knowledge base search are scoped to the specific graph/subgraph.
450
- *
451
- * See request/response examples in the "Examples" dropdown below.
243
+ * Auto-select Agent for Query
244
+ *
245
+ * Routes to the best agent for your query. Agents: `financial` (SEC, accounting), `research` (deep analysis), `rag` (knowledge base, free). Credit cost by mode: `quick` 5-10, `standard` 15-25, `extended` 30-75. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
452
246
  */
453
247
  export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
454
248
  /**
455
- * Get agent metadata
456
- *
457
- * Get comprehensive metadata for a specific agent type.
458
- *
459
- * **Returns:**
460
- * - Agent name and description
461
- * - Version information
462
- * - Supported capabilities and modes
463
- * - Credit requirements
464
- * - Author and tags
465
- * - Configuration options
466
- *
467
- * Use this to understand agent capabilities before execution.
249
+ * Get Agent Metadata
468
250
  */
469
251
  export declare const getAgentMetadata: <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => import("./client").RequestResult<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError, "fields">;
470
252
  /**
471
- * Execute specific agent
472
- *
473
- * Execute a specific agent type directly with intelligent execution strategy.
474
- *
475
- * Available agents:
476
- * - **financial**: Financial analysis, SEC filings, accounting data
477
- * - **research**: Deep research and comprehensive analysis
478
- * - **rag**: Fast retrieval without AI (no credits required)
479
- *
480
- * **Execution Strategies (automatic):**
481
- * - Fast operations (<5s): Immediate synchronous response
482
- * - Medium operations (5-30s): SSE streaming with progress updates
483
- * - Long operations (>30s): Background queue with operation tracking
253
+ * Execute Specific Agent
484
254
  *
485
- * **Response Mode Override:**
486
- * Use query parameter `?mode=sync|async` to override automatic strategy selection.
487
- *
488
- * Use this endpoint when you know which agent you want to use.
255
+ * Available: `financial` (SEC filings, accounting), `research` (deep analysis), `rag` (retrieval, no credits). Execution strategy auto-selected; override with `?mode=sync|async`.
489
256
  */
490
257
  export declare const executeSpecificAgent: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificAgentData, ThrowOnError>) => import("./client").RequestResult<ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, ThrowOnError, "fields">;
491
258
  /**
492
- * Batch process multiple queries
493
- *
494
- * Process multiple queries either sequentially or in parallel.
495
- *
496
- * **Features:**
497
- * - Process up to 10 queries in a single request
498
- * - Sequential or parallel execution modes
499
- * - Automatic error handling per query
500
- * - Credit checking before execution
259
+ * Batch Process Queries
501
260
  *
502
- * **Use Cases:**
503
- * - Bulk analysis of multiple entities
504
- * - Comparative analysis across queries
505
- * - Automated report generation
506
- *
507
- * Returns individual results for each query with execution metrics.
261
+ * Process up to 10 queries sequentially or in parallel. Partial failure is supported — each result has individual error handling.
508
262
  */
509
263
  export declare const batchProcessQueries: <ThrowOnError extends boolean = false>(options: Options<BatchProcessQueriesData, ThrowOnError>) => import("./client").RequestResult<BatchProcessQueriesResponses, BatchProcessQueriesErrors, ThrowOnError, "fields">;
510
264
  /**
511
- * Get agent recommendations
512
- *
513
- * Get intelligent agent recommendations for a specific query.
265
+ * Get Agent Recommendations
514
266
  *
515
- * **How it works:**
516
- * 1. Analyzes query content and structure
517
- * 2. Evaluates agent capabilities
518
- * 3. Calculates confidence scores
519
- * 4. Returns ranked recommendations
520
- *
521
- * **Use this when:**
522
- * - Unsure which agent to use
523
- * - Need to understand agent suitability
524
- * - Want confidence scores for decision making
525
- *
526
- * Returns top agents ranked by confidence with explanations.
267
+ * Returns agents ranked by confidence score for a query, with explanations. Use before execution when unsure which agent to pick.
527
268
  */
528
269
  export declare const recommendAgent: <ThrowOnError extends boolean = false>(options: Options<RecommendAgentData, ThrowOnError>) => import("./client").RequestResult<RecommendAgentResponses, RecommendAgentErrors, ThrowOnError, "fields">;
529
270
  /**
530
271
  * List MCP Tools
531
272
  *
532
- * Get available Model Context Protocol tools for graph analysis.
533
- *
534
- * This endpoint returns a comprehensive list of MCP tools optimized for AI agents:
535
- * - Tool schemas with detailed parameter documentation
536
- * - Context-aware descriptions based on graph type
537
- * - Capability indicators for streaming and progress
538
- *
539
- * The tool list is customized based on:
540
- * - Graph type (shared repository vs user graph)
541
- * - User permissions and subscription tier
542
- * - Available graph capabilities for the selected graph
543
- *
544
- * **Subgraph Support:**
545
- * This endpoint accepts both parent graph IDs and subgraph IDs.
546
- * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
547
- * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
548
- * The returned tool list is identical for parent graphs and subgraphs, as all
549
- * MCP tools work uniformly across graph boundaries.
550
- *
551
- * **Note:**
552
- * MCP tool listing is included - no credit consumption required.
273
+ * Returns tool schemas with capability hints (streaming, caching, timeouts) per tool. Tool list is context-aware by graph type; identical for parent graphs and subgraphs.
553
274
  */
554
275
  export declare const listMcpTools: <ThrowOnError extends boolean = false>(options: Options<ListMcpToolsData, ThrowOnError>) => import("./client").RequestResult<ListMcpToolsResponses, ListMcpToolsErrors, ThrowOnError, "fields">;
555
276
  /**
556
277
  * Execute MCP Tool
557
278
  *
558
- * Execute an MCP tool with intelligent response optimization.
559
- *
560
- * This endpoint automatically selects the best execution strategy based on:
561
- * - Tool type and estimated complexity
562
- * - Client capabilities (AI agent detection)
563
- * - System load and queue status
564
- * - Graph type (shared repository vs user graph)
565
- *
566
- * **Response Formats:**
567
- * - **JSON**: Direct response for small/fast operations
568
- * - **SSE**: Server-Sent Events for progress monitoring
569
- * - **NDJSON**: Newline-delimited JSON for streaming
570
- * - **Queued**: Asynchronous execution with status monitoring
571
- *
572
- * **SSE Streaming Support:**
573
- * - Maximum 5 concurrent SSE connections per user
574
- * - Rate limited to 10 new connections per minute
575
- * - Automatic circuit breaker for Redis failures
576
- * - Graceful degradation to direct response if SSE unavailable
577
- * - Progress events for long-running operations
578
- *
579
- * **AI Agent Optimization:**
580
- * The Node.js MCP client transparently handles all response formats,
581
- * presenting a unified interface to AI agents. Streaming responses are
582
- * automatically aggregated for seamless consumption.
583
- *
584
- * **Error Handling:**
585
- * - `429 Too Many Requests`: Connection limit or rate limit exceeded
586
- * - `503 Service Unavailable`: SSE system temporarily disabled
587
- * - `408 Request Timeout`: Tool execution exceeded timeout
588
- * - Clients should implement exponential backoff on errors
589
- *
590
- * **Subgraph Support:**
591
- * This endpoint accepts both parent graph IDs and subgraph IDs.
592
- * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
593
- * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
594
- * MCP tools operate on the specified graph/subgraph independently. Each subgraph
595
- * has its own schema, data, and can be queried separately via MCP.
596
- *
597
- * **Credit Model:**
598
- * MCP tool execution is included - no credit consumption required. Database
599
- * operations (queries, schema inspection, analytics) are completely free.
600
- * Only AI operations that invoke Claude or other LLM APIs consume credits,
601
- * which happens at the AI agent layer, not the MCP tool layer.
279
+ * Strategy auto-selected by tool type and load: JSON for fast tools, SSE for long queries, NDJSON for large results. Database operations (Cypher, schema, info) consume no credits — only AI LLM calls cost credits.
602
280
  */
603
281
  export declare const callMcpTool: <ThrowOnError extends boolean = false>(options: Options<CallMcpToolData, ThrowOnError>) => import("./client").RequestResult<CallMcpToolResponses, CallMcpToolErrors, ThrowOnError, "fields">;
604
282
  /**
605
283
  * List graph database backups
606
- *
607
- * List all backups for the specified graph database
608
284
  */
609
285
  export declare const listBackups: <ThrowOnError extends boolean = false>(options: Options<ListBackupsData, ThrowOnError>) => import("./client").RequestResult<ListBackupsResponses, ListBackupsErrors, ThrowOnError, "fields">;
610
286
  /**
@@ -615,648 +291,148 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
615
291
  export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError, "fields">;
616
292
  /**
617
293
  * Get backup statistics
618
- *
619
- * Get comprehensive backup statistics for the specified graph database
620
294
  */
621
295
  export declare const getBackupStats: <ThrowOnError extends boolean = false>(options: Options<GetBackupStatsData, ThrowOnError>) => import("./client").RequestResult<GetBackupStatsResponses, GetBackupStatsErrors, ThrowOnError, "fields">;
622
296
  /**
623
297
  * Get Graph Metrics
624
- *
625
- * Get comprehensive metrics for the graph database.
626
- *
627
- * Provides detailed analytics including:
628
- * - **Node Statistics**: Counts by type (Entity, Report, Account, Transaction)
629
- * - **Relationship Metrics**: Connection counts and patterns
630
- * - **Data Quality**: Completeness scores and validation results
631
- * - **Performance Metrics**: Query response times and database health
632
- * - **Storage Analytics**: Database size and growth trends
633
- *
634
- * This data helps with:
635
- * - Monitoring data completeness
636
- * - Identifying data quality issues
637
- * - Capacity planning
638
- * - Performance optimization
639
- *
640
- * Note:
641
- * This operation is included - no credit consumption required.
642
298
  */
643
299
  export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => import("./client").RequestResult<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError, "fields">;
644
300
  /**
645
301
  * Get Graph Usage Analytics
646
302
  *
647
- * Get comprehensive usage analytics tracked by the GraphUsage model.
648
- *
649
- * Provides temporal usage patterns including:
650
- * - **Storage Analytics**: GB-hours for billing, breakdown by type (files, tables, graphs, subgraphs)
651
- * - **Credit Analytics**: Consumption patterns, operation breakdown, cached vs billable
652
- * - **Performance Insights**: Operation stats, slow queries, performance scoring
653
- * - **Recent Events**: Latest usage events with full details
654
- *
655
- * Time ranges available:
656
- * - `24h` - Last 24 hours (hourly breakdown)
657
- * - `7d` - Last 7 days (daily breakdown)
658
- * - `30d` - Last 30 days (daily breakdown)
659
- * - `current_month` - Current billing month
660
- * - `last_month` - Previous billing month
661
- *
662
- * Include options:
663
- * - `storage` - Storage usage summary (GB-hours, averages, peaks)
664
- * - `credits` - Credit consumption analytics
665
- * - `performance` - Performance insights and optimization opportunities
666
- * - `events` - Recent usage events (last 50)
667
- *
668
- * Useful for:
669
- * - Billing and cost analysis
670
- * - Capacity planning
671
- * - Performance optimization
672
- * - Usage trend analysis
673
- *
674
- * Note:
675
- * This operation is included - no credit consumption required.
303
+ * Time ranges: 24h, 7d, 30d, current_month, last_month. Toggle storage, credits, performance, and events sections via query params.
676
304
  */
677
305
  export declare const getGraphUsageAnalytics: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageAnalyticsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ThrowOnError, "fields">;
678
306
  /**
679
307
  * Execute Cypher Query
680
308
  *
681
- * Execute a Cypher query with intelligent response optimization.
682
- *
683
- * **IMPORTANT: Write operations depend on graph type:**
684
- * - **Main Graphs**: READ-ONLY. Write operations (CREATE, MERGE, SET, DELETE) are not allowed.
685
- * - **Subgraphs**: WRITE-ENABLED. Full Cypher write operations are supported for development and report creation.
686
- *
687
- * To load data into main graphs, use the staging pipeline:
688
- * 1. Create file upload: `POST /v1/graphs/{graph_id}/tables/{table_name}/files`
689
- * 2. Ingest to graph: `POST /v1/graphs/{graph_id}/tables/ingest`
690
- *
691
- * **Security Best Practice - Use Parameterized Queries:**
692
- * ALWAYS use query parameters instead of string interpolation to prevent injection attacks:
693
- * - ✅ SAFE: `MATCH (n:Entity {type: $entity_type}) RETURN n` with `parameters: {"entity_type": "Company"}`
694
- * - ❌ UNSAFE: `MATCH (n:Entity {type: "Company"}) RETURN n` with user input concatenated into query string
695
- *
696
- * Query parameters provide automatic escaping and type safety. All examples in this API use parameterized queries.
697
- *
698
- * This endpoint automatically selects the best execution strategy based on:
699
- * - Query characteristics (size, complexity)
700
- * - Client capabilities (SSE, NDJSON, JSON)
701
- * - System load (queue status, concurrent queries)
702
- * - User preferences (mode parameter, headers)
703
- *
704
- * **Response Modes:**
705
- * - `auto` (default): Intelligent automatic selection
706
- * - `sync`: Force synchronous JSON response (best for testing)
707
- * - `async`: Force queued response with SSE monitoring endpoints (no polling needed)
708
- * - `stream`: Force streaming response (SSE or NDJSON)
709
- *
710
- * **Client Detection:**
711
- * - Automatically detects testing tools (Postman, Swagger UI)
712
- * - Adjusts behavior for better interactive experience
713
- * - Respects Accept and Prefer headers for capabilities
714
- *
715
- * **Streaming Support (SSE):**
716
- * - Real-time events with progress updates
717
- * - Maximum 5 concurrent SSE connections per user
718
- * - Rate limited to 10 new connections per minute
719
- * - Automatic circuit breaker for Redis failures
720
- * - Graceful degradation if event system unavailable
721
- * - 30-second keepalive to prevent timeouts
722
- *
723
- * **Streaming Support (NDJSON):**
724
- * - Efficient line-delimited JSON for large results
725
- * - Automatic chunking (configurable 10-10000 rows)
726
- * - No connection limits (stateless streaming)
727
- *
728
- * **Queue Management:**
729
- * - Automatic queuing under high load
730
- * - Real-time monitoring via SSE events (no polling needed)
731
- * - Priority based on subscription tier
732
- * - Queue position and progress updates pushed via SSE
733
- * - Connect to returned `/v1/operations/{id}/stream` endpoint for updates
734
- *
735
- * **Error Handling:**
736
- * - `429 Too Many Requests`: Rate limit or connection limit exceeded
737
- * - `503 Service Unavailable`: Circuit breaker open or SSE disabled
738
- * - Clients should implement exponential backoff
739
- *
740
- * **Subgraph Support:**
741
- * This endpoint accepts both parent graph IDs and subgraph IDs.
742
- * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
743
- * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
744
- * Subgraphs share the same instance as their parent graph and have independent data.
745
- *
746
- * **Note:**
747
- * Query operations are included - no credit consumption required.
748
- * Queue position is based on subscription tier for priority.
309
+ * Main graphs are **read-only** use the staging pipeline to ingest data. Subgraphs support full writes. Always use parameterized queries (`parameters: {"key": "val"}`) to prevent injection. Response modes: `auto` (default), `sync`, `async`, `stream`. Under load, queries are queued and emit an `operation_id` for SSE monitoring at `/v1/operations/{id}/stream`.
749
310
  */
750
311
  export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherQueryData, ThrowOnError>) => import("./client").RequestResult<ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, ThrowOnError, "fields">;
751
312
  /**
752
313
  * Get Runtime Graph Schema
753
314
  *
754
- * Get runtime schema information for the specified graph database.
755
- *
756
- * ## What This Returns
757
- *
758
- * This endpoint inspects the **actual current state** of the graph database and returns:
759
- * - **Node Labels**: All node types currently in the database
760
- * - **Relationship Types**: All relationship types currently in the database
761
- * - **Node Properties**: Properties discovered from actual data (up to 10 properties per node type)
762
- *
763
- * ## Runtime vs Declared Schema
764
- *
765
- * **Use this endpoint** (`/schema`) when you need to know:
766
- * - What data is ACTUALLY in the database right now
767
- * - What properties exist on real nodes
768
- * - What relationships have been created
769
- * - Current database structure for querying
770
- *
771
- * **Use `/schema/export` instead** when you need:
772
- * - The original schema definition used to create the graph
773
- * - Schema in a specific format (JSON, YAML, Cypher DDL)
774
- * - Schema for documentation or version control
775
- * - Schema to replicate in another graph
776
- *
777
- * ## Example Use Cases
778
- *
779
- * - **Building queries**: See what node labels and properties exist to write accurate Cypher
780
- * - **Data exploration**: Discover what's in an unfamiliar graph
781
- * - **Schema drift detection**: Compare runtime vs declared schema
782
- * - **API integration**: Dynamically adapt to current graph structure
783
- *
784
- * ## Performance Note
785
- *
786
- * Property discovery is limited to 10 properties per node type for performance.
787
- * For complete schema definitions, use `/schema/export`.
788
- *
789
- * ## Subgraph Support
790
- *
791
- * This endpoint accepts both parent graph IDs and subgraph IDs.
792
- * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
793
- * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
794
- * Each subgraph has independent schema and data. The returned schema reflects
795
- * only the specified graph/subgraph's actual structure.
796
- *
797
- * This operation is included - no credit consumption required.
315
+ * Runtime schema from actual graph data — node labels, relationship types, and up to 10 sample properties per node type. For the original schema definition or structured export formats, use `/schema/export`.
798
316
  */
799
317
  export declare const getGraphSchema: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaResponses, GetGraphSchemaErrors, ThrowOnError, "fields">;
800
318
  /**
801
319
  * Export Declared Graph Schema
802
320
  *
803
- * Export the declared schema definition of an existing graph.
804
- *
805
- * ## What This Returns
806
- *
807
- * This endpoint returns the **original schema definition** that was used to create the graph:
808
- * - The schema as it was **declared** during graph creation
809
- * - Complete node and relationship definitions
810
- * - Property types and constraints
811
- * - Schema metadata (name, version, type)
812
- *
813
- * ## Runtime vs Declared Schema
814
- *
815
- * **Use this endpoint** (`/schema/export`) when you need:
816
- * - The original schema definition used to create the graph
817
- * - Schema in a specific format (JSON, YAML, Cypher DDL)
818
- * - Schema for documentation or version control
819
- * - Schema to replicate in another graph
820
- *
821
- * **Use `/schema` instead** when you need:
822
- * - What data is ACTUALLY in the database right now
823
- * - What properties exist on real nodes (discovered from data)
824
- * - Current runtime database structure for querying
825
- *
826
- * ## Export Formats
827
- *
828
- * ### JSON Format (`format=json`)
829
- * Returns structured JSON with nodes, relationships, and properties.
830
- * Best for programmatic access and API integration.
831
- *
832
- * ### YAML Format (`format=yaml`)
833
- * Returns human-readable YAML with comments.
834
- * Best for documentation and configuration management.
835
- *
836
- * ### Cypher DDL Format (`format=cypher`)
837
- * Returns Cypher CREATE statements for recreating the schema.
838
- * Best for database migration and replication.
839
- *
840
- * ## Data Statistics
841
- *
842
- * Set `include_data_stats=true` to include:
843
- * - Node counts by label
844
- * - Relationship counts by type
845
- * - Total nodes and relationships
846
- *
847
- * This combines declared schema with runtime statistics.
848
- *
849
- * This operation is included - no credit consumption required.
321
+ * Returns the original schema definition from graph creation, not the runtime state. Set `include_data_stats=true` to add live node/relationship counts. Use `/schema` to inspect what's actually in the database.
850
322
  */
851
323
  export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(options: Options<ExportGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<ExportGraphSchemaResponses, ExportGraphSchemaErrors, ThrowOnError, "fields">;
852
324
  /**
853
325
  * Validate Schema
854
326
  *
855
- * Validate a custom schema definition before deployment.
856
- *
857
- * This endpoint performs comprehensive validation including:
858
- * - **Structure Validation**: Ensures proper JSON/YAML format
859
- * - **Type Checking**: Validates data types (STRING, INT, DOUBLE, etc.)
860
- * - **Constraint Verification**: Checks primary keys and unique constraints
861
- * - **Relationship Integrity**: Validates node references in relationships
862
- * - **Naming Conventions**: Ensures valid identifiers
863
- * - **Compatibility**: Checks against existing extensions if specified
864
- *
865
- * Supported formats:
866
- * - JSON schema definitions
867
- * - YAML schema definitions
868
- * - Direct dictionary format
869
- *
870
- * Validation helps prevent:
871
- * - Schema deployment failures
872
- * - Data integrity issues
873
- * - Performance problems
874
- * - Naming conflicts
875
- *
876
- * **Subgraph Support:**
877
- * This endpoint accepts both parent graph IDs and subgraph IDs.
878
- * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
879
- * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
880
- * Schema validation is performed against the specified graph/subgraph's current
881
- * schema and data structure.
882
- *
883
- * This operation is included - no credit consumption required.
327
+ * Validates a custom schema definition before deployment — checks structure, types, constraints, and relationship references. Returns errors and warnings without applying changes. Supports JSON, YAML, and dict formats.
884
328
  */
885
329
  export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
886
330
  /**
887
331
  * Get Credit Summary
888
- *
889
- * Retrieve comprehensive credit usage summary for the specified graph.
890
- *
891
- * This endpoint provides:
892
- * - Current credit balance and monthly allocation
893
- * - Credit consumption metrics for the current month
894
- * - Graph tier and credit multiplier information
895
- * - Usage percentage to help monitor credit consumption
896
- *
897
- * No credits are consumed for checking credit status.
898
332
  */
899
333
  export declare const getCreditSummary: <ThrowOnError extends boolean = false>(options: Options<GetCreditSummaryData, ThrowOnError>) => import("./client").RequestResult<GetCreditSummaryResponses, GetCreditSummaryErrors, ThrowOnError, "fields">;
900
334
  /**
901
335
  * List Credit Transactions
902
- *
903
- * Retrieve detailed credit transaction history for the specified graph.
904
- *
905
- * This enhanced endpoint provides:
906
- * - Detailed transaction records with idempotency information
907
- * - Summary by operation type to identify high-consumption operations
908
- * - Date range filtering for analysis
909
- * - Metadata search capabilities
910
- *
911
- * Transaction types include:
912
- * - ALLOCATION: Monthly credit allocations
913
- * - CONSUMPTION: Credit usage for operations
914
- * - BONUS: Bonus credits added by admins
915
- * - REFUND: Credit refunds
916
- *
917
- * No credits are consumed for viewing transaction history.
918
336
  */
919
337
  export declare const listCreditTransactions: <ThrowOnError extends boolean = false>(options: Options<ListCreditTransactionsData, ThrowOnError>) => import("./client").RequestResult<ListCreditTransactionsResponses, ListCreditTransactionsErrors, ThrowOnError, "fields">;
920
338
  /**
921
339
  * Database Health Check
922
- *
923
- * Get comprehensive health information for the graph database.
924
- *
925
- * Returns detailed health metrics including:
926
- * - **Connection Status**: Database connectivity and responsiveness
927
- * - **Performance Metrics**: Query execution times and throughput
928
- * - **Resource Usage**: Memory and storage utilization
929
- * - **Error Monitoring**: Recent error rates and patterns
930
- * - **Uptime Statistics**: Service availability metrics
931
- *
932
- * Health indicators:
933
- * - **Status**: healthy, degraded, or unhealthy
934
- * - **Query Performance**: Average execution times
935
- * - **Error Rates**: Recent failure percentages
936
- * - **Resource Usage**: Memory and storage consumption
937
- * - **Alerts**: Active warnings or issues
938
- *
939
- * **Subgraph Support:**
940
- * This endpoint accepts both parent graph IDs and subgraph IDs.
941
- * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
942
- * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
943
- * Health metrics are specific to the requested graph/subgraph. Subgraphs share the
944
- * same physical instance as their parent but have independent health indicators.
945
- *
946
- * This endpoint provides essential monitoring data for operational visibility.
947
340
  */
948
341
  export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseHealthResponses, GetDatabaseHealthErrors, ThrowOnError, "fields">;
949
342
  /**
950
343
  * Database Information
951
- *
952
- * Get comprehensive database information and statistics.
953
- *
954
- * Returns detailed database metrics including:
955
- * - **Database Metadata**: Name, path, size, and timestamps
956
- * - **Schema Information**: Node labels, relationship types, and counts
957
- * - **Storage Statistics**: Database size and usage metrics
958
- * - **Data Composition**: Node and relationship counts
959
- * - **Backup Information**: Available backups and last backup date
960
- * - **Configuration**: Read-only status and schema version
961
- *
962
- * Database statistics:
963
- * - **Size**: Storage usage in bytes and MB
964
- * - **Content**: Node and relationship counts
965
- * - **Schema**: Available labels and relationship types
966
- * - **Backup Status**: Backup availability and recency
967
- * - **Timestamps**: Creation and modification dates
968
- *
969
- * **Subgraph Support:**
970
- * This endpoint accepts both parent graph IDs and subgraph IDs.
971
- * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
972
- * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
973
- * Returned metrics are specific to the requested graph/subgraph. Subgraphs have
974
- * independent size, node/relationship counts, and backup status.
975
- *
976
- * This endpoint provides essential database information for capacity planning and monitoring.
977
344
  */
978
345
  export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError, "fields">;
979
346
  /**
980
347
  * Get Graph Operational Limits
981
348
  *
982
- * Get comprehensive operational limits for the graph database.
983
- *
984
- * Returns all operational limits that apply to this graph including:
985
- * - **Storage Limits**: Maximum storage size and current usage
986
- * - **Query Limits**: Timeouts, complexity, row limits
987
- * - **Copy/Ingestion Limits**: File sizes, timeouts, concurrent operations
988
- * - **Backup Limits**: Frequency, retention, size limits
989
- * - **Rate Limits**: Requests per minute/hour based on tier
990
- * - **Credit Limits**: AI operation credits (if applicable)
991
- * - **Content Limits**: Per-operation materialization limits (if applicable)
992
- * - **Instance Usage**: Aggregate storage across parent + subgraphs (user graphs only)
993
- *
994
- * **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
349
+ * Limits vary by subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge). Includes storage, query, backup, rate, credit, and instance usage limits.
995
350
  */
996
351
  export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => import("./client").RequestResult<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError, "fields">;
997
352
  /**
998
353
  * List Subgraphs
999
- *
1000
- * List all subgraphs for a parent graph.
1001
- *
1002
- * **Requirements:**
1003
- * - Valid authentication
1004
- * - Parent graph must exist and be accessible to the user
1005
- * - User must have at least 'read' permission on the parent graph
1006
- *
1007
- * **Returns:**
1008
- * - List of all subgraphs for the parent graph
1009
- * - Each subgraph includes its ID, name, description, type, status, and creation date
1010
354
  */
1011
355
  export declare const listSubgraphs: <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => import("./client").RequestResult<ListSubgraphsResponses, ListSubgraphsErrors, ThrowOnError, "fields">;
1012
356
  /**
1013
357
  * Get Subgraph Details
1014
358
  *
1015
- * Get detailed information about a specific subgraph.
1016
- *
1017
- * **Requirements:**
1018
- * - User must have read access to parent graph
1019
- * - Subgraph name must be alphanumeric (1-20 characters)
1020
- *
1021
- * **Response includes:**
1022
- * - Full subgraph metadata
1023
- * - Database statistics (nodes, edges)
1024
- * - Size information
1025
- * - Schema configuration
1026
- * - Creation/modification timestamps
1027
- * - Last access time (when available)
1028
- *
1029
- * **Statistics:**
1030
- * Real-time statistics queried from LadybugDB:
1031
- * - Node count
1032
- * - Edge count
1033
- * - Database size on disk
1034
- * - Schema information
1035
- *
1036
- * **Note:**
1037
- * Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
1038
- * The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
359
+ * Pass the subgraph name (e.g., `dev`) not the full subgraph ID (e.g., `kg0123_dev`).
1039
360
  */
1040
361
  export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError, "fields">;
1041
362
  /**
1042
363
  * Get Subgraph Quota
1043
364
  *
1044
- * Get subgraph quota and usage information for a parent graph.
1045
- *
1046
- * **Shows:**
1047
- * - Current subgraph count
1048
- * - Maximum allowed subgraphs per tier
1049
- * - Remaining capacity
1050
- * - Total size usage across all subgraphs
1051
- *
1052
- * **Tier Limits:**
1053
- * - Standard: Up to 3 subgraphs (dedicated m7g.large instance)
1054
- * - Large: Up to 10 subgraphs (dedicated r7g.large instance)
1055
- * - XLarge: Up to 25 subgraphs (dedicated r7g.xlarge instance)
1056
- * - Limits are defined in graph.yml deployment configuration
1057
- *
1058
- * **Size Tracking:**
1059
- * Provides aggregate size metrics when available.
1060
- * Individual subgraph sizes shown in list endpoint.
365
+ * Tier capacity: Standard 3, Large 10, XLarge 25 subgraphs. Use the list endpoint for per-subgraph sizes.
1061
366
  */
1062
367
  export declare const getSubgraphQuota: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError, "fields">;
1063
368
  /**
1064
- * Get Graph and Shared Repository Subscription
1065
- *
1066
- * Get subscription details for a graph or shared repository.
1067
- *
1068
- * For user graphs (kg*): Returns the graph's subscription (owned by graph creator)
1069
- * For shared repositories (sec, industry, etc.): Returns user's personal subscription to that repository
369
+ * Get Graph Subscription
1070
370
  *
1071
- * This unified endpoint automatically detects the resource type and returns the appropriate subscription.
371
+ * Detects resource type automatically: user graphs (kg*) return the graph's subscription; shared repositories return the user's personal subscription to that repo.
1072
372
  */
1073
373
  export declare const getGraphSubscription: <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionData, ThrowOnError>) => import("./client").RequestResult<GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, ThrowOnError, "fields">;
1074
374
  /**
1075
375
  * Change Subscription Plan
1076
376
  *
1077
- * Change the plan on an existing subscription.
1078
- *
1079
- * **For shared repositories** (sec, industry, etc.): Changes access tier (e.g., starter -> advanced).
1080
- * Synchronous — takes effect immediately.
1081
- *
1082
- * **For user graphs** (kg*): Changes infrastructure tier (e.g., ladybug-standard -> ladybug-large).
1083
- * Asynchronous — returns an `operation_id` for tracking the EBS volume migration via SSE.
1084
- *
1085
- * Stripe handles proration automatically for both types.
1086
- *
1087
- * **Requirements:**
1088
- * - User must be an OWNER of their organization
1089
- * - Subscription must be active
1090
- * - New plan must be valid for the resource type
1091
- *
1092
- * **Downgrade restrictions (graphs only):**
1093
- * - Subgraph count must fit the target tier's limit
1094
- * - Storage usage must fit the target tier's limit
377
+ * For repositories: synchronous tier change. For user graphs: use `POST /v1/graphs/{graph_id}/operations/change-tier` instead — this endpoint rejects graph tier changes. Requires org owner role.
1095
378
  */
1096
379
  export declare const changeSubscriptionPlan: <ThrowOnError extends boolean = false>(options: Options<ChangeSubscriptionPlanData, ThrowOnError>) => import("./client").RequestResult<ChangeSubscriptionPlanResponses, ChangeSubscriptionPlanErrors, ThrowOnError, "fields">;
1097
380
  /**
1098
381
  * Create Repository Subscription
1099
382
  *
1100
- * Create a new subscription to a shared repository.
1101
- *
1102
- * This endpoint is ONLY for shared repositories (sec, industry, economic).
1103
- * User graph subscriptions are created automatically when the graph is provisioned.
1104
- *
1105
- * The subscription will be created in ACTIVE status immediately and credits will be allocated.
383
+ * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning.
1106
384
  */
1107
385
  export declare const createRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError, "fields">;
1108
386
  /**
1109
387
  * List Staging Tables
1110
388
  *
1111
- * List all DuckDB staging tables with comprehensive metrics and status.
1112
- *
1113
- * Get a complete inventory of all staging tables for a graph, including
1114
- * file counts, storage sizes, and row estimates. Essential for monitoring
1115
- * the data pipeline and determining which tables are ready for ingestion.
1116
- *
1117
- * **Returned Metrics:**
1118
- * - Table name and type (node/relationship)
1119
- * - File count per table
1120
- * - Total storage size in bytes
1121
- * - Estimated row count
1122
- * - S3 location pattern
1123
- * - Ready-for-ingestion status
1124
- *
1125
- * **Use Cases:**
1126
- * - Monitor data upload progress
1127
- * - Check which tables have files ready
1128
- * - Track storage consumption
1129
- * - Validate pipeline before ingestion
1130
- * - Capacity planning
1131
- *
1132
- * **Workflow:**
1133
- * 1. List tables to see current state
1134
- * 2. Upload files to empty tables
1135
- * 3. Re-list to verify uploads
1136
- * 4. Check file counts and sizes
1137
- * 5. Ingest when ready
1138
- *
1139
- * **Important Notes:**
1140
- * - Tables with `file_count > 0` have data ready
1141
- * - Check `total_size_bytes` for storage monitoring
1142
- * - Use `s3_location` to verify upload paths
1143
- * - Empty tables (file_count=0) are skipped during ingestion
1144
- * - Table queries are included - no credit consumption
389
+ * Returns file count, storage size, row count, and S3 location per table. Tables with `file_count=0` are skipped during ingestion.
1145
390
  */
1146
391
  export declare const listTables: <ThrowOnError extends boolean = false>(options: Options<ListTablesData, ThrowOnError>) => import("./client").RequestResult<ListTablesResponses, ListTablesErrors, ThrowOnError, "fields">;
1147
392
  /**
1148
393
  * Query Staging Tables with SQL
1149
394
  *
1150
- * Execute SQL queries on DuckDB staging tables for data inspection and validation.
1151
- *
1152
- * Query raw staging data directly with SQL before ingestion into the graph database.
1153
- * Useful for data quality checks, validation, and exploratory analysis.
1154
- *
1155
- * **Security Best Practice - Use Parameterized Queries:**
1156
- * ALWAYS use query parameters instead of string concatenation to prevent SQL injection:
1157
- * - ✅ SAFE: `SELECT * FROM Entity WHERE type = ? LIMIT ?` with `parameters: ["Company", 100]`
1158
- * - ❌ UNSAFE: `SELECT * FROM Entity WHERE type = 'Company' LIMIT 100` with user input concatenated into SQL string
1159
- *
1160
- * Query parameters provide automatic escaping and type safety. Use `?` placeholders with parameters array.
1161
- *
1162
- * **Use Cases:**
1163
- * - Validate data quality before graph ingestion
1164
- * - Inspect row-level data for debugging
1165
- * - Run analytics on staging tables
1166
- * - Check for duplicates, nulls, or data issues
1167
- * - Preview data transformations
1168
- *
1169
- * **Workflow:**
1170
- * 1. Upload data files via `POST /tables/{table_name}/files`
1171
- * 2. Query staging tables to validate: `POST /tables/query`
1172
- * 3. Fix any data issues by re-uploading
1173
- * 4. Ingest validated data: `POST /tables/ingest`
1174
- *
1175
- * **Supported SQL:**
1176
- * - Full DuckDB SQL syntax
1177
- * - SELECT, JOIN, WHERE, GROUP BY, ORDER BY
1178
- * - Aggregations, window functions, CTEs
1179
- * - Multiple table joins across staging area
1180
- *
1181
- * **Common Operations:**
1182
- * - Count rows: `SELECT COUNT(*) FROM Entity`
1183
- * - Filter by type: `SELECT * FROM Entity WHERE entity_type = ? LIMIT ?` with `parameters: ["Company", 100]`
1184
- * - Check for nulls: `SELECT * FROM Entity WHERE name IS NULL LIMIT 10`
1185
- * - Find duplicates: `SELECT identifier, COUNT(*) as cnt FROM Entity GROUP BY identifier HAVING COUNT(*) > 1`
1186
- * - Filter amounts: `SELECT * FROM Transaction WHERE amount > ? AND date >= ?` with `parameters: [1000, "2024-01-01"]`
1187
- *
1188
- * **Limits:**
1189
- * - Query timeout: 30 seconds
1190
- * - Result limit: 10,000 rows (use LIMIT clause)
1191
- * - Read-only: No INSERT, UPDATE, DELETE
1192
- * - User's tables only: Cannot query other users' data
1193
- *
1194
- * **Subgraph Support:**
1195
- * This endpoint accepts both parent graph IDs and subgraph IDs.
1196
- * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1197
- * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1198
- * Each subgraph has its own independent staging tables.
1199
- *
1200
- * **Shared Repositories:**
1201
- * Shared repositories (SEC, etc.) do not allow direct SQL queries.
1202
- * Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
1203
- *
1204
- * **Note:**
1205
- * Staging table queries are included - no credit consumption
395
+ * Execute SQL against DuckDB staging tables for pre-ingestion validation. Use `?` placeholders with the `parameters` array to prevent injection. Read-only (SELECT only), 30s timeout, 10K row limit. Not allowed on shared repositories.
1206
396
  */
1207
397
  export declare const queryTables: <ThrowOnError extends boolean = false>(options: Options<QueryTablesData, ThrowOnError>) => import("./client").RequestResult<QueryTablesResponses, QueryTablesErrors, ThrowOnError, "fields">;
1208
398
  /**
1209
- * Search Documents
399
+ * Search Graph Documents
1210
400
  *
1211
- * Search filing narratives and text content within a graph.
401
+ * Shared repositories require a subscription; subscription plan determines search rate limits.
1212
402
  */
1213
403
  export declare const searchDocuments: <ThrowOnError extends boolean = false>(options: Options<SearchDocumentsData, ThrowOnError>) => import("./client").RequestResult<SearchDocumentsResponses, SearchDocumentsErrors, ThrowOnError, "fields">;
1214
404
  /**
1215
405
  * Get Document Section
1216
- *
1217
- * Retrieve the full text of a document section by ID.
1218
406
  */
1219
407
  export declare const getDocumentSection: <ThrowOnError extends boolean = false>(options: Options<GetDocumentSectionData, ThrowOnError>) => import("./client").RequestResult<GetDocumentSectionResponses, GetDocumentSectionErrors, ThrowOnError, "fields">;
1220
408
  /**
1221
409
  * List Documents
1222
- *
1223
- * List documents for a graph from PostgreSQL.
1224
410
  */
1225
411
  export declare const listDocuments: <ThrowOnError extends boolean = false>(options: Options<ListDocumentsData, ThrowOnError>) => import("./client").RequestResult<ListDocumentsResponses, ListDocumentsErrors, ThrowOnError, "fields">;
1226
412
  /**
1227
413
  * Upload Document
1228
414
  *
1229
- * Upload a markdown document. Stored in PostgreSQL, synced to OpenSearch.
415
+ * Stored in PostgreSQL, synced to OpenSearch for search. Not allowed on shared repositories.
1230
416
  */
1231
417
  export declare const uploadDocument: <ThrowOnError extends boolean = false>(options: Options<UploadDocumentData, ThrowOnError>) => import("./client").RequestResult<UploadDocumentResponses, UploadDocumentErrors, ThrowOnError, "fields">;
1232
418
  /**
1233
419
  * Delete Document
1234
- *
1235
- * Delete a document from PostgreSQL and OpenSearch.
1236
420
  */
1237
421
  export declare const deleteDocument: <ThrowOnError extends boolean = false>(options: Options<DeleteDocumentData, ThrowOnError>) => import("./client").RequestResult<DeleteDocumentResponses, DeleteDocumentErrors, ThrowOnError, "fields">;
1238
422
  /**
1239
423
  * Get Document
1240
- *
1241
- * Get a document with full content from PostgreSQL.
1242
424
  */
1243
425
  export declare const getDocument: <ThrowOnError extends boolean = false>(options: Options<GetDocumentData, ThrowOnError>) => import("./client").RequestResult<GetDocumentResponses, GetDocumentErrors, ThrowOnError, "fields">;
1244
426
  /**
1245
427
  * Update Document
1246
428
  *
1247
- * Update a document's content and/or metadata. Re-syncs to OpenSearch.
429
+ * Updates content and/or metadata. Re-syncs to OpenSearch.
1248
430
  */
1249
431
  export declare const updateDocument: <ThrowOnError extends boolean = false>(options: Options<UpdateDocumentData, ThrowOnError>) => import("./client").RequestResult<UpdateDocumentResponses, UpdateDocumentErrors, ThrowOnError, "fields">;
1250
- /**
1251
- * Upload Documents Bulk
1252
- *
1253
- * Upload multiple markdown documents (max 50).
1254
- */
1255
- export declare const uploadDocumentsBulk: <ThrowOnError extends boolean = false>(options: Options<UploadDocumentsBulkData, ThrowOnError>) => import("./client").RequestResult<UploadDocumentsBulkResponses, UploadDocumentsBulkErrors, ThrowOnError, "fields">;
1256
432
  /**
1257
433
  * Create Subgraph
1258
434
  *
1259
- * Create a new subgraph, optionally forking parent data.
435
+ * Set `fork_parent=true` to clone parent graph data into the new subgraph (async, returns a pending `OperationEnvelope`). Without `fork_parent`, creates an empty subgraph synchronously.
1260
436
  *
1261
437
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1262
438
  */
@@ -1264,7 +440,7 @@ export declare const opCreateSubgraph: <ThrowOnError extends boolean = false>(op
1264
440
  /**
1265
441
  * Delete Subgraph
1266
442
  *
1267
- * Delete a subgraph database.
443
+ * Set `backup_first=true` to create a safety backup before deletion. Requires admin role on the parent graph.
1268
444
  *
1269
445
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1270
446
  */
@@ -1272,7 +448,7 @@ export declare const opDeleteSubgraph: <ThrowOnError extends boolean = false>(op
1272
448
  /**
1273
449
  * Create Backup
1274
450
  *
1275
- * Create a backup of the graph database (async).
451
+ * Not allowed on shared repositories. Only `full_dump` format supported. Retention capped at tier maximum. Monitor progress via SSE at `/v1/operations/{operation_id}/stream`.
1276
452
  *
1277
453
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1278
454
  */
@@ -1280,10 +456,7 @@ export declare const opCreateBackup: <ThrowOnError extends boolean = false>(opti
1280
456
  /**
1281
457
  * Restore Backup
1282
458
  *
1283
- * Restore a graph database from an encrypted backup.
1284
- *
1285
- * Blocked for entity graphs — OLTP is the source of truth, use
1286
- * the materialize operation instead.
459
+ * Only encrypted backups can be restored. Not allowed on entity graphs (use `materialize` instead) or shared repositories.
1287
460
  *
1288
461
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1289
462
  */
@@ -1291,7 +464,7 @@ export declare const opRestoreBackup: <ThrowOnError extends boolean = false>(opt
1291
464
  /**
1292
465
  * Change Tier
1293
466
  *
1294
- * Change the infrastructure tier on a graph (async EBS migration).
467
+ * Async EBS migration (3-5 min). Valid tiers: `ladybug-standard`, `ladybug-large`, `ladybug-xlarge`.
1295
468
  *
1296
469
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1297
470
  */
@@ -1299,7 +472,7 @@ export declare const opChangeTier: <ThrowOnError extends boolean = false>(option
1299
472
  /**
1300
473
  * Materialize Graph
1301
474
  *
1302
- * Materialize graph from staging tables or extensions OLTP.
475
+ * Rebuilds LadybugDB from staging tables (file uploads) or extensions OLTP data. Set `dry_run=true` to preview without changes.
1303
476
  *
1304
477
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1305
478
  */
@@ -1307,651 +480,133 @@ export declare const opMaterialize: <ThrowOnError extends boolean = false>(optio
1307
480
  /**
1308
481
  * List Files in Graph
1309
482
  *
1310
- * List all files in the graph with optional filtering.
1311
- *
1312
- * Get a complete inventory of files across all tables or filtered by table name,
1313
- * status, or other criteria. Files are first-class resources with independent lifecycle.
1314
- *
1315
- * **Query Parameters:**
1316
- * - `table_name` (optional): Filter by table name
1317
- * - `status` (optional): Filter by upload status (uploaded, pending, failed, etc.)
1318
- *
1319
- * **Use Cases:**
1320
- * - Monitor file upload progress across all tables
1321
- * - Verify files are ready for ingestion
1322
- * - Check file metadata and sizes
1323
- * - Track storage usage per graph
1324
- * - Identify failed or incomplete uploads
1325
- * - Audit file provenance
1326
- *
1327
- * **Returned Metadata:**
1328
- * - File ID, name, and format (parquet, csv, json)
1329
- * - Size in bytes and row count (if available)
1330
- * - Upload status and timestamps
1331
- * - DuckDB and graph ingestion status
1332
- * - Table association
1333
- *
1334
- * **File Lifecycle Tracking:**
1335
- * Multi-layer status across S3 → DuckDB → Graph pipeline
1336
- *
1337
- * **Important Notes:**
1338
- * - Files are graph-scoped, not table-scoped
1339
- * - Use table_name parameter to filter by table
1340
- * - File listing is included - no credit consumption
483
+ * Filter by `table_name` or upload `status`. Files are graph-scoped resources with S3 → DuckDB → Graph lifecycle tracking.
1341
484
  */
1342
485
  export declare const listFiles: <ThrowOnError extends boolean = false>(options: Options<ListFilesData, ThrowOnError>) => import("./client").RequestResult<ListFilesResponses, ListFilesErrors, ThrowOnError, "fields">;
1343
486
  /**
1344
487
  * Create File Upload
1345
488
  *
1346
- * Generate presigned S3 URL for file upload.
1347
- *
1348
- * Initiate file upload by generating a secure, time-limited presigned S3 URL.
1349
- * Files are first-class resources uploaded directly to S3.
1350
- *
1351
- * **Request Body:**
1352
- * - `file_name`: Name of the file (1-255 characters)
1353
- * - `file_format`: Format (parquet, csv, json)
1354
- * - `table_name`: Table to associate file with
1355
- *
1356
- * **Upload Workflow:**
1357
- * 1. Call this endpoint to get presigned URL
1358
- * 2. PUT file directly to S3 URL
1359
- * 3. Call PATCH /files/{file_id} with status='uploaded'
1360
- * 4. Backend validates and stages in DuckDB immediately
1361
- * 5. Background task ingests to graph
1362
- *
1363
- * **Supported Formats:**
1364
- * - Parquet, CSV, JSON
1365
- *
1366
- * **Auto-Table Creation:**
1367
- * Tables are automatically created if they don't exist.
1368
- *
1369
- * **Important Notes:**
1370
- * - Presigned URLs expire (default: 1 hour)
1371
- * - Files are graph-scoped, independent resources
1372
- * - Upload URL generation is included - no credit consumption
489
+ * Returns a presigned S3 URL for direct upload. After uploading, call `PATCH /files/{file_id}` with `status=uploaded` to trigger DuckDB staging. Tables are auto-created if missing. Not allowed on entity graphs or shared repositories.
1373
490
  */
1374
491
  export declare const createFileUpload: <ThrowOnError extends boolean = false>(options: Options<CreateFileUploadData, ThrowOnError>) => import("./client").RequestResult<CreateFileUploadResponses, CreateFileUploadErrors, ThrowOnError, "fields">;
1375
492
  /**
1376
493
  * Delete File
1377
494
  *
1378
- * Delete file from all layers.
1379
- *
1380
- * Remove file from S3, database tracking, and optionally from DuckDB and graph.
1381
- * Files are deleted by file_id, independent of table context.
1382
- *
1383
- * **Query Parameters:**
1384
- * - `cascade` (optional, default=false): Delete from all layers including DuckDB
1385
- *
1386
- * **What Happens (cascade=false):**
1387
- * 1. File deleted from S3
1388
- * 2. Database record removed
1389
- * 3. Table statistics updated
1390
- *
1391
- * **What Happens (cascade=true):**
1392
- * 1. File data deleted from all DuckDB tables (by file_id)
1393
- * 2. Graph marked as stale
1394
- * 3. File deleted from S3
1395
- * 4. Database record removed
1396
- * 5. Table statistics updated
1397
- *
1398
- * **Use Cases:**
1399
- * - Remove incorrect or duplicate files
1400
- * - Clean up failed uploads
1401
- * - Delete files before graph ingestion
1402
- * - Surgical data removal with cascade
1403
- *
1404
- * **Security:**
1405
- * - Write access required
1406
- * - Shared repositories block deletions
1407
- * - Full audit trail
1408
- *
1409
- * **Important:**
1410
- * - Use cascade=true for immediate DuckDB cleanup
1411
- * - Graph rebuild recommended after cascade deletion
1412
- * - File deletion is included - no credit consumption
495
+ * Removes from S3 and database. `cascade=true` also deletes data from DuckDB tables and marks the graph stale (rebuild recommended). Not allowed on shared repositories.
1413
496
  */
1414
497
  export declare const deleteFile: <ThrowOnError extends boolean = false>(options: Options<DeleteFileData, ThrowOnError>) => import("./client").RequestResult<DeleteFileResponses, DeleteFileErrors, ThrowOnError, "fields">;
1415
498
  /**
1416
499
  * Get File Information
1417
500
  *
1418
- * Get detailed information about a specific file.
1419
- *
1420
- * Retrieve comprehensive metadata for a single file by file_id, independent of
1421
- * table context. Files are first-class resources with complete lifecycle tracking.
1422
- *
1423
- * **Returned Information:**
1424
- * - File ID, name, format, size
1425
- * - Upload status and timestamps
1426
- * - **Enhanced Multi-Layer Status** (new in this version):
1427
- * - S3 layer: upload_status, uploaded_at, size_bytes, row_count
1428
- * - DuckDB layer: duckdb_status, duckdb_staged_at, duckdb_row_count
1429
- * - Graph layer: graph_status, graph_ingested_at
1430
- * - Table association
1431
- * - S3 location
1432
- *
1433
- * **Multi-Layer Pipeline Visibility:**
1434
- * The `layers` object provides independent status tracking across the three-tier
1435
- * data pipeline:
1436
- * - **S3 (Immutable Source)**: File upload and validation
1437
- * - **DuckDB (Mutable Staging)**: Immediate queryability with file provenance
1438
- * - **Graph (Immutable View)**: Optional graph database materialization
1439
- *
1440
- * Each layer shows its own status, timestamp, and row count (where applicable),
1441
- * enabling precise debugging and monitoring of the data ingestion flow.
1442
- *
1443
- * **Use Cases:**
1444
- * - Validate file upload completion
1445
- * - Monitor multi-layer ingestion progress in real-time
1446
- * - Debug upload or staging issues at specific layers
1447
- * - Verify file metadata and row counts
1448
- * - Track file provenance through the pipeline
1449
- * - Identify bottlenecks in the ingestion process
1450
- *
1451
- * **Note:**
1452
- * File info retrieval is included - no credit consumption
501
+ * Returns per-layer status (`layers.s3`, `layers.duckdb`, `layers.graph`) for pipeline debugging.
1453
502
  */
1454
503
  export declare const getFile: <ThrowOnError extends boolean = false>(options: Options<GetFileData, ThrowOnError>) => import("./client").RequestResult<GetFileResponses, GetFileErrors, ThrowOnError, "fields">;
1455
504
  /**
1456
505
  * Update File Status
1457
506
  *
1458
- * Update file status and trigger processing.
1459
- *
1460
- * Update file status after upload completion. Setting status='uploaded' triggers
1461
- * immediate DuckDB staging and optional graph ingestion.
1462
- *
1463
- * **Request Body:**
1464
- * - `status`: New status (uploaded, disabled, failed)
1465
- * - `ingest_to_graph` (optional): If true, auto-ingest to graph after DuckDB staging
1466
- *
1467
- * **What Happens (status='uploaded'):**
1468
- * 1. File validated in S3
1469
- * 2. Row count calculated
1470
- * 3. DuckDB staging triggered immediately (background task)
1471
- * 4. If ingest_to_graph=true, graph ingestion queued
1472
- * 5. File queryable in DuckDB within seconds
1473
- *
1474
- * **Use Cases:**
1475
- * - Signal upload completion
1476
- * - Trigger immediate DuckDB staging
1477
- * - Enable/disable files
1478
- * - Mark failed uploads
1479
- *
1480
- * **Important:**
1481
- * - Files must exist in S3 before marking uploaded
1482
- * - DuckDB staging happens asynchronously
1483
- * - Graph ingestion is optional (ingest_to_graph flag)
507
+ * Setting `status=uploaded` validates the file in S3, calculates row count, and triggers DuckDB staging. Small files use direct staging; large files use a background Dagster job with an `operation_id` for SSE monitoring. Set `ingest_to_graph=true` to auto-chain graph materialization.
1484
508
  */
1485
509
  export declare const updateFile: <ThrowOnError extends boolean = false>(options: Options<UpdateFileData, ThrowOnError>) => import("./client").RequestResult<UpdateFileResponses, UpdateFileErrors, ThrowOnError, "fields">;
1486
510
  /**
1487
- * Get User Graphs and Repositories
1488
- *
1489
- * List all graph databases and shared repositories accessible to the current user.
1490
- *
1491
- * Returns a unified list of both user-created graphs and shared repositories (like SEC data)
1492
- * that the user has access to, including their role/access level and selection status.
1493
- *
1494
- * **Returned Information:**
1495
- * - Graph/Repository ID and display name
1496
- * - User's role/access level (admin/member for graphs, read/write/admin for repositories)
1497
- * - Selection status (only user graphs can be selected)
1498
- * - Creation timestamp
1499
- * - Repository type indicator (isRepository: true for shared repositories)
1500
- *
1501
- * **User Graphs (isRepository: false):**
1502
- * - Collaborative workspaces that can be shared with other users
1503
- * - Roles: `admin` (full access, can invite users) or `member` (read/write access)
1504
- * - Can be selected as active workspace
1505
- * - Graphs you create or have been invited to
1506
- *
1507
- * **Shared Repositories (isRepository: true):**
1508
- * - Read-only data repositories (e.g., SEC filings)
1509
- * - Access levels: `read`, `write` (for data contributions), `admin`
1510
- * - Cannot be selected (each has separate subscription)
1511
- * - Require separate subscriptions (personal, cannot be shared)
1512
- *
1513
- * **Selected Graph Concept:**
1514
- * The "selected" graph is the user's currently active workspace (user graphs only).
1515
- * Many API operations default to the selected graph if no graph_id is provided.
1516
- * Users can change their selected graph via `POST /v1/graphs/{graph_id}/select`.
1517
- *
1518
- * **Use Cases:**
1519
- * - Display unified graph/repository selector in UI
1520
- * - Show all accessible data sources (both owned graphs and subscribed repositories)
1521
- * - Identify currently active workspace
1522
- * - Filter by type (user graphs vs repositories)
1523
- *
1524
- * **Empty Response:**
1525
- * New users receive an empty list with `selectedGraphId: null`. Users should create
1526
- * a graph or subscribe to a repository.
1527
- *
1528
- * **Note:**
1529
- * Graph listing is included - no credit consumption required.
511
+ * List User Graphs and Repositories
1530
512
  */
1531
513
  export declare const getGraphs: <ThrowOnError extends boolean = false>(options?: Options<GetGraphsData, ThrowOnError>) => import("./client").RequestResult<GetGraphsResponses, GetGraphsErrors, ThrowOnError, "fields">;
1532
514
  /**
1533
515
  * Create New Graph Database
1534
516
  *
1535
- * Create a new graph database with specified schema and an initial entity.
1536
- *
1537
- * This endpoint starts an asynchronous graph creation operation and returns
1538
- * connection details for monitoring progress via Server-Sent Events (SSE).
1539
- *
1540
- * **Graph Creation Options:**
1541
- *
1542
- * 1. **Entity Graph** (`initial_entity` required, `custom_schema` omitted):
1543
- * - Creates graph structure with entity schema extensions
1544
- * - `initial_entity` is required — entity graphs must have an entity
1545
- * - Set `create_entity=False` to defer entity population (e.g. file-based ingestion)
1546
- * - Example: Creating a company graph with the company pre-populated
1547
- *
1548
- * 2. **Custom Graph** (`custom_schema` provided, no `initial_entity`):
1549
- * - Creates a generic graph with a fully custom schema
1550
- * - `initial_entity` is not used
1551
- * - Example: Analytics graphs, custom data models
1552
- *
1553
- * **Required Fields:**
1554
- * - `metadata.graph_name`: Unique name for the graph
1555
- * - `instance_tier`: Resource tier (ladybug-standard, ladybug-large, ladybug-xlarge)
1556
- * - `initial_entity`: Entity data — required for entity graphs (omit only when providing `custom_schema`)
1557
- *
1558
- * **Optional Fields:**
1559
- * - `metadata.description`: Human-readable description of the graph's purpose
1560
- * - `metadata.schema_extensions`: List of schema extensions (roboledger, roboinvestor, etc.)
1561
- * - `tags`: Organizational tags (max 10)
1562
- * - `create_entity`: Whether to populate entity data on creation (default: true)
1563
- *
1564
- * **Monitoring Progress:**
1565
- * Use the returned `operation_id` to connect to the SSE stream:
1566
- * ```javascript
1567
- * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
1568
- * eventSource.onmessage = (event) => {
1569
- * const data = JSON.parse(event.data);
1570
- * console.log('Progress:', data.progress_percent + '%');
1571
- * };
1572
- * ```
1573
- *
1574
- * **SSE Connection Limits:**
1575
- * - Maximum 5 concurrent SSE connections per user
1576
- * - Rate limited to 10 new connections per minute
1577
- * - Automatic circuit breaker for Redis failures
1578
- * - Graceful degradation if event system unavailable
1579
- *
1580
- * **Events Emitted:**
1581
- * - `operation_started`: Graph creation begins
1582
- * - `operation_progress`: Schema loading, database setup, etc.
1583
- * - `operation_completed`: Graph ready with connection details
1584
- * - `operation_error`: Creation failed with error details
1585
- *
1586
- * **Error Handling:**
1587
- * - `429 Too Many Requests`: SSE connection limit exceeded
1588
- * - `503 Service Unavailable`: SSE system temporarily disabled
1589
- * - Clients should implement exponential backoff on errors
1590
- *
1591
- * **Response includes:**
1592
- * - `operation_id`: Unique identifier for monitoring
1593
- * - `_links.stream`: SSE endpoint for real-time updates
1594
- * - `_links.status`: Point-in-time status check endpoint
517
+ * Creates a graph asynchronously. Returns an `OperationEnvelope` with `operation_id` for SSE progress at `/v1/operations/{operation_id}/stream`. Entity graphs require `initial_entity`. Supports `Idempotency-Key` header.
1595
518
  */
1596
519
  export declare const createGraph: <ThrowOnError extends boolean = false>(options: Options<CreateGraphData, ThrowOnError>) => import("./client").RequestResult<CreateGraphResponses, CreateGraphErrors, ThrowOnError, "fields">;
1597
520
  /**
1598
521
  * Get Available Schema Extensions
1599
- *
1600
- * List all available schema extensions for graph creation.
1601
- *
1602
- * Schema extensions provide pre-built industry-specific data models that extend
1603
- * the base graph schema with specialized nodes, relationships, and properties.
1604
- *
1605
- * **Available Extensions:**
1606
- * - **RoboLedger**: Complete accounting system with XBRL reporting, general ledger, and financial statements
1607
- * - **RoboInvestor**: Investment portfolio management with securities tracking, trade execution, and risk analysis
1608
- * - **RoboSCM**: Supply chain management and logistics
1609
- * - **RoboFO**: Front office operations and CRM
1610
- * - **RoboHRM**: Human resources management
1611
- * - **RoboEPM**: Enterprise performance management
1612
- * - **RoboReport**: Business intelligence and reporting
1613
- *
1614
- * **Extension Information:**
1615
- * Each extension includes:
1616
- * - Display name and description
1617
- * - Node and relationship counts
1618
- * - Context-aware capabilities (e.g., SEC repositories get different features than entity graphs)
1619
- *
1620
- * **Use Cases:**
1621
- * - Browse available extensions before creating a graph
1622
- * - Understand extension capabilities and data models
1623
- * - Plan graph schema based on business requirements
1624
- * - Combine multiple extensions for comprehensive data modeling
1625
- *
1626
- * **Note:**
1627
- * Extension listing is included - no credit consumption required.
1628
522
  */
1629
523
  export declare const getAvailableExtensions: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => import("./client").RequestResult<GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, ThrowOnError, "fields">;
1630
524
  /**
1631
525
  * Get Available Graph Tiers
1632
- *
1633
- * List all available graph database tier configurations.
1634
- *
1635
- * This endpoint provides comprehensive technical specifications for each available
1636
- * graph database tier, including instance types, resource limits, and features.
1637
- *
1638
- * **Tier Information:**
1639
- * Each tier includes:
1640
- * - Technical specifications (instance type, memory, storage)
1641
- * - Resource limits (subgraphs, credits, rate limits)
1642
- * - Feature list with capabilities
1643
- * - Availability status
1644
- *
1645
- * **Available Tiers:**
1646
- * - **ladybug-standard**: Dedicated entry-level tier
1647
- * - **ladybug-large**: Dedicated professional tier with subgraph support
1648
- * - **ladybug-xlarge**: Enterprise tier with maximum resources
1649
- *
1650
- * **Use Cases:**
1651
- * - Display tier options in graph creation UI
1652
- * - Show technical specifications for tier selection
1653
- * - Validate tier availability before graph creation
1654
- * - Display feature comparisons
1655
- *
1656
- * **Note:**
1657
- * Tier listing is included - no credit consumption required.
1658
526
  */
1659
527
  export declare const getAvailableGraphTiers: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableGraphTiersData, ThrowOnError>) => import("./client").RequestResult<GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, ThrowOnError, "fields">;
1660
528
  /**
1661
529
  * Get Graph Tier Capacity
1662
530
  *
1663
- * Check current infrastructure capacity for each graph database tier.
1664
- *
1665
- * Returns a status per tier indicating whether instances are immediately available,
1666
- * can be provisioned on demand, or are at capacity.
1667
- *
1668
- * **Status Values:**
1669
- * - `ready` — An instance slot is available; graph creation will succeed immediately
1670
- * - `scalable` — No slots right now, but a new instance can be provisioned (3-5 min)
1671
- * - `at_capacity` — Tier is full and cannot auto-scale; contact support
1672
- *
1673
- * **Use Cases:**
1674
- * - Pre-flight check before entering the graph creation wizard
1675
- * - Show availability badges on tier selection cards
1676
- * - Gate tier selection and show contact form for at-capacity tiers
1677
- *
1678
- * **Caching:**
1679
- * Results are cached for 60 seconds to avoid excessive infrastructure queries.
1680
- *
1681
- * **Note:**
1682
- * No credit consumption required. Does not expose instance counts or IPs.
531
+ * Status per tier: `ready` (slot available), `scalable` (can provision, 3-5 min), `at_capacity` (contact support). Cached 60s.
1683
532
  */
1684
533
  export declare const getGraphCapacity: <ThrowOnError extends boolean = false>(options?: Options<GetGraphCapacityData, ThrowOnError>) => import("./client").RequestResult<GetGraphCapacityResponses, GetGraphCapacityErrors, ThrowOnError, "fields">;
1685
534
  /**
1686
535
  * Select Graph
1687
- *
1688
- * Select a specific graph as the active workspace for the user.
1689
- *
1690
- * The selected graph becomes the default context for operations in client applications
1691
- * and can be used to maintain user workspace preferences across sessions.
1692
- *
1693
- * **Functionality:**
1694
- * - Sets the specified graph as the user's currently selected graph
1695
- * - Deselects any previously selected graph (only one can be selected at a time)
1696
- * - Persists selection across sessions until changed
1697
- * - Returns confirmation with the selected graph ID
1698
- *
1699
- * **Requirements:**
1700
- * - User must have access to the graph (as admin or member)
1701
- * - Graph must exist and not be deleted
1702
- * - User can only select graphs they have permission to access
1703
- *
1704
- * **Use Cases:**
1705
- * - Switch between multiple graphs in a multi-graph environment
1706
- * - Set default workspace after creating a new graph
1707
- * - Restore user's preferred workspace on login
1708
- * - Support graph context switching in client applications
1709
- *
1710
- * **Client Integration:**
1711
- * Many client operations can default to the selected graph, simplifying API calls
1712
- * by eliminating the need to specify graph_id repeatedly. Check the selected
1713
- * graph with `GET /v1/graphs` which returns `selectedGraphId`.
1714
- *
1715
- * **Note:**
1716
- * Graph selection is included - no credit consumption required.
1717
536
  */
1718
537
  export declare const selectGraph: <ThrowOnError extends boolean = false>(options: Options<SelectGraphData, ThrowOnError>) => import("./client").RequestResult<SelectGraphResponses, SelectGraphErrors, ThrowOnError, "fields">;
1719
538
  /**
1720
539
  * Get Service Offerings
1721
540
  *
1722
- * Get comprehensive information about all subscription offerings.
1723
- *
1724
- * This endpoint provides complete information about both graph database subscriptions
1725
- * and shared repository subscriptions. This is the primary endpoint for frontend
1726
- * applications to display subscription options.
1727
- *
1728
- * **Pricing Model:**
1729
- * - Graph subscriptions are **per-graph** with infrastructure-based pricing
1730
- * - Each graph you create has its own monthly subscription
1731
- * - Organizations can have multiple graphs with different infrastructure tiers
1732
- * - Credits are allocated per-graph, not shared across organization
1733
- *
1734
- * Includes:
1735
- * - Graph infrastructure tiers (ladybug-standard, ladybug-large, ladybug-xlarge) - per-graph pricing
1736
- * - Shared repository subscriptions - org-level
1737
- * - Operation costs and credit information
1738
- * - Features and capabilities for each tier
1739
- * - Enabled/disabled status for repositories
1740
- *
1741
- * All data comes from the config-based systems to ensure accuracy with backend behavior.
1742
- *
1743
- * No authentication required - this is public service information.
541
+ * Returns all subscription tiers, shared repository plans, and AI credit costs. No authentication required.
1744
542
  */
1745
543
  export declare const getServiceOfferings: <ThrowOnError extends boolean = false>(options?: Options<GetServiceOfferingsData, ThrowOnError>) => import("./client").RequestResult<GetServiceOfferingsResponses, GetServiceOfferingsErrors, ThrowOnError, "fields">;
1746
544
  /**
1747
545
  * Stream Operation Events
1748
546
  *
1749
- * Stream real-time events for an operation using Server-Sent Events (SSE).
1750
- *
1751
- * This endpoint provides real-time monitoring for all non-immediate operations including:
1752
- * - Graph creation and management
1753
- * - Agent analysis processing
1754
- * - Database backups and restores
1755
- * - Data synchronization tasks
1756
- *
1757
- * **Event Types:**
1758
- * - `operation_started`: Operation began execution
1759
- * - `operation_progress`: Progress update with details
1760
- * - `operation_completed`: Operation finished successfully
1761
- * - `operation_error`: Operation failed with error details
1762
- * - `operation_cancelled`: Operation was cancelled
1763
- *
1764
- * **Features:**
1765
- * - **Event Replay**: Use `from_sequence` parameter to replay missed events
1766
- * - **Automatic Reconnection**: Client can reconnect and resume from last seen event
1767
- * - **Real-time Updates**: Live progress updates during execution
1768
- * - **Timeout Handling**: 30-second keepalive messages prevent connection timeouts
1769
- * - **Graceful Degradation**: Automatic fallback if Redis is unavailable
1770
- *
1771
- * **Connection Limits:**
1772
- * - Maximum 5 concurrent SSE connections per user
1773
- * - Rate limited to 10 new connections per minute
1774
- * - Automatic cleanup of stale connections
1775
- * - Circuit breaker protection for Redis failures
1776
- *
1777
- * **Client Usage:**
1778
- * ```javascript
1779
- * const eventSource = new EventSource('/v1/operations/abc123/stream');
1780
- * eventSource.onmessage = (event) => {
1781
- * const data = JSON.parse(event.data);
1782
- * console.log('Progress:', data);
1783
- * };
1784
- * eventSource.onerror = (error) => {
1785
- * // Handle connection errors or rate limits
1786
- * console.error('SSE Error:', error);
1787
- * };
1788
- * ```
1789
- *
1790
- * **Error Handling:**
1791
- * - `429 Too Many Requests`: Connection limit or rate limit exceeded
1792
- * - `503 Service Unavailable`: SSE system temporarily disabled
1793
- * - Clients should implement exponential backoff on errors
1794
- *
1795
- * **No credits are consumed for SSE connections.**
547
+ * Server-Sent Events stream for real-time operation progress. Use `from_sequence` to replay missed events on reconnect. Max 5 concurrent SSE connections per user. Consumes no credits.
1796
548
  */
1797
549
  export declare const streamOperationEvents: <ThrowOnError extends boolean = false>(options: Options<StreamOperationEventsData, ThrowOnError>) => import("./client").RequestResult<StreamOperationEventsResponses, StreamOperationEventsErrors, ThrowOnError, "fields">;
1798
550
  /**
1799
551
  * Get Operation Status
1800
552
  *
1801
- * Get current status and metadata for an operation.
1802
- *
1803
- * Returns detailed information including:
1804
- * - Current status (pending, running, completed, failed, cancelled)
1805
- * - Creation and update timestamps
1806
- * - Operation type and associated graph
1807
- * - Result data (for completed operations)
1808
- * - Error details (for failed operations)
1809
- *
1810
- * This endpoint provides a point-in-time status check, while the `/stream` endpoint
1811
- * provides real-time updates. Use this for polling or initial status checks.
1812
- *
1813
- * **No credits are consumed for status checks.**
553
+ * Point-in-time status check. Use `/stream` for real-time updates. Consumes no credits.
1814
554
  */
1815
555
  export declare const getOperationStatus: <ThrowOnError extends boolean = false>(options: Options<GetOperationStatusData, ThrowOnError>) => import("./client").RequestResult<GetOperationStatusResponses, GetOperationStatusErrors, ThrowOnError, "fields">;
1816
556
  /**
1817
557
  * Cancel Operation
1818
558
  *
1819
- * Cancel a pending or running operation.
1820
- *
1821
- * Cancels the specified operation if it's still in progress. Once cancelled,
1822
- * the operation cannot be resumed and will emit a cancellation event to any
1823
- * active SSE connections.
1824
- *
1825
- * **Note**: Completed or already failed operations cannot be cancelled.
1826
- *
1827
- * **No credits are consumed for cancellation requests.**
559
+ * Cancels a pending or running operation. Emits a cancellation event to any active SSE connections. Cannot cancel completed or failed operations.
1828
560
  */
1829
561
  export declare const cancelOperation: <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) => import("./client").RequestResult<CancelOperationResponses, CancelOperationErrors, ThrowOnError, "fields">;
1830
562
  /**
1831
563
  * Get Organization Customer Info
1832
564
  *
1833
- * Get billing customer information for an organization including payment methods on file.
1834
- *
1835
- * Returns customer details, payment methods, and whether invoice billing is enabled.
1836
- *
1837
- * **Requirements:**
1838
- * - User must be a member of the organization
1839
- * - Sensitive payment details are only visible to owners
565
+ * Payment method details are only visible to org owners.
1840
566
  */
1841
567
  export declare const getOrgBillingCustomer: <ThrowOnError extends boolean = false>(options: Options<GetOrgBillingCustomerData, ThrowOnError>) => import("./client").RequestResult<GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, ThrowOnError, "fields">;
1842
568
  /**
1843
569
  * Create Customer Portal Session
1844
570
  *
1845
- * Create a Stripe Customer Portal session for managing payment methods.
1846
- *
1847
- * The portal allows users to:
1848
- * - Add new payment methods
1849
- * - Remove existing payment methods
1850
- * - Update default payment method
1851
- * - View billing history
1852
- *
1853
- * The user will be redirected to Stripe's hosted portal page and returned to the billing page when done.
1854
- *
1855
- * **Requirements:**
1856
- * - User must be an OWNER of the organization
1857
- * - Organization must have a Stripe customer ID (i.e., has gone through checkout at least once)
571
+ * Returns a Stripe Customer Portal URL for managing payment methods and billing history. Requires org owner role.
1858
572
  */
1859
573
  export declare const createPortalSession: <ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>) => import("./client").RequestResult<CreatePortalSessionResponses, CreatePortalSessionErrors, ThrowOnError, "fields">;
1860
574
  /**
1861
575
  * List Organization Subscriptions
1862
- *
1863
- * List all active and past subscriptions for an organization.
1864
- *
1865
- * Includes both graph and repository subscriptions with their status, pricing, and billing information.
1866
- *
1867
- * **Requirements:**
1868
- * - User must be a member of the organization
1869
576
  */
1870
577
  export declare const listOrgSubscriptions: <ThrowOnError extends boolean = false>(options: Options<ListOrgSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, ThrowOnError, "fields">;
1871
578
  /**
1872
579
  * Get Organization Subscription Details
1873
- *
1874
- * Get detailed information about a specific subscription.
1875
- *
1876
- * **Requirements:**
1877
- * - User must be a member of the organization
1878
580
  */
1879
581
  export declare const getOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<GetOrgSubscriptionData, ThrowOnError>) => import("./client").RequestResult<GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, ThrowOnError, "fields">;
1880
582
  /**
1881
583
  * Cancel Organization Subscription
1882
584
  *
1883
- * Cancel an organization subscription.
1884
- *
1885
- * The subscription will remain active until the end of the current billing period.
1886
- *
1887
- * **Requirements:**
1888
- * - User must be an OWNER of the organization
585
+ * Cancels at period end — subscription remains active through the current billing cycle. Requires org owner role.
1889
586
  */
1890
587
  export declare const cancelOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<CancelOrgSubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ThrowOnError, "fields">;
1891
588
  /**
1892
589
  * List Organization Invoices
1893
590
  *
1894
- * List payment history and invoices for an organization.
1895
- *
1896
- * Returns past invoices with payment status, amounts, and line items.
1897
- *
1898
- * **Requirements:**
1899
- * - User must be a member of the organization
1900
- * - Full invoice details are only visible to owners and admins
591
+ * Requires admin or owner role.
1901
592
  */
1902
593
  export declare const listOrgInvoices: <ThrowOnError extends boolean = false>(options: Options<ListOrgInvoicesData, ThrowOnError>) => import("./client").RequestResult<ListOrgInvoicesResponses, ListOrgInvoicesErrors, ThrowOnError, "fields">;
1903
594
  /**
1904
595
  * Get Organization Upcoming Invoice
1905
596
  *
1906
- * Get preview of the next invoice for an organization.
1907
- *
1908
- * Returns estimated charges for the next billing period.
1909
- *
1910
- * **Requirements:**
1911
- * - User must be a member of the organization
1912
- * - Full invoice details are only visible to owners and admins
597
+ * Requires admin or owner role. Returns null if no billing activity yet.
1913
598
  */
1914
599
  export declare const getOrgUpcomingInvoice: <ThrowOnError extends boolean = false>(options: Options<GetOrgUpcomingInvoiceData, ThrowOnError>) => import("./client").RequestResult<GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, ThrowOnError, "fields">;
1915
600
  /**
1916
601
  * Create Payment Checkout Session
1917
602
  *
1918
- * Create a Stripe checkout session for collecting payment method.
1919
- *
1920
- * This endpoint is used when an organization owner needs to add a payment method before
1921
- * provisioning resources. It creates a pending subscription and redirects
1922
- * to Stripe Checkout to collect payment details.
1923
- *
1924
- * **Flow:**
1925
- * 1. Owner tries to create a graph but org has no payment method
1926
- * 2. Frontend calls this endpoint with graph configuration
1927
- * 3. Backend creates a subscription in PENDING_PAYMENT status for the user's org
1928
- * 4. Returns Stripe Checkout URL
1929
- * 5. User completes payment on Stripe
1930
- * 6. Webhook activates subscription and provisions resource
1931
- *
1932
- * **Requirements:**
1933
- * - User must be an OWNER of their organization
1934
- * - Enterprise customers (with invoice_billing_enabled) should not call this endpoint.
603
+ * Initiates a Stripe checkout session for payment collection. Creates a pending subscription; the webhook activates it and provisions the resource after payment completes. Returns billing_disabled=true with no URL when billing is off. Requires org owner role.
1935
604
  */
1936
605
  export declare const createCheckoutSession: <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionData, ThrowOnError>) => import("./client").RequestResult<CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, ThrowOnError, "fields">;
1937
606
  /**
1938
607
  * Get Checkout Session Status
1939
608
  *
1940
- * Poll the status of a checkout session.
1941
- *
1942
- * Frontend should poll this endpoint after user returns from Stripe Checkout
1943
- * to determine when the resource is ready.
1944
- *
1945
- * **Status Values:**
1946
- * - `pending_payment`: Waiting for payment to complete
1947
- * - `provisioning`: Payment confirmed, resource being created
1948
- * - `active`: Resource is ready (resource_id will be set)
1949
- * - `failed`: Something went wrong (error field will be set)
1950
- * - `canceled`: Payment was canceled
1951
- *
1952
- * **When status is 'active':**
1953
- * - For graphs: `resource_id` will be the graph_id, and `operation_id` can be used to monitor SSE progress
1954
- * - For repositories: `resource_id` will be the repository name and access is immediately available
609
+ * Poll after returning from Stripe Checkout. Status progresses: pending_payment → provisioning → active. When active, resource_id is populated; for graphs, operation_id tracks SSE provisioning progress.
1955
610
  */
1956
611
  export declare const getCheckoutStatus: <ThrowOnError extends boolean = false>(options: Options<GetCheckoutStatusData, ThrowOnError>) => import("./client").RequestResult<GetCheckoutStatusResponses, GetCheckoutStatusErrors, ThrowOnError, "fields">;
1957
612
  /**
@@ -1977,7 +632,7 @@ export declare const handleHttpPostExtensionsGraphIdGraphqlPost: <ThrowOnError e
1977
632
  /**
1978
633
  * Update Entity
1979
634
  *
1980
- * Update entity details. Only provided (non-null) fields are updated.
635
+ * Only provided (non-null) fields are updated.
1981
636
  *
1982
637
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1983
638
  */
@@ -1985,7 +640,7 @@ export declare const opUpdateEntity: <ThrowOnError extends boolean = false>(opti
1985
640
  /**
1986
641
  * Initialize Ledger
1987
642
  *
1988
- * One-time ledger initialization create fiscal calendar + seed periods.
643
+ * One-time setup: creates the fiscal calendar and seeds periods. Returns 409 if already initialized.
1989
644
  *
1990
645
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1991
646
  */
@@ -1993,7 +648,7 @@ export declare const opInitializeLedger: <ThrowOnError extends boolean = false>(
1993
648
  /**
1994
649
  * Set Close Target
1995
650
  *
1996
- * Set the user-controlled close target (YYYY-MM).
651
+ * Period format: YYYY-MM. The close target is the user-controlled goal date, distinct from `closed_through` (what's actually closed).
1997
652
  *
1998
653
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1999
654
  */
@@ -2001,7 +656,7 @@ export declare const opSetCloseTarget: <ThrowOnError extends boolean = false>(op
2001
656
  /**
2002
657
  * Close Fiscal Period
2003
658
  *
2004
- * Close a fiscal period — the final commit action.
659
+ *
2005
660
  *
2006
661
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2007
662
  */
@@ -2009,47 +664,15 @@ export declare const opClosePeriod: <ThrowOnError extends boolean = false>(optio
2009
664
  /**
2010
665
  * Reopen Fiscal Period
2011
666
  *
2012
- * Reopen a closed fiscal period decrements `closed_through`.
667
+ * Decrements `closed_through` by one — only the most recently closed period can be reopened.
2013
668
  *
2014
669
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2015
670
  */
2016
671
  export declare const opReopenPeriod: <ThrowOnError extends boolean = false>(options: Options<OpReopenPeriodData, ThrowOnError>) => import("./client").RequestResult<OpReopenPeriodResponses, OpReopenPeriodErrors, ThrowOnError, "fields">;
2017
- /**
2018
- * Create Schedule
2019
- *
2020
- * Create a schedule with pre-generated monthly facts.
2021
- *
2022
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2023
- */
2024
- export declare const opCreateSchedule: <ThrowOnError extends boolean = false>(options: Options<OpCreateScheduleData, ThrowOnError>) => import("./client").RequestResult<OpCreateScheduleResponses, OpCreateScheduleErrors, ThrowOnError, "fields">;
2025
- /**
2026
- * Truncate Schedule (End Early)
2027
- *
2028
- * End a schedule early — delete forward facts + stale drafts.
2029
- *
2030
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2031
- */
2032
- export declare const opTruncateSchedule: <ThrowOnError extends boolean = false>(options: Options<OpTruncateScheduleData, ThrowOnError>) => import("./client").RequestResult<OpTruncateScheduleResponses, OpTruncateScheduleErrors, ThrowOnError, "fields">;
2033
- /**
2034
- * Create Closing Entry
2035
- *
2036
- * Create a draft closing entry from a schedule's facts for a period.
2037
- *
2038
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2039
- */
2040
- export declare const opCreateClosingEntry: <ThrowOnError extends boolean = false>(options: Options<OpCreateClosingEntryData, ThrowOnError>) => import("./client").RequestResult<OpCreateClosingEntryResponses, OpCreateClosingEntryErrors, ThrowOnError, "fields">;
2041
- /**
2042
- * Create Manual Closing Entry
2043
- *
2044
- * Create a manual (non-schedule) draft closing entry.
2045
- *
2046
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2047
- */
2048
- export declare const opCreateManualClosingEntry: <ThrowOnError extends boolean = false>(options: Options<OpCreateManualClosingEntryData, ThrowOnError>) => import("./client").RequestResult<OpCreateManualClosingEntryResponses, OpCreateManualClosingEntryErrors, ThrowOnError, "fields">;
2049
672
  /**
2050
673
  * Create Taxonomy
2051
674
  *
2052
- * Create a new taxonomy definition.
675
+ *
2053
676
  *
2054
677
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2055
678
  */
@@ -2057,23 +680,15 @@ export declare const opCreateTaxonomy: <ThrowOnError extends boolean = false>(op
2057
680
  /**
2058
681
  * Create Structure
2059
682
  *
2060
- * Create a new structure (statement, mapping, schedule, etc.).
683
+ * Structures organize elements within a taxonomy. Types: `statement`, `mapping`, `schedule`, `presentation`, `calculation`.
2061
684
  *
2062
685
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2063
686
  */
2064
687
  export declare const opCreateStructure: <ThrowOnError extends boolean = false>(options: Options<OpCreateStructureData, ThrowOnError>) => import("./client").RequestResult<OpCreateStructureResponses, OpCreateStructureErrors, ThrowOnError, "fields">;
2065
- /**
2066
- * Create Mapping Association
2067
- *
2068
- * Add a mapping association (CoA element → reporting concept).
2069
- *
2070
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2071
- */
2072
- export declare const opCreateMappingAssociation: <ThrowOnError extends boolean = false>(options: Options<OpCreateMappingAssociationData, ThrowOnError>) => import("./client").RequestResult<OpCreateMappingAssociationResponses, OpCreateMappingAssociationErrors, ThrowOnError, "fields">;
2073
688
  /**
2074
689
  * Delete Mapping Association
2075
690
  *
2076
- * Remove a mapping association.
691
+ *
2077
692
  *
2078
693
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2079
694
  */
@@ -2206,6 +821,38 @@ export declare const opDeleteJournalEntry: <ThrowOnError extends boolean = false
2206
821
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2207
822
  */
2208
823
  export declare const opReverseJournalEntry: <ThrowOnError extends boolean = false>(options: Options<OpReverseJournalEntryData, ThrowOnError>) => import("./client").RequestResult<OpReverseJournalEntryResponses, OpReverseJournalEntryErrors, ThrowOnError, "fields">;
824
+ /**
825
+ * Create Schedule
826
+ *
827
+ * Create a schedule and pre-generate monthly amortization facts spanning the period range. `entry_template` defines the debit/credit elements used by `create-closing-entry` each period.
828
+ *
829
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
830
+ */
831
+ export declare const opCreateSchedule: <ThrowOnError extends boolean = false>(options: Options<OpCreateScheduleData, ThrowOnError>) => import("./client").RequestResult<OpCreateScheduleResponses, OpCreateScheduleErrors, ThrowOnError, "fields">;
832
+ /**
833
+ * Truncate Schedule (End Early)
834
+ *
835
+ * End a schedule early by deleting forward facts and any stale draft closing entries past the cutoff. Historical facts and posted entries are preserved. Use this when a business event (asset disposal, contract cancellation) shortens the schedule's lifespan.
836
+ *
837
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
838
+ */
839
+ export declare const opTruncateSchedule: <ThrowOnError extends boolean = false>(options: Options<OpTruncateScheduleData, ThrowOnError>) => import("./client").RequestResult<OpTruncateScheduleResponses, OpTruncateScheduleErrors, ThrowOnError, "fields">;
840
+ /**
841
+ * Create Closing Entry
842
+ *
843
+ * Create a draft closing entry pre-populated from a schedule's facts for the given period. Idempotent — safe to call repeatedly; the `outcome` field describes what happened (`created`, `unchanged`, `regenerated`, `removed`, `skipped`).
844
+ *
845
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
846
+ */
847
+ export declare const opCreateClosingEntry: <ThrowOnError extends boolean = false>(options: Options<OpCreateClosingEntryData, ThrowOnError>) => import("./client").RequestResult<OpCreateClosingEntryResponses, OpCreateClosingEntryErrors, ThrowOnError, "fields">;
848
+ /**
849
+ * Create Manual Closing Entry
850
+ *
851
+ * Create a draft closing entry with manually specified line items — not tied to a schedule. Use for one-off business events (asset disposal, correcting entry, impairment). Total debits must equal total credits.
852
+ *
853
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
854
+ */
855
+ export declare const opCreateManualClosingEntry: <ThrowOnError extends boolean = false>(options: Options<OpCreateManualClosingEntryData, ThrowOnError>) => import("./client").RequestResult<OpCreateManualClosingEntryResponses, OpCreateManualClosingEntryErrors, ThrowOnError, "fields">;
2209
856
  /**
2210
857
  * Update Schedule
2211
858
  *
@@ -2223,20 +870,17 @@ export declare const opUpdateSchedule: <ThrowOnError extends boolean = false>(op
2223
870
  */
2224
871
  export declare const opDeleteSchedule: <ThrowOnError extends boolean = false>(options: Options<OpDeleteScheduleData, ThrowOnError>) => import("./client").RequestResult<OpDeleteScheduleResponses, OpDeleteScheduleErrors, ThrowOnError, "fields">;
2225
872
  /**
2226
- * Auto-Map Elements via AI (async)
873
+ * Create Mapping Association
2227
874
  *
2228
- * Trigger autonomous CoA US GAAP mapping via background worker.
875
+ * Link a chart-of-accounts element to a US GAAP reporting concept. For bulk associations (presentation/calculation linkbases, 50+ arcs at once) use `create-associations` instead.
2229
876
  *
2230
- * This is the only async/Dagster-dispatched ledger operation. Instead
2231
- * of running synchronously, it enqueues a `MappingAgent` task and
2232
- * returns a `pending` envelope with the worker-issued operation_id
2233
- * callers subscribe via `/v1/operations/{operation_id}/stream` for SSE
2234
- * progress events.
877
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
878
+ */
879
+ export declare const opCreateMappingAssociation: <ThrowOnError extends boolean = false>(options: Options<OpCreateMappingAssociationData, ThrowOnError>) => import("./client").RequestResult<OpCreateMappingAssociationResponses, OpCreateMappingAssociationErrors, ThrowOnError, "fields">;
880
+ /**
881
+ * Auto-Map Elements via AI (async)
2235
882
  *
2236
- * Confidence thresholds (in the agent):
2237
- * - ≥0.90: auto-approved mapping
2238
- * - 0.70-0.89: flagged for review
2239
- * - <0.70: skipped (left unmapped)
883
+ * Dispatches to the background worker — returns a `pending` envelope immediately. Monitor via SSE at `/v1/operations/{operation_id}/stream`. Confidence thresholds: ≥0.90 auto-approved, 0.70–0.89 flagged for review, <0.70 skipped.
2240
884
  *
2241
885
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2242
886
  */
@@ -2244,7 +888,7 @@ export declare const opAutoMapElements: <ThrowOnError extends boolean = false>(o
2244
888
  /**
2245
889
  * Create Report
2246
890
  *
2247
- * Create a report definition, generate facts, and mark as published.
891
+ * Generates report facts from the ledger and marks the report as published.
2248
892
  *
2249
893
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2250
894
  */
@@ -2252,7 +896,7 @@ export declare const opCreateReport: <ThrowOnError extends boolean = false>(opti
2252
896
  /**
2253
897
  * Regenerate Report
2254
898
  *
2255
- * Regenerate a report with new period dates.
899
+ *
2256
900
  *
2257
901
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2258
902
  */
@@ -2260,7 +904,7 @@ export declare const opRegenerateReport: <ThrowOnError extends boolean = false>(
2260
904
  /**
2261
905
  * Delete Report
2262
906
  *
2263
- * Delete a report definition and its facts.
907
+ * Deletes the report definition and all generated facts.
2264
908
  *
2265
909
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2266
910
  */
@@ -2268,7 +912,7 @@ export declare const opDeleteReport: <ThrowOnError extends boolean = false>(opti
2268
912
  /**
2269
913
  * Share Report
2270
914
  *
2271
- * Share a published report to a publish list's members.
915
+ * Only published reports can be shared. Sends the report to all members of the target publish list.
2272
916
  *
2273
917
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2274
918
  */
@@ -2276,7 +920,7 @@ export declare const opShareReport: <ThrowOnError extends boolean = false>(optio
2276
920
  /**
2277
921
  * Create Publish List
2278
922
  *
2279
- * Create a new publish list.
923
+ *
2280
924
  *
2281
925
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2282
926
  */
@@ -2284,7 +928,7 @@ export declare const opCreatePublishList: <ThrowOnError extends boolean = false>
2284
928
  /**
2285
929
  * Update Publish List
2286
930
  *
2287
- * Update a publish list's name / description.
931
+ * Updates the publish list's `name` and/or `description`. Membership is managed via add/remove-member operations.
2288
932
  *
2289
933
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2290
934
  */
@@ -2292,7 +936,7 @@ export declare const opUpdatePublishList: <ThrowOnError extends boolean = false>
2292
936
  /**
2293
937
  * Delete Publish List
2294
938
  *
2295
- * Delete a publish list.
939
+ *
2296
940
  *
2297
941
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2298
942
  */
@@ -2300,7 +944,7 @@ export declare const opDeletePublishList: <ThrowOnError extends boolean = false>
2300
944
  /**
2301
945
  * Add Members to Publish List
2302
946
  *
2303
- * Add target graphs as members of a publish list.
947
+ *
2304
948
  *
2305
949
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2306
950
  */
@@ -2308,33 +952,39 @@ export declare const opAddPublishListMembers: <ThrowOnError extends boolean = fa
2308
952
  /**
2309
953
  * Remove Member from Publish List
2310
954
  *
2311
- * Remove a target graph from a publish list.
955
+ *
2312
956
  *
2313
957
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2314
958
  */
2315
959
  export declare const opRemovePublishListMember: <ThrowOnError extends boolean = false>(options: Options<OpRemovePublishListMemberData, ThrowOnError>) => import("./client").RequestResult<OpRemovePublishListMemberResponses, OpRemovePublishListMemberErrors, ThrowOnError, "fields">;
2316
960
  /**
2317
- * Build Fact Grid
961
+ * Live Financial Statement
2318
962
  *
2319
- * Build a multi-dimensional fact grid against the graph schema.
963
+ * Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping. This is the authoritative source for RoboLedger entity graphs — no graph materialization required. Rejected on shared-repository graphs; those should use `financial-statement-analysis` instead.
2320
964
  *
2321
- * Queries `Fact` nodes by element qnames or canonical concepts with
2322
- * optional filters for periods, entities, filing form, fiscal context,
2323
- * and period type. Returns a deduplicated pivot table plus optional
2324
- * summary statistics.
965
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
966
+ */
967
+ export declare const opLiveFinancialStatement: <ThrowOnError extends boolean = false>(options: Options<OpLiveFinancialStatementData, ThrowOnError>) => import("./client").RequestResult<OpLiveFinancialStatementResponses, OpLiveFinancialStatementErrors, ThrowOnError, "fields">;
968
+ /**
969
+ * Build Fact Grid
2325
970
  *
2326
- * This is a graph-database read the query runs against LadybugDB,
2327
- * not the extensions OLTP database. The same operation works for
2328
- * roboledger tenant graphs (post-materialization) and the SEC shared
2329
- * repository (which uses the same XBRL hypercube schema).
971
+ * Queries LadybugDB `Fact` nodes by element qnames or canonical concepts, with filters for periods, entities, form, and fiscal context. Returns a deduplicated pivot table. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository.
2330
972
  *
2331
973
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2332
974
  */
2333
975
  export declare const opBuildFactGrid: <ThrowOnError extends boolean = false>(options: Options<OpBuildFactGridData, ThrowOnError>) => import("./client").RequestResult<OpBuildFactGridResponses, OpBuildFactGridErrors, ThrowOnError, "fields">;
2334
976
  /**
2335
- * Create Portfolio
977
+ * Financial Statement Analysis
2336
978
  *
979
+ * Query a rendered financial statement from the graph-backed XBRL hypercube (Structure → FactSet → Fact). Works on the SEC shared repository today and on any RoboLedger tenant graph whose ledger has been materialized to LadybugDB. For shared-repo graphs, provide `ticker` to auto-resolve the latest filing; for tenant graphs, provide `report_id` explicitly.
2337
980
  *
981
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
982
+ */
983
+ export declare const opFinancialStatementAnalysis: <ThrowOnError extends boolean = false>(options: Options<OpFinancialStatementAnalysisData, ThrowOnError>) => import("./client").RequestResult<OpFinancialStatementAnalysisResponses, OpFinancialStatementAnalysisErrors, ThrowOnError, "fields">;
984
+ /**
985
+ * Create Portfolio
986
+ *
987
+ * Create an investment portfolio within this graph. Portfolios are logical groupings of securities (stocks, notes, warrants) owned by the entity; subsequent positions attach to the portfolio.
2338
988
  *
2339
989
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2340
990
  */
@@ -2342,7 +992,7 @@ export declare const opCreatePortfolio: <ThrowOnError extends boolean = false>(o
2342
992
  /**
2343
993
  * Update Portfolio
2344
994
  *
2345
- *
995
+ * Update mutable fields on a portfolio (name, description, strategy, inception_date, base_currency). Unset fields are ignored — partial updates are explicit.
2346
996
  *
2347
997
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2348
998
  */
@@ -2350,7 +1000,7 @@ export declare const opUpdatePortfolio: <ThrowOnError extends boolean = false>(o
2350
1000
  /**
2351
1001
  * Delete Portfolio
2352
1002
  *
2353
- *
1003
+ * Hard-delete a portfolio. Returns 409 if the portfolio has active positions — dispose (soft-delete) them first.
2354
1004
  *
2355
1005
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2356
1006
  */
@@ -2358,7 +1008,7 @@ export declare const opDeletePortfolio: <ThrowOnError extends boolean = false>(o
2358
1008
  /**
2359
1009
  * Create Security
2360
1010
  *
2361
- *
1011
+ * Register a security (common stock, preferred stock, warrant, convertible note, etc.) owned by this graph's entity. Optionally cross-links to an issuing entity in another graph via `source_graph_id` for mutual-handshake attribution.
2362
1012
  *
2363
1013
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2364
1014
  */
@@ -2366,7 +1016,7 @@ export declare const opCreateSecurity: <ThrowOnError extends boolean = false>(op
2366
1016
  /**
2367
1017
  * Update Security
2368
1018
  *
2369
- *
1019
+ * Update mutable fields on a security (name, type, subtype, terms, share counts, entity linkage). Unset fields are ignored.
2370
1020
  *
2371
1021
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2372
1022
  */
@@ -2374,7 +1024,7 @@ export declare const opUpdateSecurity: <ThrowOnError extends boolean = false>(op
2374
1024
  /**
2375
1025
  * Delete Security
2376
1026
  *
2377
- *
1027
+ * Soft-delete the security (`is_active=false`). Historical positions referencing it remain valid.
2378
1028
  *
2379
1029
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2380
1030
  */
@@ -2382,7 +1032,7 @@ export declare const opDeleteSecurity: <ThrowOnError extends boolean = false>(op
2382
1032
  /**
2383
1033
  * Create Position
2384
1034
  *
2385
- *
1035
+ * Open a position in a security within a portfolio. One active position per (portfolio, security) pair — creating a second active position returns 409. Dispose an existing position via `delete-position` before opening a new one.
2386
1036
  *
2387
1037
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2388
1038
  */
@@ -2390,7 +1040,7 @@ export declare const opCreatePosition: <ThrowOnError extends boolean = false>(op
2390
1040
  /**
2391
1041
  * Update Position
2392
1042
  *
2393
- *
1043
+ * Update mutable fields on a position (quantity, cost basis, valuation, notes, status). Use `delete-position` for soft disposal instead of setting `status` manually.
2394
1044
  *
2395
1045
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2396
1046
  */
@@ -2398,7 +1048,7 @@ export declare const opUpdatePosition: <ThrowOnError extends boolean = false>(op
2398
1048
  /**
2399
1049
  * Delete Position
2400
1050
  *
2401
- *
1051
+ * Soft-delete the position (`status='disposed'`). Historical holding records referencing it remain valid.
2402
1052
  *
2403
1053
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2404
1054
  */