@robosystems/client 2.36.0 → 2.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +5 -4
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +17 -11
- package/sdk/sdk.gen.js +25 -14
- package/sdk/sdk.gen.ts +22 -11
- package/sdk/types.gen.d.ts +73 -4
- package/sdk/types.gen.ts +78 -4
- package/sdk.gen.d.ts +17 -11
- package/sdk.gen.js +25 -14
- package/sdk.gen.ts +22 -11
- package/types.gen.d.ts +73 -4
- package/types.gen.ts +78 -4
package/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
2
|
-
import type { AcceptSuggestionsData, AcceptSuggestionsErrors, AcceptSuggestionsResponses, AddGraphMemberData, AddGraphMemberErrors, AddGraphMemberResponses, AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AssertMetricsData, AssertMetricsErrors, AssertMetricsResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BlockSourceGraphData, BlockSourceGraphErrors, BlockSourceGraphResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeCalendarStartData, ChangeCalendarStartErrors, ChangeCalendarStartResponses, ChangeReportingStyleData, ChangeReportingStyleErrors, ChangeReportingStyleResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, ChangeTierData, ChangeTierErrors, ChangeTierResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, ClosePeriodData, ClosePeriodErrors, ClosePeriodResponses, CompleteDocumentUploadData, CompleteDocumentUploadErrors, CompleteDocumentUploadResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, ComputeForecastData, ComputeForecastErrors, ComputeForecastResponses, ComputeMetricsData, ComputeMetricsErrors, ComputeMetricsResponses, ConsolidationWorksheetData, ConsolidationWorksheetErrors, ConsolidationWorksheetResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateDimensionData, CreateDimensionErrors, CreateDimensionResponses, CreateDocumentUploadData, CreateDocumentUploadErrors, CreateDocumentUploadResponses, CreateEntityData, CreateEntityErrors, CreateEntityResponses, CreateEventBlockData, CreateEventBlockErrors, CreateEventBlockResponses, CreateEventHandlerData, CreateEventHandlerErrors, CreateEventHandlerResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateInformationBlockData, CreateInformationBlockErrors, CreateInformationBlockResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreateOrgInvitationData, CreateOrgInvitationErrors, CreateOrgInvitationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioBlockData, CreatePortfolioBlockErrors, CreatePortfolioBlockResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyBlockData, CreateTaxonomyBlockErrors, CreateTaxonomyBlockResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteGraphData, DeleteGraphErrors, DeleteGraphResponses, DeleteInformationBlockData, DeleteInformationBlockErrors, DeleteInformationBlockResponses, DeleteJournalEntryData, DeleteJournalEntryErrors, DeleteJournalEntryResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioBlockData, DeletePortfolioBlockErrors, DeletePortfolioBlockResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, DeleteTaxonomyBlockData, DeleteTaxonomyBlockErrors, DeleteTaxonomyBlockResponses, DeleteUserPasskeyData, DeleteUserPasskeyErrors, DeleteUserPasskeyResponses, DescribeFilingData, DescribeFilingErrors, DescribeFilingResponses, DisclosuresData, DisclosuresErrors, DisclosuresResponses, EvaluateRulesData, EvaluateRulesErrors, EvaluateRulesResponses, ExecuteCypherData, ExecuteCypherErrors, ExecuteCypherResponses, ExecuteEventBlockData, ExecuteEventBlockErrors, ExecuteEventBlockResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, FileReportData, FileReportErrors, FileReportResponses, FinancialStatementAnalysisData, FinancialStatementAnalysisErrors, FinancialStatementAnalysisResponses, ForgetData, ForgetErrors, ForgetResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAuthProvidersData, GetAuthProvidersErrors, GetAuthProvidersResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentFileData, GetDocumentFileErrors, GetDocumentFileResponses, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageData, GetGraphUsageErrors, GetGraphUsageResponses, GetInvitationPreviewData, GetInvitationPreviewErrors, GetInvitationPreviewResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetMfaOptionsData, GetMfaOptionsErrors, GetMfaOptionsResponses, GetMfaStatusData, GetMfaStatusErrors, GetMfaStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOperatorRunData, GetOperatorRunErrors, GetOperatorRunResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasskeyLoginOptionsData, GetPasskeyLoginOptionsErrors, GetPasskeyLoginOptionsResponses, GetPasskeyReauthOptionsData, GetPasskeyReauthOptionsErrors, GetPasskeyReauthOptionsResponses, GetPasskeyRegistrationOptionsData, GetPasskeyRegistrationOptionsErrors, GetPasskeyRegistrationOptionsResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, InformationBlockData, InformationBlockErrors, InformationBlockResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeChartOfAccountsData, InitializeChartOfAccountsErrors, InitializeChartOfAccountsResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, LearnClassificationDefaultsData, LearnClassificationDefaultsErrors, LearnClassificationDefaultsResponses, LinkBankAccountData, LinkBankAccountErrors, LinkBankAccountResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListGraphMembersData, ListGraphMembersErrors, ListGraphMembersResponses, ListGraphMutationsData, ListGraphMutationsErrors, ListGraphMutationsResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorRunsData, ListOperatorRunsErrors, ListOperatorRunsResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOperatorThreadsData, ListOperatorThreadsErrors, ListOperatorThreadsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvitationsData, ListOrgInvitationsErrors, ListOrgInvitationsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOAuthGrantsData, ListUserOAuthGrantsErrors, ListUserOAuthGrantsResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, ListUserPasskeysData, ListUserPasskeysErrors, ListUserPasskeysResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewConsolidationEntriesData, PreviewConsolidationEntriesErrors, PreviewConsolidationEntriesResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PreviewReconciliationsData, PreviewReconciliationsErrors, PreviewReconciliationsResponses, PreviewReconcilingItemData, PreviewReconcilingItemErrors, PreviewReconcilingItemResponses, PreviewScheduleData, PreviewScheduleErrors, PreviewScheduleResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, ProposeConsolidationEntriesData, ProposeConsolidationEntriesErrors, ProposeConsolidationEntriesResponses, ReadTextData, ReadTextErrors, ReadTextResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RecordAcquisitionData, RecordAcquisitionErrors, RecordAcquisitionResponses, RecordDeconsolidationData, RecordDeconsolidationErrors, RecordDeconsolidationResponses, RecordOpeningBalanceData, RecordOpeningBalanceErrors, RecordOpeningBalanceResponses, RecordOwnershipChangeData, RecordOwnershipChangeErrors, RecordOwnershipChangeResponses, RecordStatementBalanceData, RecordStatementBalanceErrors, RecordStatementBalanceResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RefreshReconciliationsData, RefreshReconciliationsErrors, RefreshReconciliationsResponses, RegenerateMfaRecoveryCodesData, RegenerateMfaRecoveryCodesErrors, RegenerateMfaRecoveryCodesResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveGraphMemberData, RemoveGraphMemberErrors, RemoveGraphMemberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendOrgInvitationData, ResendOrgInvitationErrors, ResendOrgInvitationResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, ResolveReconcilingItemData, ResolveReconcilingItemErrors, ResolveReconcilingItemResponses, ResumeOperationData, ResumeOperationErrors, ResumeOperationResponses, RevokeOrgInvitationData, RevokeOrgInvitationErrors, RevokeOrgInvitationResponses, RevokeReportShareData, RevokeReportShareErrors, RevokeReportShareResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, RevokeUserOAuthGrantData, RevokeUserOAuthGrantErrors, RevokeUserOAuthGrantResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SearchTextData, SearchTextErrors, SearchTextResponses, SetAllocationOverrideData, SetAllocationOverrideErrors, SetAllocationOverrideResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, SetReconciliationPolicyData, SetReconciliationPolicyErrors, SetReconciliationPolicyResponses, SetSelectedGraphData, SetSelectedGraphErrors, SetSelectedGraphResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SignOffReconciliationData, SignOffReconciliationErrors, SignOffReconciliationResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TerminateScheduleData, TerminateScheduleErrors, TerminateScheduleResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UnblockSourceGraphData, UnblockSourceGraphErrors, UnblockSourceGraphResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateDimensionData, UpdateDimensionErrors, UpdateDimensionResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateGraphMemberRoleData, UpdateGraphMemberRoleErrors, UpdateGraphMemberRoleResponses, UpdateGraphMetadataData, UpdateGraphMetadataErrors, UpdateGraphMetadataResponses, UpdateInformationBlockData, UpdateInformationBlockErrors, UpdateInformationBlockResponses, UpdateJournalEntryData, UpdateJournalEntryErrors, UpdateJournalEntryResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioBlockData, UpdatePortfolioBlockErrors, UpdatePortfolioBlockResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateTaxonomyBlockData, UpdateTaxonomyBlockErrors, UpdateTaxonomyBlockResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses, VerifyMfaData, VerifyMfaErrors, VerifyMfaResponses, VerifyPasskeyLoginData, VerifyPasskeyLoginErrors, VerifyPasskeyLoginResponses, VerifyPasskeyRegistrationData, VerifyPasskeyRegistrationErrors, VerifyPasskeyRegistrationResponses } from './types.gen';
|
|
2
|
+
import type { AcceptSuggestionsData, AcceptSuggestionsErrors, AcceptSuggestionsResponses, AddGraphMemberData, AddGraphMemberErrors, AddGraphMemberResponses, AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AssertMetricsData, AssertMetricsErrors, AssertMetricsResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BlockSourceGraphData, BlockSourceGraphErrors, BlockSourceGraphResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeCalendarStartData, ChangeCalendarStartErrors, ChangeCalendarStartResponses, ChangeReportingStyleData, ChangeReportingStyleErrors, ChangeReportingStyleResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, ChangeTierData, ChangeTierErrors, ChangeTierResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, ClosePeriodData, ClosePeriodErrors, ClosePeriodResponses, CompleteDocumentUploadData, CompleteDocumentUploadErrors, CompleteDocumentUploadResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, ComputeForecastData, ComputeForecastErrors, ComputeForecastResponses, ComputeMetricsData, ComputeMetricsErrors, ComputeMetricsResponses, ConsolidationWorksheetData, ConsolidationWorksheetErrors, ConsolidationWorksheetResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateDimensionData, CreateDimensionErrors, CreateDimensionResponses, CreateDocumentUploadData, CreateDocumentUploadErrors, CreateDocumentUploadResponses, CreateEntityData, CreateEntityErrors, CreateEntityResponses, CreateEventBlockData, CreateEventBlockErrors, CreateEventBlockResponses, CreateEventHandlerData, CreateEventHandlerErrors, CreateEventHandlerResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateInformationBlockData, CreateInformationBlockErrors, CreateInformationBlockResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreateOrgInvitationData, CreateOrgInvitationErrors, CreateOrgInvitationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioBlockData, CreatePortfolioBlockErrors, CreatePortfolioBlockResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyBlockData, CreateTaxonomyBlockErrors, CreateTaxonomyBlockResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteGraphData, DeleteGraphErrors, DeleteGraphResponses, DeleteInformationBlockData, DeleteInformationBlockErrors, DeleteInformationBlockResponses, DeleteJournalEntryData, DeleteJournalEntryErrors, DeleteJournalEntryResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioBlockData, DeletePortfolioBlockErrors, DeletePortfolioBlockResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, DeleteTaxonomyBlockData, DeleteTaxonomyBlockErrors, DeleteTaxonomyBlockResponses, DeleteUserPasskeyData, DeleteUserPasskeyErrors, DeleteUserPasskeyResponses, DescribeFilingData, DescribeFilingErrors, DescribeFilingResponses, DisclosuresData, DisclosuresErrors, DisclosuresResponses, EndRepositorySubscriptionTrialData, EndRepositorySubscriptionTrialErrors, EndRepositorySubscriptionTrialResponses, EvaluateRulesData, EvaluateRulesErrors, EvaluateRulesResponses, ExecuteCypherData, ExecuteCypherErrors, ExecuteCypherResponses, ExecuteEventBlockData, ExecuteEventBlockErrors, ExecuteEventBlockResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, FileReportData, FileReportErrors, FileReportResponses, FinancialStatementAnalysisData, FinancialStatementAnalysisErrors, FinancialStatementAnalysisResponses, ForgetData, ForgetErrors, ForgetResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAuthProvidersData, GetAuthProvidersErrors, GetAuthProvidersResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentFileData, GetDocumentFileErrors, GetDocumentFileResponses, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageData, GetGraphUsageErrors, GetGraphUsageResponses, GetInvitationPreviewData, GetInvitationPreviewErrors, GetInvitationPreviewResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetMfaOptionsData, GetMfaOptionsErrors, GetMfaOptionsResponses, GetMfaStatusData, GetMfaStatusErrors, GetMfaStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOperatorRunData, GetOperatorRunErrors, GetOperatorRunResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasskeyLoginOptionsData, GetPasskeyLoginOptionsErrors, GetPasskeyLoginOptionsResponses, GetPasskeyReauthOptionsData, GetPasskeyReauthOptionsErrors, GetPasskeyReauthOptionsResponses, GetPasskeyRegistrationOptionsData, GetPasskeyRegistrationOptionsErrors, GetPasskeyRegistrationOptionsResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, InformationBlockData, InformationBlockErrors, InformationBlockResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeChartOfAccountsData, InitializeChartOfAccountsErrors, InitializeChartOfAccountsResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, LearnClassificationDefaultsData, LearnClassificationDefaultsErrors, LearnClassificationDefaultsResponses, LinkBankAccountData, LinkBankAccountErrors, LinkBankAccountResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListGraphMembersData, ListGraphMembersErrors, ListGraphMembersResponses, ListGraphMutationsData, ListGraphMutationsErrors, ListGraphMutationsResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorRunsData, ListOperatorRunsErrors, ListOperatorRunsResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOperatorThreadsData, ListOperatorThreadsErrors, ListOperatorThreadsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvitationsData, ListOrgInvitationsErrors, ListOrgInvitationsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOAuthGrantsData, ListUserOAuthGrantsErrors, ListUserOAuthGrantsResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, ListUserPasskeysData, ListUserPasskeysErrors, ListUserPasskeysResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewConsolidationEntriesData, PreviewConsolidationEntriesErrors, PreviewConsolidationEntriesResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PreviewReconciliationsData, PreviewReconciliationsErrors, PreviewReconciliationsResponses, PreviewReconcilingItemData, PreviewReconcilingItemErrors, PreviewReconcilingItemResponses, PreviewScheduleData, PreviewScheduleErrors, PreviewScheduleResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, ProposeConsolidationEntriesData, ProposeConsolidationEntriesErrors, ProposeConsolidationEntriesResponses, ReadTextData, ReadTextErrors, ReadTextResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RecordAcquisitionData, RecordAcquisitionErrors, RecordAcquisitionResponses, RecordDeconsolidationData, RecordDeconsolidationErrors, RecordDeconsolidationResponses, RecordOpeningBalanceData, RecordOpeningBalanceErrors, RecordOpeningBalanceResponses, RecordOwnershipChangeData, RecordOwnershipChangeErrors, RecordOwnershipChangeResponses, RecordStatementBalanceData, RecordStatementBalanceErrors, RecordStatementBalanceResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RefreshReconciliationsData, RefreshReconciliationsErrors, RefreshReconciliationsResponses, RegenerateMfaRecoveryCodesData, RegenerateMfaRecoveryCodesErrors, RegenerateMfaRecoveryCodesResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveGraphMemberData, RemoveGraphMemberErrors, RemoveGraphMemberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendOrgInvitationData, ResendOrgInvitationErrors, ResendOrgInvitationResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, ResolveReconcilingItemData, ResolveReconcilingItemErrors, ResolveReconcilingItemResponses, ResumeOperationData, ResumeOperationErrors, ResumeOperationResponses, RevokeOrgInvitationData, RevokeOrgInvitationErrors, RevokeOrgInvitationResponses, RevokeReportShareData, RevokeReportShareErrors, RevokeReportShareResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, RevokeUserOAuthGrantData, RevokeUserOAuthGrantErrors, RevokeUserOAuthGrantResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SearchTextData, SearchTextErrors, SearchTextResponses, SetAllocationOverrideData, SetAllocationOverrideErrors, SetAllocationOverrideResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, SetReconciliationPolicyData, SetReconciliationPolicyErrors, SetReconciliationPolicyResponses, SetSelectedGraphData, SetSelectedGraphErrors, SetSelectedGraphResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SignOffReconciliationData, SignOffReconciliationErrors, SignOffReconciliationResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TerminateScheduleData, TerminateScheduleErrors, TerminateScheduleResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UnblockSourceGraphData, UnblockSourceGraphErrors, UnblockSourceGraphResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateDimensionData, UpdateDimensionErrors, UpdateDimensionResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateGraphMemberRoleData, UpdateGraphMemberRoleErrors, UpdateGraphMemberRoleResponses, UpdateGraphMetadataData, UpdateGraphMetadataErrors, UpdateGraphMetadataResponses, UpdateInformationBlockData, UpdateInformationBlockErrors, UpdateInformationBlockResponses, UpdateJournalEntryData, UpdateJournalEntryErrors, UpdateJournalEntryResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioBlockData, UpdatePortfolioBlockErrors, UpdatePortfolioBlockResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateTaxonomyBlockData, UpdateTaxonomyBlockErrors, UpdateTaxonomyBlockResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses, VerifyMfaData, VerifyMfaErrors, VerifyMfaResponses, VerifyPasskeyLoginData, VerifyPasskeyLoginErrors, VerifyPasskeyLoginResponses, VerifyPasskeyRegistrationData, VerifyPasskeyRegistrationErrors, VerifyPasskeyRegistrationResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -214,7 +214,7 @@ export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(opt
|
|
|
214
214
|
/**
|
|
215
215
|
* Create API Key
|
|
216
216
|
*
|
|
217
|
-
* The raw key value is only returned once at creation time and cannot be retrieved again.
|
|
217
|
+
* The raw key value is only returned once at creation time and cannot be retrieved again. Requires a signed-in session; API keys are not accepted.
|
|
218
218
|
*/
|
|
219
219
|
export declare const createUserApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) => RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>;
|
|
220
220
|
/**
|
|
@@ -270,7 +270,7 @@ export declare const removeOrgMember: <ThrowOnError extends boolean = false>(opt
|
|
|
270
270
|
/**
|
|
271
271
|
* Update Member Role
|
|
272
272
|
*
|
|
273
|
-
* Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
|
|
273
|
+
* Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow. Requires a signed-in session; API keys are not accepted.
|
|
274
274
|
*/
|
|
275
275
|
export declare const updateOrgMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) => RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError>;
|
|
276
276
|
/**
|
|
@@ -282,7 +282,7 @@ export declare const listOrgInvitations: <ThrowOnError extends boolean = false>(
|
|
|
282
282
|
/**
|
|
283
283
|
* Invite Member
|
|
284
284
|
*
|
|
285
|
-
* Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.
|
|
285
|
+
* Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited. Requires a signed-in session; API keys are not accepted.
|
|
286
286
|
*/
|
|
287
287
|
export declare const createOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<CreateOrgInvitationData, ThrowOnError>) => RequestResult<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError>;
|
|
288
288
|
/**
|
|
@@ -294,7 +294,7 @@ export declare const revokeOrgInvitation: <ThrowOnError extends boolean = false>
|
|
|
294
294
|
/**
|
|
295
295
|
* Resend Invitation
|
|
296
296
|
*
|
|
297
|
-
* Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
|
|
297
|
+
* Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email. Requires a signed-in session; API keys are not accepted.
|
|
298
298
|
*/
|
|
299
299
|
export declare const resendOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<ResendOrgInvitationData, ThrowOnError>) => RequestResult<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError>;
|
|
300
300
|
/**
|
|
@@ -352,7 +352,7 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
|
|
|
352
352
|
/**
|
|
353
353
|
* Set Connection Write Policy
|
|
354
354
|
*
|
|
355
|
-
* Choose how a live connection and RoboSystems share the books. 'qb_authoritative', the default, makes QuickBooks the book of record: RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'shadow' keeps QuickBooks the book of record and writes nothing to it: the close posts nothing locally either, its drafts become shadowed expectations compared with what QuickBooks holds, and its gates are recorded as findings. 'native' is not a choice here: it is what
|
|
355
|
+
* Choose how a live connection and RoboSystems share the books. 'qb_authoritative', the default, makes QuickBooks the book of record: RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'shadow' keeps QuickBooks the book of record and writes nothing to it: the close posts nothing locally either, its drafts become shadowed expectations compared with what QuickBooks holds, and its gates are recorded as findings. 'native' is not a choice here: it is what severing leaves, books kept in RoboSystems with no connection to write to. This is the explicit operator opt-in for writing to your books of record.
|
|
356
356
|
*/
|
|
357
357
|
export declare const setConnectionWritePolicy: <ThrowOnError extends boolean = false>(options: Options<SetConnectionWritePolicyData, ThrowOnError>) => RequestResult<SetConnectionWritePolicyResponses, SetConnectionWritePolicyErrors, ThrowOnError>;
|
|
358
358
|
/**
|
|
@@ -456,7 +456,7 @@ export declare const listGraphMembers: <ThrowOnError extends boolean = false>(op
|
|
|
456
456
|
/**
|
|
457
457
|
* Add Graph Member
|
|
458
458
|
*
|
|
459
|
-
* Grant a member of the graph's organization access at a chosen role. Requires graph admin.
|
|
459
|
+
* Grant a member of the graph's organization access at a chosen role. Requires graph admin. Requires a signed-in session; API keys are not accepted.
|
|
460
460
|
*/
|
|
461
461
|
export declare const addGraphMember: <ThrowOnError extends boolean = false>(options: Options<AddGraphMemberData, ThrowOnError>) => RequestResult<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError>;
|
|
462
462
|
/**
|
|
@@ -468,7 +468,7 @@ export declare const removeGraphMember: <ThrowOnError extends boolean = false>(o
|
|
|
468
468
|
/**
|
|
469
469
|
* Update Graph Member Role
|
|
470
470
|
*
|
|
471
|
-
* Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
|
|
471
|
+
* Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles. Requires a signed-in session; API keys are not accepted.
|
|
472
472
|
*/
|
|
473
473
|
export declare const updateGraphMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMemberRoleData, ThrowOnError>) => RequestResult<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError>;
|
|
474
474
|
/**
|
|
@@ -523,6 +523,12 @@ export declare const changeSubscriptionPlan: <ThrowOnError extends boolean = fal
|
|
|
523
523
|
* For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning. Subscribes the caller by default; org owners and admins may subscribe another member of their organization by passing `user_id`. Billing is charged to the organization either way — repository access is per-user, so the subscriber determines who receives access.
|
|
524
524
|
*/
|
|
525
525
|
export declare const createRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => RequestResult<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError>;
|
|
526
|
+
/**
|
|
527
|
+
* End Repository Trial
|
|
528
|
+
*
|
|
529
|
+
* End your free trial of a shared repository now and start the paid plan. The first period is charged to the payment method on file; raw queries, the AI analyst and the plan's credits open once the payment clears, usually within a minute. Returns 400 when the subscription is not on a trial.
|
|
530
|
+
*/
|
|
531
|
+
export declare const endRepositorySubscriptionTrial: <ThrowOnError extends boolean = false>(options: Options<EndRepositorySubscriptionTrialData, ThrowOnError>) => RequestResult<EndRepositorySubscriptionTrialResponses, EndRepositorySubscriptionTrialErrors, ThrowOnError>;
|
|
526
532
|
/**
|
|
527
533
|
* Cancel Repository Subscription
|
|
528
534
|
*
|
|
@@ -904,7 +910,7 @@ export declare const updateEntity: <ThrowOnError extends boolean = false>(option
|
|
|
904
910
|
/**
|
|
905
911
|
* Change Reporting Style
|
|
906
912
|
*
|
|
907
|
-
* Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
|
|
913
|
+
* Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. A group's consolidation entity follows the parent's Style: changing the parent's changes both, and it cannot be set on its own. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
|
|
908
914
|
*
|
|
909
915
|
* **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.
|
|
910
916
|
*/
|
|
@@ -1104,7 +1110,7 @@ export declare const updateEventBlock: <ThrowOnError extends boolean = false>(op
|
|
|
1104
1110
|
/**
|
|
1105
1111
|
* Execute Event Block
|
|
1106
1112
|
*
|
|
1107
|
-
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains, or 'pending' on rejection (what landed is kept). Native-policy events fast-path through with no QB write — RoboSystems is the system of record.
|
|
1113
|
+
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains, or 'pending' on rejection (what landed is kept). Native-policy events fast-path through with no QB write — RoboSystems is the system of record. Only the group parent's books are QuickBooks': an event on a subsidiary's books is refused.
|
|
1108
1114
|
*
|
|
1109
1115
|
* **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.
|
|
1110
1116
|
*/
|
|
@@ -1464,7 +1470,7 @@ export declare const informationBlock: <ThrowOnError extends boolean = false>(op
|
|
|
1464
1470
|
/**
|
|
1465
1471
|
* Describe Filing
|
|
1466
1472
|
*
|
|
1467
|
-
* How one filing is laid out: entity, periods, statements and
|
|
1473
|
+
* How one filing is laid out: entity, periods, statements by role and notes by name, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits (`fiscal_year` is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
|
|
1468
1474
|
*
|
|
1469
1475
|
* **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.
|
|
1470
1476
|
*/
|
package/sdk.gen.js
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.revokeOrgInvitation = exports.createOrgInvitation = exports.listOrgInvitations = exports.updateOrgMemberRole = exports.removeOrgMember = exports.listOrgMembers = exports.listOrgGraphs = exports.updateOrg = exports.getOrg = exports.listUserOrgs = exports.revokeUserOAuthGrant = exports.listUserOAuthGrants = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.setSelectedGraph = exports.updateUserPassword = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getAuthProviders = exports.getCaptchaConfig = exports.regenerateMfaRecoveryCodes = exports.getMfaStatus = exports.verifyMfa = exports.getMfaOptions = exports.verifyPasskeyLogin = exports.getPasskeyLoginOptions = exports.deleteUserPasskey = exports.getPasskeyReauthOptions = exports.listUserPasskeys = exports.verifyPasskeyRegistration = exports.getPasskeyRegistrationOptions = exports.completeSsoAuth = exports.ssoTokenExchange = exports.generateSsoToken = exports.resetPassword = exports.validateResetToken = exports.forgotPassword = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.getInvitationPreview = exports.verifyEmail = exports.resendVerificationEmail = exports.refreshAuthSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
|
|
5
|
-
exports.
|
|
6
|
-
exports.
|
|
7
|
-
exports.
|
|
8
|
-
exports.deleteSecurity = exports.updateSecurity = exports.createSecurity = exports.deletePortfolioBlock = exports.updatePortfolioBlock = exports.createPortfolioBlock = exports.previewConsolidationEntries = exports.consolidationWorksheet = exports.liveFinancialStatement = exports.readText = exports.searchText = exports.describeFiling = exports.informationBlock = exports.disclosures = exports.financialStatementAnalysis = exports.buildFactGrid = exports.unblockSourceGraph = exports.blockSourceGraph = exports.removePublishListMember = exports.addPublishListMembers = exports.deletePublishList = exports.updatePublishList = exports.createPublishList = exports.revokeReportShare = exports.shareReport = exports.transitionFilingStatus = exports.fileReport = exports.deleteReport = exports.regenerateReport = exports.createReport = exports.terminateSchedule = void 0;
|
|
5
|
+
exports.getDocument = exports.listDocuments = exports.getDocumentSection = exports.searchDocuments = exports.listTables = exports.cancelRepositorySubscription = exports.endRepositorySubscriptionTrial = exports.createRepositorySubscription = exports.changeSubscriptionPlan = exports.getGraphSubscription = exports.getSubgraphInfo = exports.listSubgraphs = exports.getOperatorRun = exports.listOperatorRuns = exports.listOperatorThreads = exports.listGraphMutations = exports.updateGraphMemberRole = exports.removeGraphMember = exports.addGraphMember = exports.listGraphMembers = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.listCreditTransactions = exports.getCreditSummary = exports.exportGraphSchema = exports.getGraphSchema = exports.executeSql = exports.executeCypher = exports.getGraphUsage = exports.getGraphMetrics = exports.getBackupStats = exports.getBackupDownloadUrl = exports.listBackups = exports.executeSpecificOperator = exports.getOperatorMetadata = exports.autoSelectOperator = exports.listOperators = exports.setConnectionWritePolicy = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.oauthCallback = exports.initOAuth = exports.createConnection = exports.listConnections = exports.getConnectionOptions = exports.getOrgUsage = exports.getOrgLimits = exports.resendOrgInvitation = void 0;
|
|
6
|
+
exports.updateEntity = exports.createEntity = exports.initializeChartOfAccounts = exports.changeCalendarStart = exports.initializeLedger = exports.handleHttpPostExtensionsGraphIdGraphqlPost = exports.handleHttpGetExtensionsGraphIdGraphqlGet = exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.resumeOperation = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.validateSchema = exports.getGraphCapacity = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.getFile = exports.listFiles = exports.deleteFile = exports.ingestFile = exports.createFileUpload = exports.completeDocumentUpload = exports.createDocumentUpload = exports.deleteDocument = exports.indexDocument = exports.updateMemory = exports.forget = exports.remember = exports.materialize = exports.updateGraphMetadata = exports.changeTier = exports.createBackup = exports.deleteGraph = exports.deleteSubgraph = exports.createSubgraph = exports.recallMemory = exports.getMemory = exports.listMemories = exports.getDocumentFile = void 0;
|
|
7
|
+
exports.previewSchedule = exports.promoteObligations = exports.backfillPlanHistory = exports.reopenPeriod = exports.closePeriod = exports.setCloseTarget = exports.deleteJournalEntry = exports.updateJournalEntry = exports.recordDeconsolidation = exports.recordOwnershipChange = exports.recordAcquisition = exports.setAllocationOverride = exports.proposeConsolidationEntries = exports.recordOpeningBalance = exports.signOffReconciliation = exports.setReconciliationPolicy = exports.recordStatementBalance = exports.refreshReconciliations = exports.previewReconciliations = exports.resolveReconcilingItem = exports.previewReconcilingItem = exports.previewEventBlock = exports.updateEventHandler = exports.createEventHandler = exports.executeEventBlock = exports.updateEventBlock = exports.createEventBlock = exports.acceptSuggestions = exports.learnClassificationDefaults = exports.updateDimension = exports.createDimension = exports.updateAgent = exports.createAgent = exports.bindTextBlock = exports.computeForecast = exports.assertMetrics = exports.computeMetrics = exports.evaluateRules = exports.deleteInformationBlock = exports.updateInformationBlock = exports.createInformationBlock = exports.autoMapElements = exports.deleteMappingAssociation = exports.createMappingAssociation = exports.linkEntityTaxonomy = exports.deleteTaxonomyBlock = exports.updateTaxonomyBlock = exports.createTaxonomyBlock = exports.linkBankAccount = exports.changeReportingStyle = void 0;
|
|
8
|
+
exports.deleteSecurity = exports.updateSecurity = exports.createSecurity = exports.deletePortfolioBlock = exports.updatePortfolioBlock = exports.createPortfolioBlock = exports.previewConsolidationEntries = exports.consolidationWorksheet = exports.liveFinancialStatement = exports.readText = exports.searchText = exports.describeFiling = exports.informationBlock = exports.disclosures = exports.financialStatementAnalysis = exports.buildFactGrid = exports.unblockSourceGraph = exports.blockSourceGraph = exports.removePublishListMember = exports.addPublishListMembers = exports.deletePublishList = exports.updatePublishList = exports.createPublishList = exports.revokeReportShare = exports.shareReport = exports.transitionFilingStatus = exports.fileReport = exports.deleteReport = exports.regenerateReport = exports.createReport = exports.terminateSchedule = exports.rebuildSchedule = void 0;
|
|
9
9
|
const client_gen_1 = require("./client.gen");
|
|
10
10
|
/**
|
|
11
11
|
* Register New User
|
|
@@ -388,7 +388,7 @@ exports.listUserApiKeys = listUserApiKeys;
|
|
|
388
388
|
/**
|
|
389
389
|
* Create API Key
|
|
390
390
|
*
|
|
391
|
-
* The raw key value is only returned once at creation time and cannot be retrieved again.
|
|
391
|
+
* The raw key value is only returned once at creation time and cannot be retrieved again. Requires a signed-in session; API keys are not accepted.
|
|
392
392
|
*/
|
|
393
393
|
const createUserApiKey = (options) => (options.client ?? client_gen_1.client).post({
|
|
394
394
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -511,7 +511,7 @@ exports.removeOrgMember = removeOrgMember;
|
|
|
511
511
|
/**
|
|
512
512
|
* Update Member Role
|
|
513
513
|
*
|
|
514
|
-
* Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
|
|
514
|
+
* Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow. Requires a signed-in session; API keys are not accepted.
|
|
515
515
|
*/
|
|
516
516
|
const updateOrgMemberRole = (options) => (options.client ?? client_gen_1.client).put({
|
|
517
517
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -537,7 +537,7 @@ exports.listOrgInvitations = listOrgInvitations;
|
|
|
537
537
|
/**
|
|
538
538
|
* Invite Member
|
|
539
539
|
*
|
|
540
|
-
* Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.
|
|
540
|
+
* Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited. Requires a signed-in session; API keys are not accepted.
|
|
541
541
|
*/
|
|
542
542
|
const createOrgInvitation = (options) => (options.client ?? client_gen_1.client).post({
|
|
543
543
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -563,7 +563,7 @@ exports.revokeOrgInvitation = revokeOrgInvitation;
|
|
|
563
563
|
/**
|
|
564
564
|
* Resend Invitation
|
|
565
565
|
*
|
|
566
|
-
* Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
|
|
566
|
+
* Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email. Requires a signed-in session; API keys are not accepted.
|
|
567
567
|
*/
|
|
568
568
|
const resendOrgInvitation = (options) => (options.client ?? client_gen_1.client).post({
|
|
569
569
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -692,7 +692,7 @@ exports.syncConnection = syncConnection;
|
|
|
692
692
|
/**
|
|
693
693
|
* Set Connection Write Policy
|
|
694
694
|
*
|
|
695
|
-
* Choose how a live connection and RoboSystems share the books. 'qb_authoritative', the default, makes QuickBooks the book of record: RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'shadow' keeps QuickBooks the book of record and writes nothing to it: the close posts nothing locally either, its drafts become shadowed expectations compared with what QuickBooks holds, and its gates are recorded as findings. 'native' is not a choice here: it is what
|
|
695
|
+
* Choose how a live connection and RoboSystems share the books. 'qb_authoritative', the default, makes QuickBooks the book of record: RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'shadow' keeps QuickBooks the book of record and writes nothing to it: the close posts nothing locally either, its drafts become shadowed expectations compared with what QuickBooks holds, and its gates are recorded as findings. 'native' is not a choice here: it is what severing leaves, books kept in RoboSystems with no connection to write to. This is the explicit operator opt-in for writing to your books of record.
|
|
696
696
|
*/
|
|
697
697
|
const setConnectionWritePolicy = (options) => (options.client ?? client_gen_1.client).put({
|
|
698
698
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -916,7 +916,7 @@ exports.listGraphMembers = listGraphMembers;
|
|
|
916
916
|
/**
|
|
917
917
|
* Add Graph Member
|
|
918
918
|
*
|
|
919
|
-
* Grant a member of the graph's organization access at a chosen role. Requires graph admin.
|
|
919
|
+
* Grant a member of the graph's organization access at a chosen role. Requires graph admin. Requires a signed-in session; API keys are not accepted.
|
|
920
920
|
*/
|
|
921
921
|
const addGraphMember = (options) => (options.client ?? client_gen_1.client).post({
|
|
922
922
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -942,7 +942,7 @@ exports.removeGraphMember = removeGraphMember;
|
|
|
942
942
|
/**
|
|
943
943
|
* Update Graph Member Role
|
|
944
944
|
*
|
|
945
|
-
* Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
|
|
945
|
+
* Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles. Requires a signed-in session; API keys are not accepted.
|
|
946
946
|
*/
|
|
947
947
|
const updateGraphMemberRole = (options) => (options.client ?? client_gen_1.client).put({
|
|
948
948
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1059,6 +1059,17 @@ const createRepositorySubscription = (options) => (options.client ?? client_gen_
|
|
|
1059
1059
|
}
|
|
1060
1060
|
});
|
|
1061
1061
|
exports.createRepositorySubscription = createRepositorySubscription;
|
|
1062
|
+
/**
|
|
1063
|
+
* End Repository Trial
|
|
1064
|
+
*
|
|
1065
|
+
* End your free trial of a shared repository now and start the paid plan. The first period is charged to the payment method on file; raw queries, the AI analyst and the plan's credits open once the payment clears, usually within a minute. Returns 400 when the subscription is not on a trial.
|
|
1066
|
+
*/
|
|
1067
|
+
const endRepositorySubscriptionTrial = (options) => (options.client ?? client_gen_1.client).post({
|
|
1068
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1069
|
+
url: '/v1/graphs/{graph_id}/subscriptions/end-trial',
|
|
1070
|
+
...options
|
|
1071
|
+
});
|
|
1072
|
+
exports.endRepositorySubscriptionTrial = endRepositorySubscriptionTrial;
|
|
1062
1073
|
/**
|
|
1063
1074
|
* Cancel Repository Subscription
|
|
1064
1075
|
*
|
|
@@ -1840,7 +1851,7 @@ exports.updateEntity = updateEntity;
|
|
|
1840
1851
|
/**
|
|
1841
1852
|
* Change Reporting Style
|
|
1842
1853
|
*
|
|
1843
|
-
* Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
|
|
1854
|
+
* Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. A group's consolidation entity follows the parent's Style: changing the parent's changes both, and it cannot be set on its own. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
|
|
1844
1855
|
*
|
|
1845
1856
|
* **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.
|
|
1846
1857
|
*/
|
|
@@ -2265,7 +2276,7 @@ exports.updateEventBlock = updateEventBlock;
|
|
|
2265
2276
|
/**
|
|
2266
2277
|
* Execute Event Block
|
|
2267
2278
|
*
|
|
2268
|
-
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains, or 'pending' on rejection (what landed is kept). Native-policy events fast-path through with no QB write — RoboSystems is the system of record.
|
|
2279
|
+
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains, or 'pending' on rejection (what landed is kept). Native-policy events fast-path through with no QB write — RoboSystems is the system of record. Only the group parent's books are QuickBooks': an event on a subsidiary's books is refused.
|
|
2269
2280
|
*
|
|
2270
2281
|
* **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.
|
|
2271
2282
|
*/
|
|
@@ -3030,7 +3041,7 @@ exports.informationBlock = informationBlock;
|
|
|
3030
3041
|
/**
|
|
3031
3042
|
* Describe Filing
|
|
3032
3043
|
*
|
|
3033
|
-
* How one filing is laid out: entity, periods, statements and
|
|
3044
|
+
* How one filing is laid out: entity, periods, statements by role and notes by name, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits (`fiscal_year` is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
|
|
3034
3045
|
*
|
|
3035
3046
|
* **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.
|
|
3036
3047
|
*/
|
package/sdk.gen.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
4
4
|
import { client } from './client.gen';
|
|
5
|
-
import type { AcceptSuggestionsData, AcceptSuggestionsErrors, AcceptSuggestionsResponses, AddGraphMemberData, AddGraphMemberErrors, AddGraphMemberResponses, AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AssertMetricsData, AssertMetricsErrors, AssertMetricsResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BlockSourceGraphData, BlockSourceGraphErrors, BlockSourceGraphResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeCalendarStartData, ChangeCalendarStartErrors, ChangeCalendarStartResponses, ChangeReportingStyleData, ChangeReportingStyleErrors, ChangeReportingStyleResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, ChangeTierData, ChangeTierErrors, ChangeTierResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, ClosePeriodData, ClosePeriodErrors, ClosePeriodResponses, CompleteDocumentUploadData, CompleteDocumentUploadErrors, CompleteDocumentUploadResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, ComputeForecastData, ComputeForecastErrors, ComputeForecastResponses, ComputeMetricsData, ComputeMetricsErrors, ComputeMetricsResponses, ConsolidationWorksheetData, ConsolidationWorksheetErrors, ConsolidationWorksheetResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateDimensionData, CreateDimensionErrors, CreateDimensionResponses, CreateDocumentUploadData, CreateDocumentUploadErrors, CreateDocumentUploadResponses, CreateEntityData, CreateEntityErrors, CreateEntityResponses, CreateEventBlockData, CreateEventBlockErrors, CreateEventBlockResponses, CreateEventHandlerData, CreateEventHandlerErrors, CreateEventHandlerResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateInformationBlockData, CreateInformationBlockErrors, CreateInformationBlockResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreateOrgInvitationData, CreateOrgInvitationErrors, CreateOrgInvitationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioBlockData, CreatePortfolioBlockErrors, CreatePortfolioBlockResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyBlockData, CreateTaxonomyBlockErrors, CreateTaxonomyBlockResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteGraphData, DeleteGraphErrors, DeleteGraphResponses, DeleteInformationBlockData, DeleteInformationBlockErrors, DeleteInformationBlockResponses, DeleteJournalEntryData, DeleteJournalEntryErrors, DeleteJournalEntryResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioBlockData, DeletePortfolioBlockErrors, DeletePortfolioBlockResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, DeleteTaxonomyBlockData, DeleteTaxonomyBlockErrors, DeleteTaxonomyBlockResponses, DeleteUserPasskeyData, DeleteUserPasskeyErrors, DeleteUserPasskeyResponses, DescribeFilingData, DescribeFilingErrors, DescribeFilingResponses, DisclosuresData, DisclosuresErrors, DisclosuresResponses, EvaluateRulesData, EvaluateRulesErrors, EvaluateRulesResponses, ExecuteCypherData, ExecuteCypherErrors, ExecuteCypherResponses, ExecuteEventBlockData, ExecuteEventBlockErrors, ExecuteEventBlockResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, FileReportData, FileReportErrors, FileReportResponses, FinancialStatementAnalysisData, FinancialStatementAnalysisErrors, FinancialStatementAnalysisResponses, ForgetData, ForgetErrors, ForgetResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAuthProvidersData, GetAuthProvidersErrors, GetAuthProvidersResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentFileData, GetDocumentFileErrors, GetDocumentFileResponses, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageData, GetGraphUsageErrors, GetGraphUsageResponses, GetInvitationPreviewData, GetInvitationPreviewErrors, GetInvitationPreviewResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetMfaOptionsData, GetMfaOptionsErrors, GetMfaOptionsResponses, GetMfaStatusData, GetMfaStatusErrors, GetMfaStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOperatorRunData, GetOperatorRunErrors, GetOperatorRunResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasskeyLoginOptionsData, GetPasskeyLoginOptionsErrors, GetPasskeyLoginOptionsResponses, GetPasskeyReauthOptionsData, GetPasskeyReauthOptionsErrors, GetPasskeyReauthOptionsResponses, GetPasskeyRegistrationOptionsData, GetPasskeyRegistrationOptionsErrors, GetPasskeyRegistrationOptionsResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, InformationBlockData, InformationBlockErrors, InformationBlockResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeChartOfAccountsData, InitializeChartOfAccountsErrors, InitializeChartOfAccountsResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, LearnClassificationDefaultsData, LearnClassificationDefaultsErrors, LearnClassificationDefaultsResponses, LinkBankAccountData, LinkBankAccountErrors, LinkBankAccountResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListGraphMembersData, ListGraphMembersErrors, ListGraphMembersResponses, ListGraphMutationsData, ListGraphMutationsErrors, ListGraphMutationsResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorRunsData, ListOperatorRunsErrors, ListOperatorRunsResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOperatorThreadsData, ListOperatorThreadsErrors, ListOperatorThreadsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvitationsData, ListOrgInvitationsErrors, ListOrgInvitationsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOAuthGrantsData, ListUserOAuthGrantsErrors, ListUserOAuthGrantsResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, ListUserPasskeysData, ListUserPasskeysErrors, ListUserPasskeysResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewConsolidationEntriesData, PreviewConsolidationEntriesErrors, PreviewConsolidationEntriesResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PreviewReconciliationsData, PreviewReconciliationsErrors, PreviewReconciliationsResponses, PreviewReconcilingItemData, PreviewReconcilingItemErrors, PreviewReconcilingItemResponses, PreviewScheduleData, PreviewScheduleErrors, PreviewScheduleResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, ProposeConsolidationEntriesData, ProposeConsolidationEntriesErrors, ProposeConsolidationEntriesResponses, ReadTextData, ReadTextErrors, ReadTextResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RecordAcquisitionData, RecordAcquisitionErrors, RecordAcquisitionResponses, RecordDeconsolidationData, RecordDeconsolidationErrors, RecordDeconsolidationResponses, RecordOpeningBalanceData, RecordOpeningBalanceErrors, RecordOpeningBalanceResponses, RecordOwnershipChangeData, RecordOwnershipChangeErrors, RecordOwnershipChangeResponses, RecordStatementBalanceData, RecordStatementBalanceErrors, RecordStatementBalanceResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RefreshReconciliationsData, RefreshReconciliationsErrors, RefreshReconciliationsResponses, RegenerateMfaRecoveryCodesData, RegenerateMfaRecoveryCodesErrors, RegenerateMfaRecoveryCodesResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveGraphMemberData, RemoveGraphMemberErrors, RemoveGraphMemberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendOrgInvitationData, ResendOrgInvitationErrors, ResendOrgInvitationResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, ResolveReconcilingItemData, ResolveReconcilingItemErrors, ResolveReconcilingItemResponses, ResumeOperationData, ResumeOperationErrors, ResumeOperationResponses, RevokeOrgInvitationData, RevokeOrgInvitationErrors, RevokeOrgInvitationResponses, RevokeReportShareData, RevokeReportShareErrors, RevokeReportShareResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, RevokeUserOAuthGrantData, RevokeUserOAuthGrantErrors, RevokeUserOAuthGrantResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SearchTextData, SearchTextErrors, SearchTextResponses, SetAllocationOverrideData, SetAllocationOverrideErrors, SetAllocationOverrideResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, SetReconciliationPolicyData, SetReconciliationPolicyErrors, SetReconciliationPolicyResponses, SetSelectedGraphData, SetSelectedGraphErrors, SetSelectedGraphResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SignOffReconciliationData, SignOffReconciliationErrors, SignOffReconciliationResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TerminateScheduleData, TerminateScheduleErrors, TerminateScheduleResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UnblockSourceGraphData, UnblockSourceGraphErrors, UnblockSourceGraphResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateDimensionData, UpdateDimensionErrors, UpdateDimensionResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateGraphMemberRoleData, UpdateGraphMemberRoleErrors, UpdateGraphMemberRoleResponses, UpdateGraphMetadataData, UpdateGraphMetadataErrors, UpdateGraphMetadataResponses, UpdateInformationBlockData, UpdateInformationBlockErrors, UpdateInformationBlockResponses, UpdateJournalEntryData, UpdateJournalEntryErrors, UpdateJournalEntryResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioBlockData, UpdatePortfolioBlockErrors, UpdatePortfolioBlockResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateTaxonomyBlockData, UpdateTaxonomyBlockErrors, UpdateTaxonomyBlockResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses, VerifyMfaData, VerifyMfaErrors, VerifyMfaResponses, VerifyPasskeyLoginData, VerifyPasskeyLoginErrors, VerifyPasskeyLoginResponses, VerifyPasskeyRegistrationData, VerifyPasskeyRegistrationErrors, VerifyPasskeyRegistrationResponses } from './types.gen';
|
|
5
|
+
import type { AcceptSuggestionsData, AcceptSuggestionsErrors, AcceptSuggestionsResponses, AddGraphMemberData, AddGraphMemberErrors, AddGraphMemberResponses, AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AssertMetricsData, AssertMetricsErrors, AssertMetricsResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BlockSourceGraphData, BlockSourceGraphErrors, BlockSourceGraphResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeCalendarStartData, ChangeCalendarStartErrors, ChangeCalendarStartResponses, ChangeReportingStyleData, ChangeReportingStyleErrors, ChangeReportingStyleResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, ChangeTierData, ChangeTierErrors, ChangeTierResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, ClosePeriodData, ClosePeriodErrors, ClosePeriodResponses, CompleteDocumentUploadData, CompleteDocumentUploadErrors, CompleteDocumentUploadResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, ComputeForecastData, ComputeForecastErrors, ComputeForecastResponses, ComputeMetricsData, ComputeMetricsErrors, ComputeMetricsResponses, ConsolidationWorksheetData, ConsolidationWorksheetErrors, ConsolidationWorksheetResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateDimensionData, CreateDimensionErrors, CreateDimensionResponses, CreateDocumentUploadData, CreateDocumentUploadErrors, CreateDocumentUploadResponses, CreateEntityData, CreateEntityErrors, CreateEntityResponses, CreateEventBlockData, CreateEventBlockErrors, CreateEventBlockResponses, CreateEventHandlerData, CreateEventHandlerErrors, CreateEventHandlerResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateInformationBlockData, CreateInformationBlockErrors, CreateInformationBlockResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreateOrgInvitationData, CreateOrgInvitationErrors, CreateOrgInvitationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioBlockData, CreatePortfolioBlockErrors, CreatePortfolioBlockResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyBlockData, CreateTaxonomyBlockErrors, CreateTaxonomyBlockResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteGraphData, DeleteGraphErrors, DeleteGraphResponses, DeleteInformationBlockData, DeleteInformationBlockErrors, DeleteInformationBlockResponses, DeleteJournalEntryData, DeleteJournalEntryErrors, DeleteJournalEntryResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioBlockData, DeletePortfolioBlockErrors, DeletePortfolioBlockResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, DeleteTaxonomyBlockData, DeleteTaxonomyBlockErrors, DeleteTaxonomyBlockResponses, DeleteUserPasskeyData, DeleteUserPasskeyErrors, DeleteUserPasskeyResponses, DescribeFilingData, DescribeFilingErrors, DescribeFilingResponses, DisclosuresData, DisclosuresErrors, DisclosuresResponses, EndRepositorySubscriptionTrialData, EndRepositorySubscriptionTrialErrors, EndRepositorySubscriptionTrialResponses, EvaluateRulesData, EvaluateRulesErrors, EvaluateRulesResponses, ExecuteCypherData, ExecuteCypherErrors, ExecuteCypherResponses, ExecuteEventBlockData, ExecuteEventBlockErrors, ExecuteEventBlockResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, FileReportData, FileReportErrors, FileReportResponses, FinancialStatementAnalysisData, FinancialStatementAnalysisErrors, FinancialStatementAnalysisResponses, ForgetData, ForgetErrors, ForgetResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAuthProvidersData, GetAuthProvidersErrors, GetAuthProvidersResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentFileData, GetDocumentFileErrors, GetDocumentFileResponses, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageData, GetGraphUsageErrors, GetGraphUsageResponses, GetInvitationPreviewData, GetInvitationPreviewErrors, GetInvitationPreviewResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetMfaOptionsData, GetMfaOptionsErrors, GetMfaOptionsResponses, GetMfaStatusData, GetMfaStatusErrors, GetMfaStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOperatorRunData, GetOperatorRunErrors, GetOperatorRunResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasskeyLoginOptionsData, GetPasskeyLoginOptionsErrors, GetPasskeyLoginOptionsResponses, GetPasskeyReauthOptionsData, GetPasskeyReauthOptionsErrors, GetPasskeyReauthOptionsResponses, GetPasskeyRegistrationOptionsData, GetPasskeyRegistrationOptionsErrors, GetPasskeyRegistrationOptionsResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, InformationBlockData, InformationBlockErrors, InformationBlockResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeChartOfAccountsData, InitializeChartOfAccountsErrors, InitializeChartOfAccountsResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, LearnClassificationDefaultsData, LearnClassificationDefaultsErrors, LearnClassificationDefaultsResponses, LinkBankAccountData, LinkBankAccountErrors, LinkBankAccountResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListGraphMembersData, ListGraphMembersErrors, ListGraphMembersResponses, ListGraphMutationsData, ListGraphMutationsErrors, ListGraphMutationsResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorRunsData, ListOperatorRunsErrors, ListOperatorRunsResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOperatorThreadsData, ListOperatorThreadsErrors, ListOperatorThreadsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvitationsData, ListOrgInvitationsErrors, ListOrgInvitationsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOAuthGrantsData, ListUserOAuthGrantsErrors, ListUserOAuthGrantsResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, ListUserPasskeysData, ListUserPasskeysErrors, ListUserPasskeysResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewConsolidationEntriesData, PreviewConsolidationEntriesErrors, PreviewConsolidationEntriesResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PreviewReconciliationsData, PreviewReconciliationsErrors, PreviewReconciliationsResponses, PreviewReconcilingItemData, PreviewReconcilingItemErrors, PreviewReconcilingItemResponses, PreviewScheduleData, PreviewScheduleErrors, PreviewScheduleResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, ProposeConsolidationEntriesData, ProposeConsolidationEntriesErrors, ProposeConsolidationEntriesResponses, ReadTextData, ReadTextErrors, ReadTextResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RecordAcquisitionData, RecordAcquisitionErrors, RecordAcquisitionResponses, RecordDeconsolidationData, RecordDeconsolidationErrors, RecordDeconsolidationResponses, RecordOpeningBalanceData, RecordOpeningBalanceErrors, RecordOpeningBalanceResponses, RecordOwnershipChangeData, RecordOwnershipChangeErrors, RecordOwnershipChangeResponses, RecordStatementBalanceData, RecordStatementBalanceErrors, RecordStatementBalanceResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RefreshReconciliationsData, RefreshReconciliationsErrors, RefreshReconciliationsResponses, RegenerateMfaRecoveryCodesData, RegenerateMfaRecoveryCodesErrors, RegenerateMfaRecoveryCodesResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveGraphMemberData, RemoveGraphMemberErrors, RemoveGraphMemberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendOrgInvitationData, ResendOrgInvitationErrors, ResendOrgInvitationResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, ResolveReconcilingItemData, ResolveReconcilingItemErrors, ResolveReconcilingItemResponses, ResumeOperationData, ResumeOperationErrors, ResumeOperationResponses, RevokeOrgInvitationData, RevokeOrgInvitationErrors, RevokeOrgInvitationResponses, RevokeReportShareData, RevokeReportShareErrors, RevokeReportShareResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, RevokeUserOAuthGrantData, RevokeUserOAuthGrantErrors, RevokeUserOAuthGrantResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SearchTextData, SearchTextErrors, SearchTextResponses, SetAllocationOverrideData, SetAllocationOverrideErrors, SetAllocationOverrideResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, SetReconciliationPolicyData, SetReconciliationPolicyErrors, SetReconciliationPolicyResponses, SetSelectedGraphData, SetSelectedGraphErrors, SetSelectedGraphResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SignOffReconciliationData, SignOffReconciliationErrors, SignOffReconciliationResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TerminateScheduleData, TerminateScheduleErrors, TerminateScheduleResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UnblockSourceGraphData, UnblockSourceGraphErrors, UnblockSourceGraphResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateDimensionData, UpdateDimensionErrors, UpdateDimensionResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateGraphMemberRoleData, UpdateGraphMemberRoleErrors, UpdateGraphMemberRoleResponses, UpdateGraphMetadataData, UpdateGraphMetadataErrors, UpdateGraphMetadataResponses, UpdateInformationBlockData, UpdateInformationBlockErrors, UpdateInformationBlockResponses, UpdateJournalEntryData, UpdateJournalEntryErrors, UpdateJournalEntryResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioBlockData, UpdatePortfolioBlockErrors, UpdatePortfolioBlockResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateTaxonomyBlockData, UpdateTaxonomyBlockErrors, UpdateTaxonomyBlockResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses, VerifyMfaData, VerifyMfaErrors, VerifyMfaResponses, VerifyPasskeyLoginData, VerifyPasskeyLoginErrors, VerifyPasskeyLoginResponses, VerifyPasskeyRegistrationData, VerifyPasskeyRegistrationErrors, VerifyPasskeyRegistrationResponses } from './types.gen';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
8
8
|
/**
|
|
@@ -399,7 +399,7 @@ export const listUserApiKeys = <ThrowOnError extends boolean = false>(options?:
|
|
|
399
399
|
/**
|
|
400
400
|
* Create API Key
|
|
401
401
|
*
|
|
402
|
-
* The raw key value is only returned once at creation time and cannot be retrieved again.
|
|
402
|
+
* The raw key value is only returned once at creation time and cannot be retrieved again. Requires a signed-in session; API keys are not accepted.
|
|
403
403
|
*/
|
|
404
404
|
export const createUserApiKey = <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>): RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError> => (options.client ?? client).post<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>({
|
|
405
405
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -522,7 +522,7 @@ export const removeOrgMember = <ThrowOnError extends boolean = false>(options: O
|
|
|
522
522
|
/**
|
|
523
523
|
* Update Member Role
|
|
524
524
|
*
|
|
525
|
-
* Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
|
|
525
|
+
* Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow. Requires a signed-in session; API keys are not accepted.
|
|
526
526
|
*/
|
|
527
527
|
export const updateOrgMemberRole = <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>): RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError> => (options.client ?? client).put<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError>({
|
|
528
528
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -548,7 +548,7 @@ export const listOrgInvitations = <ThrowOnError extends boolean = false>(options
|
|
|
548
548
|
/**
|
|
549
549
|
* Invite Member
|
|
550
550
|
*
|
|
551
|
-
* Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.
|
|
551
|
+
* Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited. Requires a signed-in session; API keys are not accepted.
|
|
552
552
|
*/
|
|
553
553
|
export const createOrgInvitation = <ThrowOnError extends boolean = false>(options: Options<CreateOrgInvitationData, ThrowOnError>): RequestResult<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError> => (options.client ?? client).post<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError>({
|
|
554
554
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -574,7 +574,7 @@ export const revokeOrgInvitation = <ThrowOnError extends boolean = false>(option
|
|
|
574
574
|
/**
|
|
575
575
|
* Resend Invitation
|
|
576
576
|
*
|
|
577
|
-
* Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
|
|
577
|
+
* Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email. Requires a signed-in session; API keys are not accepted.
|
|
578
578
|
*/
|
|
579
579
|
export const resendOrgInvitation = <ThrowOnError extends boolean = false>(options: Options<ResendOrgInvitationData, ThrowOnError>): RequestResult<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError> => (options.client ?? client).post<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError>({
|
|
580
580
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -703,7 +703,7 @@ export const syncConnection = <ThrowOnError extends boolean = false>(options: Op
|
|
|
703
703
|
/**
|
|
704
704
|
* Set Connection Write Policy
|
|
705
705
|
*
|
|
706
|
-
* Choose how a live connection and RoboSystems share the books. 'qb_authoritative', the default, makes QuickBooks the book of record: RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'shadow' keeps QuickBooks the book of record and writes nothing to it: the close posts nothing locally either, its drafts become shadowed expectations compared with what QuickBooks holds, and its gates are recorded as findings. 'native' is not a choice here: it is what
|
|
706
|
+
* Choose how a live connection and RoboSystems share the books. 'qb_authoritative', the default, makes QuickBooks the book of record: RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'shadow' keeps QuickBooks the book of record and writes nothing to it: the close posts nothing locally either, its drafts become shadowed expectations compared with what QuickBooks holds, and its gates are recorded as findings. 'native' is not a choice here: it is what severing leaves, books kept in RoboSystems with no connection to write to. This is the explicit operator opt-in for writing to your books of record.
|
|
707
707
|
*/
|
|
708
708
|
export const setConnectionWritePolicy = <ThrowOnError extends boolean = false>(options: Options<SetConnectionWritePolicyData, ThrowOnError>): RequestResult<SetConnectionWritePolicyResponses, SetConnectionWritePolicyErrors, ThrowOnError> => (options.client ?? client).put<SetConnectionWritePolicyResponses, SetConnectionWritePolicyErrors, ThrowOnError>({
|
|
709
709
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -927,7 +927,7 @@ export const listGraphMembers = <ThrowOnError extends boolean = false>(options:
|
|
|
927
927
|
/**
|
|
928
928
|
* Add Graph Member
|
|
929
929
|
*
|
|
930
|
-
* Grant a member of the graph's organization access at a chosen role. Requires graph admin.
|
|
930
|
+
* Grant a member of the graph's organization access at a chosen role. Requires graph admin. Requires a signed-in session; API keys are not accepted.
|
|
931
931
|
*/
|
|
932
932
|
export const addGraphMember = <ThrowOnError extends boolean = false>(options: Options<AddGraphMemberData, ThrowOnError>): RequestResult<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError> => (options.client ?? client).post<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError>({
|
|
933
933
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -953,7 +953,7 @@ export const removeGraphMember = <ThrowOnError extends boolean = false>(options:
|
|
|
953
953
|
/**
|
|
954
954
|
* Update Graph Member Role
|
|
955
955
|
*
|
|
956
|
-
* Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
|
|
956
|
+
* Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles. Requires a signed-in session; API keys are not accepted.
|
|
957
957
|
*/
|
|
958
958
|
export const updateGraphMemberRole = <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMemberRoleData, ThrowOnError>): RequestResult<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError> => (options.client ?? client).put<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError>({
|
|
959
959
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1070,6 +1070,17 @@ export const createRepositorySubscription = <ThrowOnError extends boolean = fals
|
|
|
1070
1070
|
}
|
|
1071
1071
|
});
|
|
1072
1072
|
|
|
1073
|
+
/**
|
|
1074
|
+
* End Repository Trial
|
|
1075
|
+
*
|
|
1076
|
+
* End your free trial of a shared repository now and start the paid plan. The first period is charged to the payment method on file; raw queries, the AI analyst and the plan's credits open once the payment clears, usually within a minute. Returns 400 when the subscription is not on a trial.
|
|
1077
|
+
*/
|
|
1078
|
+
export const endRepositorySubscriptionTrial = <ThrowOnError extends boolean = false>(options: Options<EndRepositorySubscriptionTrialData, ThrowOnError>): RequestResult<EndRepositorySubscriptionTrialResponses, EndRepositorySubscriptionTrialErrors, ThrowOnError> => (options.client ?? client).post<EndRepositorySubscriptionTrialResponses, EndRepositorySubscriptionTrialErrors, ThrowOnError>({
|
|
1079
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1080
|
+
url: '/v1/graphs/{graph_id}/subscriptions/end-trial',
|
|
1081
|
+
...options
|
|
1082
|
+
});
|
|
1083
|
+
|
|
1073
1084
|
/**
|
|
1074
1085
|
* Cancel Repository Subscription
|
|
1075
1086
|
*
|
|
@@ -1851,7 +1862,7 @@ export const updateEntity = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1851
1862
|
/**
|
|
1852
1863
|
* Change Reporting Style
|
|
1853
1864
|
*
|
|
1854
|
-
* Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
|
|
1865
|
+
* Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. A group's consolidation entity follows the parent's Style: changing the parent's changes both, and it cannot be set on its own. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
|
|
1855
1866
|
*
|
|
1856
1867
|
* **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.
|
|
1857
1868
|
*/
|
|
@@ -2276,7 +2287,7 @@ export const updateEventBlock = <ThrowOnError extends boolean = false>(options:
|
|
|
2276
2287
|
/**
|
|
2277
2288
|
* Execute Event Block
|
|
2278
2289
|
*
|
|
2279
|
-
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains, or 'pending' on rejection (what landed is kept). Native-policy events fast-path through with no QB write — RoboSystems is the system of record.
|
|
2290
|
+
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains, or 'pending' on rejection (what landed is kept). Native-policy events fast-path through with no QB write — RoboSystems is the system of record. Only the group parent's books are QuickBooks': an event on a subsidiary's books is refused.
|
|
2280
2291
|
*
|
|
2281
2292
|
* **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
2293
|
*/
|
|
@@ -3041,7 +3052,7 @@ export const informationBlock = <ThrowOnError extends boolean = false>(options:
|
|
|
3041
3052
|
/**
|
|
3042
3053
|
* Describe Filing
|
|
3043
3054
|
*
|
|
3044
|
-
* How one filing is laid out: entity, periods, statements and
|
|
3055
|
+
* How one filing is laid out: entity, periods, statements by role and notes by name, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits (`fiscal_year` is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
|
|
3045
3056
|
*
|
|
3046
3057
|
* **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.
|
|
3047
3058
|
*/
|