@robosystems/client 1.13.2 → 1.14.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/artifacts/LedgerClient.d.ts +26 -1
- package/artifacts/LedgerClient.js +27 -1
- package/artifacts/LedgerClient.ts +53 -1
- package/artifacts/OperatorClient.js +2 -2
- package/artifacts/OperatorClient.ts +3 -2
- package/artifacts/QueryClient.js +1 -1
- package/artifacts/QueryClient.ts +1 -1
- package/artifacts/SSEClient.js +1 -1
- package/artifacts/SSEClient.ts +2 -1
- package/artifacts/graphql/client.js +1 -1
- package/artifacts/graphql/client.ts +2 -1
- package/artifacts/graphql/generated/graphql.d.ts +312 -2526
- package/artifacts/graphql/generated/graphql.js +173 -2
- package/artifacts/graphql/generated/graphql.ts +493 -2658
- package/artifacts/graphql/queries/ledger/journalEntries.d.ts +14 -0
- package/artifacts/graphql/queries/ledger/journalEntries.js +75 -0
- package/artifacts/graphql/queries/ledger/journalEntries.ts +73 -0
- package/client/index.d.ts +2 -0
- package/client/index.ts +2 -0
- package/client/utils.gen.d.ts +1 -1
- package/client/utils.gen.ts +2 -2
- package/client.gen.d.ts +2 -2
- package/client.gen.ts +2 -2
- package/core/auth.gen.d.ts +7 -0
- package/core/auth.gen.ts +7 -0
- package/core/params.gen.d.ts +2 -2
- package/core/params.gen.js +21 -13
- package/core/params.gen.ts +21 -12
- package/core/pathSerializer.gen.ts +6 -6
- package/core/queryKeySerializer.gen.d.ts +1 -1
- package/core/queryKeySerializer.gen.ts +1 -1
- package/core/types.gen.d.ts +5 -0
- package/core/types.gen.ts +6 -0
- package/core/utils.gen.ts +4 -4
- package/package.json +11 -8
- package/sdk/client/index.d.ts +2 -0
- package/sdk/client/index.ts +2 -0
- package/sdk/client/utils.gen.d.ts +1 -1
- package/sdk/client/utils.gen.ts +2 -2
- package/sdk/client.gen.d.ts +2 -2
- package/sdk/client.gen.ts +2 -2
- package/sdk/core/auth.gen.d.ts +7 -0
- package/sdk/core/auth.gen.ts +7 -0
- package/sdk/core/params.gen.d.ts +2 -2
- package/sdk/core/params.gen.js +21 -13
- package/sdk/core/params.gen.ts +21 -12
- package/sdk/core/pathSerializer.gen.ts +6 -6
- package/sdk/core/queryKeySerializer.gen.d.ts +1 -1
- package/sdk/core/queryKeySerializer.gen.ts +1 -1
- package/sdk/core/types.gen.d.ts +5 -0
- package/sdk/core/types.gen.ts +6 -0
- package/sdk/core/utils.gen.ts +4 -4
- package/sdk/sdk.gen.d.ts +199 -199
- package/sdk/sdk.gen.ts +199 -199
- package/sdk/types.gen.d.ts +35 -2
- package/sdk/types.gen.ts +35 -2
- package/sdk.gen.d.ts +199 -199
- package/sdk.gen.ts +199 -199
- package/types.gen.d.ts +35 -2
- package/types.gen.ts +35 -2
package/sdk/sdk.gen.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Client, Options as Options2, TDataShape } from './client';
|
|
1
|
+
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
2
2
|
import type { AddGraphMemberData, AddGraphMemberErrors, AddGraphMemberResponses, AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AssertMetricsData, AssertMetricsErrors, AssertMetricsResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BlockSourceGraphData, BlockSourceGraphErrors, BlockSourceGraphResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeReportingStyleData, ChangeReportingStyleErrors, ChangeReportingStyleResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, ChangeTierData, ChangeTierErrors, ChangeTierResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, ClosePeriodData, ClosePeriodErrors, ClosePeriodResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, ComputeForecastData, ComputeForecastErrors, ComputeForecastResponses, ComputeMetricsData, ComputeMetricsErrors, ComputeMetricsResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateEventBlockData, CreateEventBlockErrors, CreateEventBlockResponses, CreateEventHandlerData, CreateEventHandlerErrors, CreateEventHandlerResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateInformationBlockData, CreateInformationBlockErrors, CreateInformationBlockResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreateOrgInvitationData, CreateOrgInvitationErrors, CreateOrgInvitationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioBlockData, CreatePortfolioBlockErrors, CreatePortfolioBlockResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyBlockData, CreateTaxonomyBlockErrors, CreateTaxonomyBlockResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteGraphData, DeleteGraphErrors, DeleteGraphResponses, DeleteInformationBlockData, DeleteInformationBlockErrors, DeleteInformationBlockResponses, DeleteJournalEntryData, DeleteJournalEntryErrors, DeleteJournalEntryResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioBlockData, DeletePortfolioBlockErrors, DeletePortfolioBlockResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, DeleteTaxonomyBlockData, DeleteTaxonomyBlockErrors, DeleteTaxonomyBlockResponses, DeleteUserPasskeyData, DeleteUserPasskeyErrors, DeleteUserPasskeyResponses, EvaluateRulesData, EvaluateRulesErrors, EvaluateRulesResponses, ExecuteCypherData, ExecuteCypherErrors, ExecuteCypherResponses, ExecuteEventBlockData, ExecuteEventBlockErrors, ExecuteEventBlockResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, FileReportData, FileReportErrors, FileReportResponses, FinancialStatementAnalysisData, FinancialStatementAnalysisErrors, FinancialStatementAnalysisResponses, ForgetData, ForgetErrors, ForgetResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAuthProvidersData, GetAuthProvidersErrors, GetAuthProvidersResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageData, GetGraphUsageErrors, GetGraphUsageResponses, GetInvitationPreviewData, GetInvitationPreviewErrors, GetInvitationPreviewResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetMfaOptionsData, GetMfaOptionsErrors, GetMfaOptionsResponses, GetMfaStatusData, GetMfaStatusErrors, GetMfaStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasskeyLoginOptionsData, GetPasskeyLoginOptionsErrors, GetPasskeyLoginOptionsResponses, GetPasskeyReauthOptionsData, GetPasskeyReauthOptionsErrors, GetPasskeyReauthOptionsResponses, GetPasskeyRegistrationOptionsData, GetPasskeyRegistrationOptionsErrors, GetPasskeyRegistrationOptionsResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListGraphMembersData, ListGraphMembersErrors, ListGraphMembersResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvitationsData, ListOrgInvitationsErrors, ListOrgInvitationsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOAuthGrantsData, ListUserOAuthGrantsErrors, ListUserOAuthGrantsResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, ListUserPasskeysData, ListUserPasskeysErrors, ListUserPasskeysResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PreviewReconcilingItemData, PreviewReconcilingItemErrors, PreviewReconcilingItemResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegenerateMfaRecoveryCodesData, RegenerateMfaRecoveryCodesErrors, RegenerateMfaRecoveryCodesResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveGraphMemberData, RemoveGraphMemberErrors, RemoveGraphMemberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendOrgInvitationData, ResendOrgInvitationErrors, ResendOrgInvitationResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, ResolveReconcilingItemData, ResolveReconcilingItemErrors, ResolveReconcilingItemResponses, ResumeOperationData, ResumeOperationErrors, ResumeOperationResponses, RevokeOrgInvitationData, RevokeOrgInvitationErrors, RevokeOrgInvitationResponses, RevokeReportShareData, RevokeReportShareErrors, RevokeReportShareResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, RevokeUserOAuthGrantData, RevokeUserOAuthGrantErrors, RevokeUserOAuthGrantResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TerminateScheduleData, TerminateScheduleErrors, TerminateScheduleResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UnblockSourceGraphData, UnblockSourceGraphErrors, UnblockSourceGraphResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateGraphMemberRoleData, UpdateGraphMemberRoleErrors, UpdateGraphMemberRoleResponses, UpdateGraphMetadataData, UpdateGraphMetadataErrors, UpdateGraphMetadataResponses, UpdateInformationBlockData, UpdateInformationBlockErrors, UpdateInformationBlockResponses, UpdateJournalEntryData, UpdateJournalEntryErrors, UpdateJournalEntryResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioBlockData, UpdatePortfolioBlockErrors, UpdatePortfolioBlockResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateTaxonomyBlockData, UpdateTaxonomyBlockErrors, UpdateTaxonomyBlockResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses, VerifyMfaData, VerifyMfaErrors, VerifyMfaResponses, VerifyPasskeyLoginData, VerifyPasskeyLoginErrors, VerifyPasskeyLoginResponses, VerifyPasskeyRegistrationData, VerifyPasskeyRegistrationErrors, VerifyPasskeyRegistrationResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
@@ -11,532 +11,532 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
11
11
|
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
12
|
* used to access values that aren't defined as part of the SDK function.
|
|
13
13
|
*/
|
|
14
|
-
meta?: Record<string, unknown
|
|
14
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
17
|
* Register New User
|
|
18
18
|
*
|
|
19
19
|
* Creates the user and a personal organization. CAPTCHA required in production. Sends verification email when email verification is enabled.
|
|
20
20
|
*/
|
|
21
|
-
export declare const registerUser: <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) =>
|
|
21
|
+
export declare const registerUser: <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => RequestResult<RegisterUserResponses, RegisterUserErrors, ThrowOnError>;
|
|
22
22
|
/**
|
|
23
23
|
* User Login
|
|
24
24
|
*
|
|
25
25
|
* Returns a JWT token on success. IP-based progressive delays apply after repeated failures.
|
|
26
26
|
*/
|
|
27
|
-
export declare const loginUser: <ThrowOnError extends boolean = false>(options: Options<LoginUserData, ThrowOnError>) =>
|
|
27
|
+
export declare const loginUser: <ThrowOnError extends boolean = false>(options: Options<LoginUserData, ThrowOnError>) => RequestResult<LoginUserResponses, LoginUserErrors, ThrowOnError>;
|
|
28
28
|
/**
|
|
29
29
|
* User Logout
|
|
30
30
|
*/
|
|
31
|
-
export declare const logoutUser: <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) =>
|
|
31
|
+
export declare const logoutUser: <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => RequestResult<LogoutUserResponses, LogoutUserErrors, ThrowOnError>;
|
|
32
32
|
/**
|
|
33
33
|
* Get Current User
|
|
34
34
|
*/
|
|
35
|
-
export declare const getCurrentAuthUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentAuthUserData, ThrowOnError>) =>
|
|
35
|
+
export declare const getCurrentAuthUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentAuthUserData, ThrowOnError>) => RequestResult<GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, ThrowOnError>;
|
|
36
36
|
/**
|
|
37
37
|
* Refresh Session
|
|
38
38
|
*
|
|
39
39
|
* Revokes the current token and issues a new one. Accepts recently-expired tokens within the grace period.
|
|
40
40
|
*/
|
|
41
|
-
export declare const refreshAuthSession: <ThrowOnError extends boolean = false>(options?: Options<RefreshAuthSessionData, ThrowOnError>) =>
|
|
41
|
+
export declare const refreshAuthSession: <ThrowOnError extends boolean = false>(options?: Options<RefreshAuthSessionData, ThrowOnError>) => RequestResult<RefreshAuthSessionResponses, RefreshAuthSessionErrors, ThrowOnError>;
|
|
42
42
|
/**
|
|
43
43
|
* Resend Email Verification
|
|
44
44
|
*
|
|
45
45
|
* Resend verification email to the authenticated user. Rate limited to 3 per hour.
|
|
46
46
|
*/
|
|
47
|
-
export declare const resendVerificationEmail: <ThrowOnError extends boolean = false>(options?: Options<ResendVerificationEmailData, ThrowOnError>) =>
|
|
47
|
+
export declare const resendVerificationEmail: <ThrowOnError extends boolean = false>(options?: Options<ResendVerificationEmailData, ThrowOnError>) => RequestResult<ResendVerificationEmailResponses, ResendVerificationEmailErrors, ThrowOnError>;
|
|
48
48
|
/**
|
|
49
49
|
* Verify Email
|
|
50
50
|
*
|
|
51
51
|
* Verify email address with token from email link. Returns JWT for auto-login.
|
|
52
52
|
*/
|
|
53
|
-
export declare const verifyEmail: <ThrowOnError extends boolean = false>(options: Options<VerifyEmailData, ThrowOnError>) =>
|
|
53
|
+
export declare const verifyEmail: <ThrowOnError extends boolean = false>(options: Options<VerifyEmailData, ThrowOnError>) => RequestResult<VerifyEmailResponses, VerifyEmailErrors, ThrowOnError>;
|
|
54
54
|
/**
|
|
55
55
|
* Preview Invitation
|
|
56
56
|
*
|
|
57
57
|
* Look up a pending org invitation by its token so the registration page can show what is being joined. Returns 404 for unknown, expired, revoked, or accepted tokens.
|
|
58
58
|
*/
|
|
59
|
-
export declare const getInvitationPreview: <ThrowOnError extends boolean = false>(options: Options<GetInvitationPreviewData, ThrowOnError>) =>
|
|
59
|
+
export declare const getInvitationPreview: <ThrowOnError extends boolean = false>(options: Options<GetInvitationPreviewData, ThrowOnError>) => RequestResult<GetInvitationPreviewResponses, GetInvitationPreviewErrors, ThrowOnError>;
|
|
60
60
|
/**
|
|
61
61
|
* Get Password Policy
|
|
62
62
|
*/
|
|
63
|
-
export declare const getPasswordPolicy: <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) =>
|
|
63
|
+
export declare const getPasswordPolicy: <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => RequestResult<GetPasswordPolicyResponses, GetPasswordPolicyErrors, ThrowOnError>;
|
|
64
64
|
/**
|
|
65
65
|
* Check Password Strength
|
|
66
66
|
*/
|
|
67
|
-
export declare const checkPasswordStrength: <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) =>
|
|
67
|
+
export declare const checkPasswordStrength: <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => RequestResult<CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ThrowOnError>;
|
|
68
68
|
/**
|
|
69
69
|
* Forgot Password
|
|
70
70
|
*
|
|
71
71
|
* Request password reset email. Always returns success to prevent email enumeration.
|
|
72
72
|
*/
|
|
73
|
-
export declare const forgotPassword: <ThrowOnError extends boolean = false>(options: Options<ForgotPasswordData, ThrowOnError>) =>
|
|
73
|
+
export declare const forgotPassword: <ThrowOnError extends boolean = false>(options: Options<ForgotPasswordData, ThrowOnError>) => RequestResult<ForgotPasswordResponses, ForgotPasswordErrors, ThrowOnError>;
|
|
74
74
|
/**
|
|
75
75
|
* Validate Reset Token
|
|
76
76
|
*
|
|
77
77
|
* Check if a password reset token is valid without consuming it. Returns masked email on success.
|
|
78
78
|
*/
|
|
79
|
-
export declare const validateResetToken: <ThrowOnError extends boolean = false>(options: Options<ValidateResetTokenData, ThrowOnError>) =>
|
|
79
|
+
export declare const validateResetToken: <ThrowOnError extends boolean = false>(options: Options<ValidateResetTokenData, ThrowOnError>) => RequestResult<ValidateResetTokenResponses, ValidateResetTokenErrors, ThrowOnError>;
|
|
80
80
|
/**
|
|
81
81
|
* Reset Password
|
|
82
82
|
*
|
|
83
83
|
* Reset password with token from email. Invalidates all existing sessions. Returns JWT for auto-login.
|
|
84
84
|
*/
|
|
85
|
-
export declare const resetPassword: <ThrowOnError extends boolean = false>(options: Options<ResetPasswordData, ThrowOnError>) =>
|
|
85
|
+
export declare const resetPassword: <ThrowOnError extends boolean = false>(options: Options<ResetPasswordData, ThrowOnError>) => RequestResult<ResetPasswordResponses, ResetPasswordErrors, ThrowOnError>;
|
|
86
86
|
/**
|
|
87
87
|
* Generate SSO Token
|
|
88
88
|
*
|
|
89
89
|
* Step 1 of 3 in the cross-app SSO flow. Issues a single-use token (5 minute TTL) for handoff to a target application.
|
|
90
90
|
*/
|
|
91
|
-
export declare const generateSsoToken: <ThrowOnError extends boolean = false>(options?: Options<GenerateSsoTokenData, ThrowOnError>) =>
|
|
91
|
+
export declare const generateSsoToken: <ThrowOnError extends boolean = false>(options?: Options<GenerateSsoTokenData, ThrowOnError>) => RequestResult<GenerateSsoTokenResponses, GenerateSsoTokenErrors, ThrowOnError>;
|
|
92
92
|
/**
|
|
93
93
|
* SSO Token Exchange
|
|
94
94
|
*
|
|
95
95
|
* Step 2 of 3. Exchanges the SSO token for a short-lived session ID. Avoids passing tokens in redirect URLs.
|
|
96
96
|
*/
|
|
97
|
-
export declare const ssoTokenExchange: <ThrowOnError extends boolean = false>(options: Options<SsoTokenExchangeData, ThrowOnError>) =>
|
|
97
|
+
export declare const ssoTokenExchange: <ThrowOnError extends boolean = false>(options: Options<SsoTokenExchangeData, ThrowOnError>) => RequestResult<SsoTokenExchangeResponses, SsoTokenExchangeErrors, ThrowOnError>;
|
|
98
98
|
/**
|
|
99
99
|
* Complete SSO Authentication
|
|
100
100
|
*
|
|
101
101
|
* Step 3 of 3. Exchanges the session ID for a full JWT token. Called by the target app after redirect.
|
|
102
102
|
*/
|
|
103
|
-
export declare const completeSsoAuth: <ThrowOnError extends boolean = false>(options: Options<CompleteSsoAuthData, ThrowOnError>) =>
|
|
103
|
+
export declare const completeSsoAuth: <ThrowOnError extends boolean = false>(options: Options<CompleteSsoAuthData, ThrowOnError>) => RequestResult<CompleteSsoAuthResponses, CompleteSsoAuthErrors, ThrowOnError>;
|
|
104
104
|
/**
|
|
105
105
|
* Passkey Registration Options
|
|
106
106
|
*
|
|
107
107
|
* Begin a passkey enrollment ceremony. The settings lane requires a fresh re-auth proof (password or assertion); the forced lane presents its enrollment token.
|
|
108
108
|
*/
|
|
109
|
-
export declare const getPasskeyRegistrationOptions: <ThrowOnError extends boolean = false>(options: Options<GetPasskeyRegistrationOptionsData, ThrowOnError>) =>
|
|
109
|
+
export declare const getPasskeyRegistrationOptions: <ThrowOnError extends boolean = false>(options: Options<GetPasskeyRegistrationOptionsData, ThrowOnError>) => RequestResult<GetPasskeyRegistrationOptionsResponses, GetPasskeyRegistrationOptionsErrors, ThrowOnError>;
|
|
110
110
|
/**
|
|
111
111
|
* Passkey Registration Verify
|
|
112
112
|
*
|
|
113
113
|
* Finish enrollment. The first passkey returns recovery codes (once); the forced-enrollment lane also completes the login.
|
|
114
114
|
*/
|
|
115
|
-
export declare const verifyPasskeyRegistration: <ThrowOnError extends boolean = false>(options: Options<VerifyPasskeyRegistrationData, ThrowOnError>) =>
|
|
115
|
+
export declare const verifyPasskeyRegistration: <ThrowOnError extends boolean = false>(options: Options<VerifyPasskeyRegistrationData, ThrowOnError>) => RequestResult<VerifyPasskeyRegistrationResponses, VerifyPasskeyRegistrationErrors, ThrowOnError>;
|
|
116
116
|
/**
|
|
117
117
|
* List Passkeys
|
|
118
118
|
*
|
|
119
119
|
* The authenticated user's enrolled passkeys.
|
|
120
120
|
*/
|
|
121
|
-
export declare const listUserPasskeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserPasskeysData, ThrowOnError>) =>
|
|
121
|
+
export declare const listUserPasskeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserPasskeysData, ThrowOnError>) => RequestResult<ListUserPasskeysResponses, ListUserPasskeysErrors, ThrowOnError>;
|
|
122
122
|
/**
|
|
123
123
|
* Re-authentication Options
|
|
124
124
|
*
|
|
125
125
|
* Fresh-assertion options for destructive passkey lifecycle actions.
|
|
126
126
|
*/
|
|
127
|
-
export declare const getPasskeyReauthOptions: <ThrowOnError extends boolean = false>(options?: Options<GetPasskeyReauthOptionsData, ThrowOnError>) =>
|
|
127
|
+
export declare const getPasskeyReauthOptions: <ThrowOnError extends boolean = false>(options?: Options<GetPasskeyReauthOptionsData, ThrowOnError>) => RequestResult<GetPasskeyReauthOptionsResponses, GetPasskeyReauthOptionsErrors, ThrowOnError>;
|
|
128
128
|
/**
|
|
129
129
|
* Remove Passkey
|
|
130
130
|
*
|
|
131
131
|
* Remove one passkey after re-authentication (password or fresh assertion). The last passkey of an MFA-required role cannot be removed while enforcement is active.
|
|
132
132
|
*/
|
|
133
|
-
export declare const deleteUserPasskey: <ThrowOnError extends boolean = false>(options: Options<DeleteUserPasskeyData, ThrowOnError>) =>
|
|
133
|
+
export declare const deleteUserPasskey: <ThrowOnError extends boolean = false>(options: Options<DeleteUserPasskeyData, ThrowOnError>) => RequestResult<DeleteUserPasskeyResponses, DeleteUserPasskeyErrors, ThrowOnError>;
|
|
134
134
|
/**
|
|
135
135
|
* Passwordless Login Options
|
|
136
136
|
*
|
|
137
137
|
* Usernameless assertion options for passwordless (passkey) login.
|
|
138
138
|
*/
|
|
139
|
-
export declare const getPasskeyLoginOptions: <ThrowOnError extends boolean = false>(options?: Options<GetPasskeyLoginOptionsData, ThrowOnError>) =>
|
|
139
|
+
export declare const getPasskeyLoginOptions: <ThrowOnError extends boolean = false>(options?: Options<GetPasskeyLoginOptionsData, ThrowOnError>) => RequestResult<GetPasskeyLoginOptionsResponses, GetPasskeyLoginOptionsErrors, ThrowOnError>;
|
|
140
140
|
/**
|
|
141
141
|
* Passwordless Login Verify
|
|
142
142
|
*
|
|
143
143
|
* Complete a passwordless login. A user-verified passkey assertion is two factors in one gesture.
|
|
144
144
|
*/
|
|
145
|
-
export declare const verifyPasskeyLogin: <ThrowOnError extends boolean = false>(options: Options<VerifyPasskeyLoginData, ThrowOnError>) =>
|
|
145
|
+
export declare const verifyPasskeyLogin: <ThrowOnError extends boolean = false>(options: Options<VerifyPasskeyLoginData, ThrowOnError>) => RequestResult<VerifyPasskeyLoginResponses, VerifyPasskeyLoginErrors, ThrowOnError>;
|
|
146
146
|
/**
|
|
147
147
|
* MFA Assertion Options
|
|
148
148
|
*
|
|
149
149
|
* Exchange an mfa_required login token for passkey assertion options.
|
|
150
150
|
*/
|
|
151
|
-
export declare const getMfaOptions: <ThrowOnError extends boolean = false>(options: Options<GetMfaOptionsData, ThrowOnError>) =>
|
|
151
|
+
export declare const getMfaOptions: <ThrowOnError extends boolean = false>(options: Options<GetMfaOptionsData, ThrowOnError>) => RequestResult<GetMfaOptionsResponses, GetMfaOptionsErrors, ThrowOnError>;
|
|
152
152
|
/**
|
|
153
153
|
* MFA Verify
|
|
154
154
|
*
|
|
155
155
|
* Complete the second factor with a passkey assertion or a recovery code.
|
|
156
156
|
*/
|
|
157
|
-
export declare const verifyMfa: <ThrowOnError extends boolean = false>(options: Options<VerifyMfaData, ThrowOnError>) =>
|
|
157
|
+
export declare const verifyMfa: <ThrowOnError extends boolean = false>(options: Options<VerifyMfaData, ThrowOnError>) => RequestResult<VerifyMfaResponses, VerifyMfaErrors, ThrowOnError>;
|
|
158
158
|
/**
|
|
159
159
|
* MFA Status
|
|
160
160
|
*
|
|
161
161
|
* The authenticated user's MFA posture for account settings.
|
|
162
162
|
*/
|
|
163
|
-
export declare const getMfaStatus: <ThrowOnError extends boolean = false>(options?: Options<GetMfaStatusData, ThrowOnError>) =>
|
|
163
|
+
export declare const getMfaStatus: <ThrowOnError extends boolean = false>(options?: Options<GetMfaStatusData, ThrowOnError>) => RequestResult<GetMfaStatusResponses, GetMfaStatusErrors, ThrowOnError>;
|
|
164
164
|
/**
|
|
165
165
|
* Regenerate Recovery Codes
|
|
166
166
|
*
|
|
167
167
|
* Replace the recovery-code set after re-authentication; codes are shown once.
|
|
168
168
|
*/
|
|
169
|
-
export declare const regenerateMfaRecoveryCodes: <ThrowOnError extends boolean = false>(options: Options<RegenerateMfaRecoveryCodesData, ThrowOnError>) =>
|
|
169
|
+
export declare const regenerateMfaRecoveryCodes: <ThrowOnError extends boolean = false>(options: Options<RegenerateMfaRecoveryCodesData, ThrowOnError>) => RequestResult<RegenerateMfaRecoveryCodesResponses, RegenerateMfaRecoveryCodesErrors, ThrowOnError>;
|
|
170
170
|
/**
|
|
171
171
|
* Get CAPTCHA Configuration
|
|
172
172
|
*
|
|
173
173
|
* Returns site key and whether CAPTCHA is required. Site key is null when CAPTCHA is disabled.
|
|
174
174
|
*/
|
|
175
|
-
export declare const getCaptchaConfig: <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) =>
|
|
175
|
+
export declare const getCaptchaConfig: <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => RequestResult<GetCaptchaConfigResponses, GetCaptchaConfigErrors, ThrowOnError>;
|
|
176
176
|
/**
|
|
177
177
|
* Get Auth Providers
|
|
178
178
|
*
|
|
179
179
|
* Returns which authentication methods this deployment offers. The login surface renders its posture from this instead of hardcoding methods.
|
|
180
180
|
*/
|
|
181
|
-
export declare const getAuthProviders: <ThrowOnError extends boolean = false>(options?: Options<GetAuthProvidersData, ThrowOnError>) =>
|
|
181
|
+
export declare const getAuthProviders: <ThrowOnError extends boolean = false>(options?: Options<GetAuthProvidersData, ThrowOnError>) => RequestResult<GetAuthProvidersResponses, GetAuthProvidersErrors, ThrowOnError>;
|
|
182
182
|
/**
|
|
183
183
|
* Health Check
|
|
184
184
|
*
|
|
185
185
|
* Unprotected — used by load balancers and monitoring. No authentication required.
|
|
186
186
|
*/
|
|
187
|
-
export declare const getServiceStatus: <ThrowOnError extends boolean = false>(options?: Options<GetServiceStatusData, ThrowOnError>) =>
|
|
187
|
+
export declare const getServiceStatus: <ThrowOnError extends boolean = false>(options?: Options<GetServiceStatusData, ThrowOnError>) => RequestResult<GetServiceStatusResponses, unknown, ThrowOnError>;
|
|
188
188
|
/**
|
|
189
189
|
* Get Current User
|
|
190
190
|
*/
|
|
191
|
-
export declare const getCurrentUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) =>
|
|
191
|
+
export declare const getCurrentUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) => RequestResult<GetCurrentUserResponses, GetCurrentUserErrors, ThrowOnError>;
|
|
192
192
|
/**
|
|
193
193
|
* Update User Profile
|
|
194
194
|
*/
|
|
195
|
-
export declare const updateUser: <ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>) =>
|
|
195
|
+
export declare const updateUser: <ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>) => RequestResult<UpdateUserResponses, UpdateUserErrors, ThrowOnError>;
|
|
196
196
|
/**
|
|
197
197
|
* Update Password
|
|
198
198
|
*
|
|
199
199
|
* Requires current password verification. Not available for SSO-only accounts.
|
|
200
200
|
*/
|
|
201
|
-
export declare const updateUserPassword: <ThrowOnError extends boolean = false>(options: Options<UpdateUserPasswordData, ThrowOnError>) =>
|
|
201
|
+
export declare const updateUserPassword: <ThrowOnError extends boolean = false>(options: Options<UpdateUserPasswordData, ThrowOnError>) => RequestResult<UpdateUserPasswordResponses, UpdateUserPasswordErrors, ThrowOnError>;
|
|
202
202
|
/**
|
|
203
203
|
* List API Keys
|
|
204
204
|
*
|
|
205
205
|
* Lists active keys only. Revoked keys are omitted — revocation is permanent, so a revoked key never returns to this list.
|
|
206
206
|
*/
|
|
207
|
-
export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) =>
|
|
207
|
+
export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) => RequestResult<ListUserApiKeysResponses, ListUserApiKeysErrors, ThrowOnError>;
|
|
208
208
|
/**
|
|
209
209
|
* Create API Key
|
|
210
210
|
*
|
|
211
211
|
* The raw key value is only returned once at creation time and cannot be retrieved again.
|
|
212
212
|
*/
|
|
213
|
-
export declare const createUserApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) =>
|
|
213
|
+
export declare const createUserApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) => RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>;
|
|
214
214
|
/**
|
|
215
215
|
* Revoke API Key
|
|
216
216
|
*
|
|
217
217
|
* Deactivates the key immediately. Requests using the revoked key will fail with 401.
|
|
218
218
|
*/
|
|
219
|
-
export declare const revokeUserApiKey: <ThrowOnError extends boolean = false>(options: Options<RevokeUserApiKeyData, ThrowOnError>) =>
|
|
219
|
+
export declare const revokeUserApiKey: <ThrowOnError extends boolean = false>(options: Options<RevokeUserApiKeyData, ThrowOnError>) => RequestResult<RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, ThrowOnError>;
|
|
220
220
|
/**
|
|
221
221
|
* Update API Key
|
|
222
222
|
*/
|
|
223
|
-
export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) =>
|
|
223
|
+
export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) => RequestResult<UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ThrowOnError>;
|
|
224
224
|
/**
|
|
225
225
|
* List Connected Apps
|
|
226
226
|
*
|
|
227
227
|
* Every MCP client the user has authorized through OAuth, with the one graph each connection reaches. Active grants only: a revoked grant cannot be reinstated, so it leaves the list.
|
|
228
228
|
*/
|
|
229
|
-
export declare const listUserOAuthGrants: <ThrowOnError extends boolean = false>(options?: Options<ListUserOAuthGrantsData, ThrowOnError>) =>
|
|
229
|
+
export declare const listUserOAuthGrants: <ThrowOnError extends boolean = false>(options?: Options<ListUserOAuthGrantsData, ThrowOnError>) => RequestResult<ListUserOAuthGrantsResponses, ListUserOAuthGrantsErrors, ThrowOnError>;
|
|
230
230
|
/**
|
|
231
231
|
* Revoke Connected App
|
|
232
232
|
*
|
|
233
233
|
* Revokes the grant and every access and refresh token minted from it. The client's next request fails with 401 and it must ask the user to authorize again. Revoking an already revoked grant succeeds and changes nothing.
|
|
234
234
|
*/
|
|
235
|
-
export declare const revokeUserOAuthGrant: <ThrowOnError extends boolean = false>(options: Options<RevokeUserOAuthGrantData, ThrowOnError>) =>
|
|
235
|
+
export declare const revokeUserOAuthGrant: <ThrowOnError extends boolean = false>(options: Options<RevokeUserOAuthGrantData, ThrowOnError>) => RequestResult<RevokeUserOAuthGrantResponses, RevokeUserOAuthGrantErrors, ThrowOnError>;
|
|
236
236
|
/**
|
|
237
237
|
* List User's Organizations
|
|
238
238
|
*/
|
|
239
|
-
export declare const listUserOrgs: <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) =>
|
|
239
|
+
export declare const listUserOrgs: <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => RequestResult<ListUserOrgsResponses, ListUserOrgsErrors, ThrowOnError>;
|
|
240
240
|
/**
|
|
241
241
|
* Get Organization
|
|
242
242
|
*/
|
|
243
|
-
export declare const getOrg: <ThrowOnError extends boolean = false>(options: Options<GetOrgData, ThrowOnError>) =>
|
|
243
|
+
export declare const getOrg: <ThrowOnError extends boolean = false>(options: Options<GetOrgData, ThrowOnError>) => RequestResult<GetOrgResponses, GetOrgErrors, ThrowOnError>;
|
|
244
244
|
/**
|
|
245
245
|
* Update Organization
|
|
246
246
|
*
|
|
247
247
|
* Requires admin or owner role. Only owners can change the org type.
|
|
248
248
|
*/
|
|
249
|
-
export declare const updateOrg: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgData, ThrowOnError>) =>
|
|
249
|
+
export declare const updateOrg: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgData, ThrowOnError>) => RequestResult<UpdateOrgResponses, UpdateOrgErrors, ThrowOnError>;
|
|
250
250
|
/**
|
|
251
251
|
* List Organization Graphs
|
|
252
252
|
*/
|
|
253
|
-
export declare const listOrgGraphs: <ThrowOnError extends boolean = false>(options: Options<ListOrgGraphsData, ThrowOnError>) =>
|
|
253
|
+
export declare const listOrgGraphs: <ThrowOnError extends boolean = false>(options: Options<ListOrgGraphsData, ThrowOnError>) => RequestResult<ListOrgGraphsResponses, ListOrgGraphsErrors, ThrowOnError>;
|
|
254
254
|
/**
|
|
255
255
|
* List Organization Members
|
|
256
256
|
*/
|
|
257
|
-
export declare const listOrgMembers: <ThrowOnError extends boolean = false>(options: Options<ListOrgMembersData, ThrowOnError>) =>
|
|
257
|
+
export declare const listOrgMembers: <ThrowOnError extends boolean = false>(options: Options<ListOrgMembersData, ThrowOnError>) => RequestResult<ListOrgMembersResponses, ListOrgMembersErrors, ThrowOnError>;
|
|
258
258
|
/**
|
|
259
259
|
* Remove Member
|
|
260
260
|
*
|
|
261
261
|
* Requires admin or owner role. Members may remove themselves.
|
|
262
262
|
*/
|
|
263
|
-
export declare const removeOrgMember: <ThrowOnError extends boolean = false>(options: Options<RemoveOrgMemberData, ThrowOnError>) =>
|
|
263
|
+
export declare const removeOrgMember: <ThrowOnError extends boolean = false>(options: Options<RemoveOrgMemberData, ThrowOnError>) => RequestResult<RemoveOrgMemberResponses, RemoveOrgMemberErrors, ThrowOnError>;
|
|
264
264
|
/**
|
|
265
265
|
* Update Member Role
|
|
266
266
|
*
|
|
267
267
|
* Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
|
|
268
268
|
*/
|
|
269
|
-
export declare const updateOrgMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) =>
|
|
269
|
+
export declare const updateOrgMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) => RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError>;
|
|
270
270
|
/**
|
|
271
271
|
* List Pending Invitations
|
|
272
272
|
*
|
|
273
273
|
* Requires admin or owner role.
|
|
274
274
|
*/
|
|
275
|
-
export declare const listOrgInvitations: <ThrowOnError extends boolean = false>(options: Options<ListOrgInvitationsData, ThrowOnError>) =>
|
|
275
|
+
export declare const listOrgInvitations: <ThrowOnError extends boolean = false>(options: Options<ListOrgInvitationsData, ThrowOnError>) => RequestResult<ListOrgInvitationsResponses, ListOrgInvitationsErrors, ThrowOnError>;
|
|
276
276
|
/**
|
|
277
277
|
* Invite Member
|
|
278
278
|
*
|
|
279
279
|
* 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.
|
|
280
280
|
*/
|
|
281
|
-
export declare const createOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<CreateOrgInvitationData, ThrowOnError>) =>
|
|
281
|
+
export declare const createOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<CreateOrgInvitationData, ThrowOnError>) => RequestResult<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError>;
|
|
282
282
|
/**
|
|
283
283
|
* Revoke Invitation
|
|
284
284
|
*
|
|
285
285
|
* Requires admin or owner role. Only pending invitations can be revoked.
|
|
286
286
|
*/
|
|
287
|
-
export declare const revokeOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<RevokeOrgInvitationData, ThrowOnError>) =>
|
|
287
|
+
export declare const revokeOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<RevokeOrgInvitationData, ThrowOnError>) => RequestResult<RevokeOrgInvitationResponses, RevokeOrgInvitationErrors, ThrowOnError>;
|
|
288
288
|
/**
|
|
289
289
|
* Resend Invitation
|
|
290
290
|
*
|
|
291
291
|
* Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
|
|
292
292
|
*/
|
|
293
|
-
export declare const resendOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<ResendOrgInvitationData, ThrowOnError>) =>
|
|
293
|
+
export declare const resendOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<ResendOrgInvitationData, ThrowOnError>) => RequestResult<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError>;
|
|
294
294
|
/**
|
|
295
295
|
* Get Organization Limits
|
|
296
296
|
*/
|
|
297
|
-
export declare const getOrgLimits: <ThrowOnError extends boolean = false>(options: Options<GetOrgLimitsData, ThrowOnError>) =>
|
|
297
|
+
export declare const getOrgLimits: <ThrowOnError extends boolean = false>(options: Options<GetOrgLimitsData, ThrowOnError>) => RequestResult<GetOrgLimitsResponses, GetOrgLimitsErrors, ThrowOnError>;
|
|
298
298
|
/**
|
|
299
299
|
* Get Organization Usage
|
|
300
300
|
*
|
|
301
301
|
* Aggregated across all graphs in the org. Use the `days` query param to control the lookback window (default 30).
|
|
302
302
|
*/
|
|
303
|
-
export declare const getOrgUsage: <ThrowOnError extends boolean = false>(options: Options<GetOrgUsageData, ThrowOnError>) =>
|
|
303
|
+
export declare const getOrgUsage: <ThrowOnError extends boolean = false>(options: Options<GetOrgUsageData, ThrowOnError>) => RequestResult<GetOrgUsageResponses, GetOrgUsageErrors, ThrowOnError>;
|
|
304
304
|
/**
|
|
305
305
|
* Sync Connection
|
|
306
306
|
*
|
|
307
307
|
* QuickBooks: fetches transactions, balances, and chart of accounts; the envelope is `pending` with the run's `task_id`, and completion is reflected in the connection's `last_sync` timestamp. External connections are push-based and have nothing to pull; the envelope is `completed` with a null `task_id` and a message saying so — there is nothing to poll. Returns an `OperationEnvelope`; supports `Idempotency-Key`.
|
|
308
308
|
*/
|
|
309
|
-
export declare const syncConnection: <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) =>
|
|
309
|
+
export declare const syncConnection: <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => RequestResult<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError>;
|
|
310
310
|
/**
|
|
311
311
|
* List Connection Options
|
|
312
312
|
*
|
|
313
313
|
* Returns available providers and their requirements. Only enabled providers are included (gated by feature flags). QuickBooks requires OAuth 2.0; external connections require no auth.
|
|
314
314
|
*/
|
|
315
|
-
export declare const getConnectionOptions: <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) =>
|
|
315
|
+
export declare const getConnectionOptions: <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => RequestResult<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError>;
|
|
316
316
|
/**
|
|
317
317
|
* Initialize OAuth Flow
|
|
318
318
|
*/
|
|
319
|
-
export declare const initOAuth: <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) =>
|
|
319
|
+
export declare const initOAuth: <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => RequestResult<InitOAuthResponses, InitOAuthErrors, ThrowOnError>;
|
|
320
320
|
/**
|
|
321
321
|
* OAuth Callback
|
|
322
322
|
*
|
|
323
323
|
* Completes the OAuth authorization flow after provider redirect. Exchanges the authorization code for tokens, stores them, and triggers an initial sync. This is a redirect target — not typically called directly.
|
|
324
324
|
*/
|
|
325
|
-
export declare const oauthCallback: <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) =>
|
|
325
|
+
export declare const oauthCallback: <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => RequestResult<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError>;
|
|
326
326
|
/**
|
|
327
327
|
* List Connections
|
|
328
328
|
*/
|
|
329
|
-
export declare const listConnections: <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) =>
|
|
329
|
+
export declare const listConnections: <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => RequestResult<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError>;
|
|
330
330
|
/**
|
|
331
331
|
* Create Connection
|
|
332
332
|
*
|
|
333
333
|
* QuickBooks: returns an OAuth URL — complete the flow to activate. External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name.
|
|
334
334
|
*/
|
|
335
|
-
export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) =>
|
|
335
|
+
export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>;
|
|
336
336
|
/**
|
|
337
337
|
* Delete Connection
|
|
338
338
|
*
|
|
339
339
|
* Removes the connection and revokes credentials. Imported data is preserved in the graph. Requires admin role.
|
|
340
340
|
*/
|
|
341
|
-
export declare const deleteConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) =>
|
|
341
|
+
export declare const deleteConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => RequestResult<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError>;
|
|
342
342
|
/**
|
|
343
343
|
* Get Connection
|
|
344
344
|
*/
|
|
345
|
-
export declare const getConnection: <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) =>
|
|
345
|
+
export declare const getConnection: <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => RequestResult<GetConnectionResponses, GetConnectionErrors, ThrowOnError>;
|
|
346
346
|
/**
|
|
347
347
|
* Set Connection Write Policy
|
|
348
348
|
*
|
|
349
349
|
* Opt a connection into or out of outbound write-back. 'qb_authoritative' makes QuickBooks the source of truth — RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'native' keeps RoboSystems authoritative with no write-back. This is the explicit operator opt-in for writing to your books of record.
|
|
350
350
|
*/
|
|
351
|
-
export declare const setConnectionWritePolicy: <ThrowOnError extends boolean = false>(options: Options<SetConnectionWritePolicyData, ThrowOnError>) =>
|
|
351
|
+
export declare const setConnectionWritePolicy: <ThrowOnError extends boolean = false>(options: Options<SetConnectionWritePolicyData, ThrowOnError>) => RequestResult<SetConnectionWritePolicyResponses, SetConnectionWritePolicyErrors, ThrowOnError>;
|
|
352
352
|
/**
|
|
353
353
|
* List Available Operators
|
|
354
354
|
*
|
|
355
355
|
* Filter by capability using the `capability` query param (e.g., `financial_analysis`, `rag_search`).
|
|
356
356
|
*/
|
|
357
|
-
export declare const listOperators: <ThrowOnError extends boolean = false>(options: Options<ListOperatorsData, ThrowOnError>) =>
|
|
357
|
+
export declare const listOperators: <ThrowOnError extends boolean = false>(options: Options<ListOperatorsData, ThrowOnError>) => RequestResult<ListOperatorsResponses, ListOperatorsErrors, ThrowOnError>;
|
|
358
358
|
/**
|
|
359
359
|
* Auto-select Operator for Query
|
|
360
360
|
*
|
|
361
361
|
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
362
362
|
*/
|
|
363
|
-
export declare const autoSelectOperator: <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) =>
|
|
363
|
+
export declare const autoSelectOperator: <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => RequestResult<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError>;
|
|
364
364
|
/**
|
|
365
365
|
* Get Operator Metadata
|
|
366
366
|
*/
|
|
367
|
-
export declare const getOperatorMetadata: <ThrowOnError extends boolean = false>(options: Options<GetOperatorMetadataData, ThrowOnError>) =>
|
|
367
|
+
export declare const getOperatorMetadata: <ThrowOnError extends boolean = false>(options: Options<GetOperatorMetadataData, ThrowOnError>) => RequestResult<GetOperatorMetadataResponses, GetOperatorMetadataErrors, ThrowOnError>;
|
|
368
368
|
/**
|
|
369
369
|
* Execute Specific Operator
|
|
370
370
|
*
|
|
371
371
|
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
372
372
|
*/
|
|
373
|
-
export declare const executeSpecificOperator: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) =>
|
|
373
|
+
export declare const executeSpecificOperator: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => RequestResult<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError>;
|
|
374
374
|
/**
|
|
375
375
|
* List graph database backups
|
|
376
376
|
*/
|
|
377
|
-
export declare const listBackups: <ThrowOnError extends boolean = false>(options: Options<ListBackupsData, ThrowOnError>) =>
|
|
377
|
+
export declare const listBackups: <ThrowOnError extends boolean = false>(options: Options<ListBackupsData, ThrowOnError>) => RequestResult<ListBackupsResponses, ListBackupsErrors, ThrowOnError>;
|
|
378
378
|
/**
|
|
379
379
|
* Get temporary download URL for backup
|
|
380
380
|
*
|
|
381
381
|
* Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
|
|
382
382
|
*/
|
|
383
|
-
export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) =>
|
|
383
|
+
export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>;
|
|
384
384
|
/**
|
|
385
385
|
* Get backup statistics
|
|
386
386
|
*/
|
|
387
|
-
export declare const getBackupStats: <ThrowOnError extends boolean = false>(options: Options<GetBackupStatsData, ThrowOnError>) =>
|
|
387
|
+
export declare const getBackupStats: <ThrowOnError extends boolean = false>(options: Options<GetBackupStatsData, ThrowOnError>) => RequestResult<GetBackupStatsResponses, GetBackupStatsErrors, ThrowOnError>;
|
|
388
388
|
/**
|
|
389
389
|
* Get Graph Metrics
|
|
390
390
|
*/
|
|
391
|
-
export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) =>
|
|
391
|
+
export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => RequestResult<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError>;
|
|
392
392
|
/**
|
|
393
393
|
* Get Graph Usage
|
|
394
394
|
*
|
|
395
395
|
* Time ranges: 24h, 7d, 30d, current_month, last_month. Toggle storage, credits, performance, and events sections via query params.
|
|
396
396
|
*/
|
|
397
|
-
export declare const getGraphUsage: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageData, ThrowOnError>) =>
|
|
397
|
+
export declare const getGraphUsage: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageData, ThrowOnError>) => RequestResult<GetGraphUsageResponses, GetGraphUsageErrors, ThrowOnError>;
|
|
398
398
|
/**
|
|
399
399
|
* Execute Cypher Statement
|
|
400
400
|
*
|
|
401
401
|
* Cypher over the graph (LadybugDB). Main graphs are **read-only** — use the staging pipeline to ingest data. Subgraphs support full writes. Always use parameterized queries (`parameters: {"key": "val"}`) to prevent injection. Response modes: `auto` (default), `sync`, `async`, `stream`. Under load, queries are queued and emit an `operation_id` for SSE monitoring at `/v1/operations/{id}/stream`.
|
|
402
402
|
*/
|
|
403
|
-
export declare const executeCypher: <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherData, ThrowOnError>) =>
|
|
403
|
+
export declare const executeCypher: <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherData, ThrowOnError>) => RequestResult<ExecuteCypherResponses, ExecuteCypherErrors, ThrowOnError>;
|
|
404
404
|
/**
|
|
405
405
|
* Execute SQL Statement
|
|
406
406
|
*
|
|
407
407
|
* SQL over the graph's columnar tables (DuckDB) — a relational lens on the same graph-centric data, often ahead of the materialized graph. Use `?` placeholders with the `parameters` array to prevent injection. Read-only (SELECT only), 30s timeout, 10,000 row limit. Not available on shared repositories.
|
|
408
408
|
*/
|
|
409
|
-
export declare const executeSql: <ThrowOnError extends boolean = false>(options: Options<ExecuteSqlData, ThrowOnError>) =>
|
|
409
|
+
export declare const executeSql: <ThrowOnError extends boolean = false>(options: Options<ExecuteSqlData, ThrowOnError>) => RequestResult<ExecuteSqlResponses, ExecuteSqlErrors, ThrowOnError>;
|
|
410
410
|
/**
|
|
411
411
|
* Get Runtime Graph Schema
|
|
412
412
|
*
|
|
413
413
|
* Runtime schema from actual graph data — node labels, relationship types, and up to 10 sample properties per node type. For the original schema definition or structured export formats, use `/schema/export`.
|
|
414
414
|
*/
|
|
415
|
-
export declare const getGraphSchema: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) =>
|
|
415
|
+
export declare const getGraphSchema: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => RequestResult<GetGraphSchemaResponses, GetGraphSchemaErrors, ThrowOnError>;
|
|
416
416
|
/**
|
|
417
417
|
* Export Declared Graph Schema
|
|
418
418
|
*
|
|
419
419
|
* Returns the original schema definition from graph creation, not the runtime state. Set `include_data_stats=true` to add live node/relationship counts. Use `/schema` to inspect what's actually in the database.
|
|
420
420
|
*/
|
|
421
|
-
export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(options: Options<ExportGraphSchemaData, ThrowOnError>) =>
|
|
421
|
+
export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(options: Options<ExportGraphSchemaData, ThrowOnError>) => RequestResult<ExportGraphSchemaResponses, ExportGraphSchemaErrors, ThrowOnError>;
|
|
422
422
|
/**
|
|
423
423
|
* Get Credit Summary
|
|
424
424
|
*/
|
|
425
|
-
export declare const getCreditSummary: <ThrowOnError extends boolean = false>(options: Options<GetCreditSummaryData, ThrowOnError>) =>
|
|
425
|
+
export declare const getCreditSummary: <ThrowOnError extends boolean = false>(options: Options<GetCreditSummaryData, ThrowOnError>) => RequestResult<GetCreditSummaryResponses, GetCreditSummaryErrors, ThrowOnError>;
|
|
426
426
|
/**
|
|
427
427
|
* List Credit Transactions
|
|
428
428
|
*/
|
|
429
|
-
export declare const listCreditTransactions: <ThrowOnError extends boolean = false>(options: Options<ListCreditTransactionsData, ThrowOnError>) =>
|
|
429
|
+
export declare const listCreditTransactions: <ThrowOnError extends boolean = false>(options: Options<ListCreditTransactionsData, ThrowOnError>) => RequestResult<ListCreditTransactionsResponses, ListCreditTransactionsErrors, ThrowOnError>;
|
|
430
430
|
/**
|
|
431
431
|
* Database Health Check
|
|
432
432
|
*/
|
|
433
|
-
export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) =>
|
|
433
|
+
export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => RequestResult<GetDatabaseHealthResponses, GetDatabaseHealthErrors, ThrowOnError>;
|
|
434
434
|
/**
|
|
435
435
|
* Database Information
|
|
436
436
|
*/
|
|
437
|
-
export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) =>
|
|
437
|
+
export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => RequestResult<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError>;
|
|
438
438
|
/**
|
|
439
439
|
* Get Graph Operational Limits
|
|
440
440
|
*
|
|
441
441
|
* Limits vary by subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge). Includes storage, query, backup, rate, credit, document, and instance usage limits.
|
|
442
442
|
*/
|
|
443
|
-
export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) =>
|
|
443
|
+
export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => RequestResult<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError>;
|
|
444
444
|
/**
|
|
445
445
|
* List Graph Members
|
|
446
446
|
*
|
|
447
447
|
* All users with access to the graph: explicit grants plus org owners/admins who hold implicit admin. Requires graph admin.
|
|
448
448
|
*/
|
|
449
|
-
export declare const listGraphMembers: <ThrowOnError extends boolean = false>(options: Options<ListGraphMembersData, ThrowOnError>) =>
|
|
449
|
+
export declare const listGraphMembers: <ThrowOnError extends boolean = false>(options: Options<ListGraphMembersData, ThrowOnError>) => RequestResult<ListGraphMembersResponses, ListGraphMembersErrors, ThrowOnError>;
|
|
450
450
|
/**
|
|
451
451
|
* Add Graph Member
|
|
452
452
|
*
|
|
453
453
|
* Grant a member of the graph's organization access at a chosen role. Requires graph admin.
|
|
454
454
|
*/
|
|
455
|
-
export declare const addGraphMember: <ThrowOnError extends boolean = false>(options: Options<AddGraphMemberData, ThrowOnError>) =>
|
|
455
|
+
export declare const addGraphMember: <ThrowOnError extends boolean = false>(options: Options<AddGraphMemberData, ThrowOnError>) => RequestResult<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError>;
|
|
456
456
|
/**
|
|
457
457
|
* Remove Graph Member
|
|
458
458
|
*
|
|
459
459
|
* Revoke an explicit member's access to the graph. Requires graph admin.
|
|
460
460
|
*/
|
|
461
|
-
export declare const removeGraphMember: <ThrowOnError extends boolean = false>(options: Options<RemoveGraphMemberData, ThrowOnError>) =>
|
|
461
|
+
export declare const removeGraphMember: <ThrowOnError extends boolean = false>(options: Options<RemoveGraphMemberData, ThrowOnError>) => RequestResult<RemoveGraphMemberResponses, RemoveGraphMemberErrors, ThrowOnError>;
|
|
462
462
|
/**
|
|
463
463
|
* Update Graph Member Role
|
|
464
464
|
*
|
|
465
465
|
* Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
|
|
466
466
|
*/
|
|
467
|
-
export declare const updateGraphMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMemberRoleData, ThrowOnError>) =>
|
|
467
|
+
export declare const updateGraphMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMemberRoleData, ThrowOnError>) => RequestResult<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError>;
|
|
468
468
|
/**
|
|
469
469
|
* List Subgraphs
|
|
470
470
|
*/
|
|
471
|
-
export declare const listSubgraphs: <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) =>
|
|
471
|
+
export declare const listSubgraphs: <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => RequestResult<ListSubgraphsResponses, ListSubgraphsErrors, ThrowOnError>;
|
|
472
472
|
/**
|
|
473
473
|
* Get Subgraph Details
|
|
474
474
|
*
|
|
475
475
|
* Pass the subgraph name (e.g., `dev`) not the full subgraph ID (e.g., `kg0123_dev`).
|
|
476
476
|
*/
|
|
477
|
-
export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) =>
|
|
477
|
+
export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError>;
|
|
478
478
|
/**
|
|
479
479
|
* Get Graph Subscription
|
|
480
480
|
*
|
|
481
481
|
* Detects resource type automatically: user graphs (kg*) return the graph's subscription; shared repositories return the user's personal subscription to that repo.
|
|
482
482
|
*/
|
|
483
|
-
export declare const getGraphSubscription: <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionData, ThrowOnError>) =>
|
|
483
|
+
export declare const getGraphSubscription: <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionData, ThrowOnError>) => RequestResult<GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, ThrowOnError>;
|
|
484
484
|
/**
|
|
485
485
|
* Change Subscription Plan
|
|
486
486
|
*
|
|
487
487
|
* For repositories: synchronous tier change. For user graphs: use `POST /v1/graphs/{graph_id}/operations/change-tier` instead — this endpoint rejects graph tier changes. Requires org owner role.
|
|
488
488
|
*/
|
|
489
|
-
export declare const changeSubscriptionPlan: <ThrowOnError extends boolean = false>(options: Options<ChangeSubscriptionPlanData, ThrowOnError>) =>
|
|
489
|
+
export declare const changeSubscriptionPlan: <ThrowOnError extends boolean = false>(options: Options<ChangeSubscriptionPlanData, ThrowOnError>) => RequestResult<ChangeSubscriptionPlanResponses, ChangeSubscriptionPlanErrors, ThrowOnError>;
|
|
490
490
|
/**
|
|
491
491
|
* Create Repository Subscription
|
|
492
492
|
*
|
|
493
493
|
* 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.
|
|
494
494
|
*/
|
|
495
|
-
export declare const createRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) =>
|
|
495
|
+
export declare const createRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => RequestResult<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError>;
|
|
496
496
|
/**
|
|
497
497
|
* Cancel Repository Subscription
|
|
498
498
|
*
|
|
499
499
|
* Cancel a shared repository subscription. Two modes via the `immediate` flag: omit it (default `false`) to cancel at period end (access stays until the period closes); pass `true` with `confirm=<repo_id>` to stop access right away. Members cancel their own subscription; org owners and admins can cancel any member's by passing `user_id`. For user graphs, use `POST /v1/graphs/{graph_id}/operations/delete-graph` — this endpoint rejects user graphs.
|
|
500
500
|
*/
|
|
501
|
-
export declare const cancelRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CancelRepositorySubscriptionData, ThrowOnError>) =>
|
|
501
|
+
export declare const cancelRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CancelRepositorySubscriptionData, ThrowOnError>) => RequestResult<CancelRepositorySubscriptionResponses, CancelRepositorySubscriptionErrors, ThrowOnError>;
|
|
502
502
|
/**
|
|
503
503
|
* List Staging Tables
|
|
504
504
|
*
|
|
505
505
|
* Returns file count, storage size, row count, and S3 location per table. Tables with `file_count=0` are skipped during ingestion.
|
|
506
506
|
*/
|
|
507
|
-
export declare const listTables: <ThrowOnError extends boolean = false>(options: Options<ListTablesData, ThrowOnError>) =>
|
|
507
|
+
export declare const listTables: <ThrowOnError extends boolean = false>(options: Options<ListTablesData, ThrowOnError>) => RequestResult<ListTablesResponses, ListTablesErrors, ThrowOnError>;
|
|
508
508
|
/**
|
|
509
509
|
* Search Graph Documents
|
|
510
510
|
*
|
|
511
511
|
* Shared repositories require a subscription; subscription plan determines search rate limits.
|
|
512
512
|
*/
|
|
513
|
-
export declare const searchDocuments: <ThrowOnError extends boolean = false>(options: Options<SearchDocumentsData, ThrowOnError>) =>
|
|
513
|
+
export declare const searchDocuments: <ThrowOnError extends boolean = false>(options: Options<SearchDocumentsData, ThrowOnError>) => RequestResult<SearchDocumentsResponses, SearchDocumentsErrors, ThrowOnError>;
|
|
514
514
|
/**
|
|
515
515
|
* Get Document Section
|
|
516
516
|
*/
|
|
517
|
-
export declare const getDocumentSection: <ThrowOnError extends boolean = false>(options: Options<GetDocumentSectionData, ThrowOnError>) =>
|
|
517
|
+
export declare const getDocumentSection: <ThrowOnError extends boolean = false>(options: Options<GetDocumentSectionData, ThrowOnError>) => RequestResult<GetDocumentSectionResponses, GetDocumentSectionErrors, ThrowOnError>;
|
|
518
518
|
/**
|
|
519
519
|
* List Documents
|
|
520
520
|
*/
|
|
521
|
-
export declare const listDocuments: <ThrowOnError extends boolean = false>(options: Options<ListDocumentsData, ThrowOnError>) =>
|
|
521
|
+
export declare const listDocuments: <ThrowOnError extends boolean = false>(options: Options<ListDocumentsData, ThrowOnError>) => RequestResult<ListDocumentsResponses, ListDocumentsErrors, ThrowOnError>;
|
|
522
522
|
/**
|
|
523
523
|
* Get Document
|
|
524
524
|
*/
|
|
525
|
-
export declare const getDocument: <ThrowOnError extends boolean = false>(options: Options<GetDocumentData, ThrowOnError>) =>
|
|
525
|
+
export declare const getDocument: <ThrowOnError extends boolean = false>(options: Options<GetDocumentData, ThrowOnError>) => RequestResult<GetDocumentResponses, GetDocumentErrors, ThrowOnError>;
|
|
526
526
|
/**
|
|
527
527
|
* List Memories
|
|
528
528
|
*/
|
|
529
|
-
export declare const listMemories: <ThrowOnError extends boolean = false>(options: Options<ListMemoriesData, ThrowOnError>) =>
|
|
529
|
+
export declare const listMemories: <ThrowOnError extends boolean = false>(options: Options<ListMemoriesData, ThrowOnError>) => RequestResult<ListMemoriesResponses, ListMemoriesErrors, ThrowOnError>;
|
|
530
530
|
/**
|
|
531
531
|
* Get Memory
|
|
532
532
|
*/
|
|
533
|
-
export declare const getMemory: <ThrowOnError extends boolean = false>(options: Options<GetMemoryData, ThrowOnError>) =>
|
|
533
|
+
export declare const getMemory: <ThrowOnError extends boolean = false>(options: Options<GetMemoryData, ThrowOnError>) => RequestResult<GetMemoryResponses, GetMemoryErrors, ThrowOnError>;
|
|
534
534
|
/**
|
|
535
535
|
* Recall Semantic Memory
|
|
536
536
|
*
|
|
537
537
|
* Ranked semantic recall over the graph's per-graph memory store. Returns scored hits in the same shape as document search.
|
|
538
538
|
*/
|
|
539
|
-
export declare const recallMemory: <ThrowOnError extends boolean = false>(options: Options<RecallMemoryData, ThrowOnError>) =>
|
|
539
|
+
export declare const recallMemory: <ThrowOnError extends boolean = false>(options: Options<RecallMemoryData, ThrowOnError>) => RequestResult<RecallMemoryResponses, RecallMemoryErrors, ThrowOnError>;
|
|
540
540
|
/**
|
|
541
541
|
* Create Subgraph
|
|
542
542
|
*
|
|
@@ -544,7 +544,7 @@ export declare const recallMemory: <ThrowOnError extends boolean = false>(option
|
|
|
544
544
|
*
|
|
545
545
|
* **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.
|
|
546
546
|
*/
|
|
547
|
-
export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) =>
|
|
547
|
+
export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => RequestResult<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError>;
|
|
548
548
|
/**
|
|
549
549
|
* Delete Subgraph
|
|
550
550
|
*
|
|
@@ -552,7 +552,7 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
552
552
|
*
|
|
553
553
|
* **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.
|
|
554
554
|
*/
|
|
555
|
-
export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) =>
|
|
555
|
+
export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => RequestResult<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError>;
|
|
556
556
|
/**
|
|
557
557
|
* Delete Graph
|
|
558
558
|
*
|
|
@@ -560,7 +560,7 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
560
560
|
*
|
|
561
561
|
* **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.
|
|
562
562
|
*/
|
|
563
|
-
export declare const deleteGraph: <ThrowOnError extends boolean = false>(options: Options<DeleteGraphData, ThrowOnError>) =>
|
|
563
|
+
export declare const deleteGraph: <ThrowOnError extends boolean = false>(options: Options<DeleteGraphData, ThrowOnError>) => RequestResult<DeleteGraphResponses, DeleteGraphErrors, ThrowOnError>;
|
|
564
564
|
/**
|
|
565
565
|
* Create Backup
|
|
566
566
|
*
|
|
@@ -568,7 +568,7 @@ export declare const deleteGraph: <ThrowOnError extends boolean = false>(options
|
|
|
568
568
|
*
|
|
569
569
|
* **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.
|
|
570
570
|
*/
|
|
571
|
-
export declare const createBackup: <ThrowOnError extends boolean = false>(options: Options<CreateBackupData, ThrowOnError>) =>
|
|
571
|
+
export declare const createBackup: <ThrowOnError extends boolean = false>(options: Options<CreateBackupData, ThrowOnError>) => RequestResult<CreateBackupResponses, CreateBackupErrors, ThrowOnError>;
|
|
572
572
|
/**
|
|
573
573
|
* Change Tier
|
|
574
574
|
*
|
|
@@ -576,7 +576,7 @@ export declare const createBackup: <ThrowOnError extends boolean = false>(option
|
|
|
576
576
|
*
|
|
577
577
|
* **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.
|
|
578
578
|
*/
|
|
579
|
-
export declare const changeTier: <ThrowOnError extends boolean = false>(options: Options<ChangeTierData, ThrowOnError>) =>
|
|
579
|
+
export declare const changeTier: <ThrowOnError extends boolean = false>(options: Options<ChangeTierData, ThrowOnError>) => RequestResult<ChangeTierResponses, ChangeTierErrors, ThrowOnError>;
|
|
580
580
|
/**
|
|
581
581
|
* Update Graph Metadata
|
|
582
582
|
*
|
|
@@ -584,7 +584,7 @@ export declare const changeTier: <ThrowOnError extends boolean = false>(options:
|
|
|
584
584
|
*
|
|
585
585
|
* **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.
|
|
586
586
|
*/
|
|
587
|
-
export declare const updateGraphMetadata: <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMetadataData, ThrowOnError>) =>
|
|
587
|
+
export declare const updateGraphMetadata: <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMetadataData, ThrowOnError>) => RequestResult<UpdateGraphMetadataResponses, UpdateGraphMetadataErrors, ThrowOnError>;
|
|
588
588
|
/**
|
|
589
589
|
* Materialize Graph
|
|
590
590
|
*
|
|
@@ -592,7 +592,7 @@ export declare const updateGraphMetadata: <ThrowOnError extends boolean = false>
|
|
|
592
592
|
*
|
|
593
593
|
* **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.
|
|
594
594
|
*/
|
|
595
|
-
export declare const materialize: <ThrowOnError extends boolean = false>(options: Options<MaterializeData, ThrowOnError>) =>
|
|
595
|
+
export declare const materialize: <ThrowOnError extends boolean = false>(options: Options<MaterializeData, ThrowOnError>) => RequestResult<MaterializeResponses, MaterializeErrors, ThrowOnError>;
|
|
596
596
|
/**
|
|
597
597
|
* Store a Semantic Memory
|
|
598
598
|
*
|
|
@@ -600,7 +600,7 @@ export declare const materialize: <ThrowOnError extends boolean = false>(options
|
|
|
600
600
|
*
|
|
601
601
|
* **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.
|
|
602
602
|
*/
|
|
603
|
-
export declare const remember: <ThrowOnError extends boolean = false>(options: Options<RememberData, ThrowOnError>) =>
|
|
603
|
+
export declare const remember: <ThrowOnError extends boolean = false>(options: Options<RememberData, ThrowOnError>) => RequestResult<RememberResponses, RememberErrors, ThrowOnError>;
|
|
604
604
|
/**
|
|
605
605
|
* Delete a Semantic Memory
|
|
606
606
|
*
|
|
@@ -608,7 +608,7 @@ export declare const remember: <ThrowOnError extends boolean = false>(options: O
|
|
|
608
608
|
*
|
|
609
609
|
* **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.
|
|
610
610
|
*/
|
|
611
|
-
export declare const forget: <ThrowOnError extends boolean = false>(options: Options<ForgetData, ThrowOnError>) =>
|
|
611
|
+
export declare const forget: <ThrowOnError extends boolean = false>(options: Options<ForgetData, ThrowOnError>) => RequestResult<ForgetResponses, ForgetErrors, ThrowOnError>;
|
|
612
612
|
/**
|
|
613
613
|
* Update a Semantic Memory
|
|
614
614
|
*
|
|
@@ -616,7 +616,7 @@ export declare const forget: <ThrowOnError extends boolean = false>(options: Opt
|
|
|
616
616
|
*
|
|
617
617
|
* **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.
|
|
618
618
|
*/
|
|
619
|
-
export declare const updateMemory: <ThrowOnError extends boolean = false>(options: Options<UpdateMemoryData, ThrowOnError>) =>
|
|
619
|
+
export declare const updateMemory: <ThrowOnError extends boolean = false>(options: Options<UpdateMemoryData, ThrowOnError>) => RequestResult<UpdateMemoryResponses, UpdateMemoryErrors, ThrowOnError>;
|
|
620
620
|
/**
|
|
621
621
|
* Index a Document
|
|
622
622
|
*
|
|
@@ -624,7 +624,7 @@ export declare const updateMemory: <ThrowOnError extends boolean = false>(option
|
|
|
624
624
|
*
|
|
625
625
|
* **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.
|
|
626
626
|
*/
|
|
627
|
-
export declare const indexDocument: <ThrowOnError extends boolean = false>(options: Options<IndexDocumentData, ThrowOnError>) =>
|
|
627
|
+
export declare const indexDocument: <ThrowOnError extends boolean = false>(options: Options<IndexDocumentData, ThrowOnError>) => RequestResult<IndexDocumentResponses, IndexDocumentErrors, ThrowOnError>;
|
|
628
628
|
/**
|
|
629
629
|
* Delete a Document
|
|
630
630
|
*
|
|
@@ -632,7 +632,7 @@ export declare const indexDocument: <ThrowOnError extends boolean = false>(optio
|
|
|
632
632
|
*
|
|
633
633
|
* **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.
|
|
634
634
|
*/
|
|
635
|
-
export declare const deleteDocument: <ThrowOnError extends boolean = false>(options: Options<DeleteDocumentData, ThrowOnError>) =>
|
|
635
|
+
export declare const deleteDocument: <ThrowOnError extends boolean = false>(options: Options<DeleteDocumentData, ThrowOnError>) => RequestResult<DeleteDocumentResponses, DeleteDocumentErrors, ThrowOnError>;
|
|
636
636
|
/**
|
|
637
637
|
* Presign a File Upload
|
|
638
638
|
*
|
|
@@ -640,7 +640,7 @@ export declare const deleteDocument: <ThrowOnError extends boolean = false>(opti
|
|
|
640
640
|
*
|
|
641
641
|
* **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.
|
|
642
642
|
*/
|
|
643
|
-
export declare const createFileUpload: <ThrowOnError extends boolean = false>(options: Options<CreateFileUploadData, ThrowOnError>) =>
|
|
643
|
+
export declare const createFileUpload: <ThrowOnError extends boolean = false>(options: Options<CreateFileUploadData, ThrowOnError>) => RequestResult<CreateFileUploadResponses, CreateFileUploadErrors, ThrowOnError>;
|
|
644
644
|
/**
|
|
645
645
|
* Stage an Uploaded File
|
|
646
646
|
*
|
|
@@ -648,7 +648,7 @@ export declare const createFileUpload: <ThrowOnError extends boolean = false>(op
|
|
|
648
648
|
*
|
|
649
649
|
* **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.
|
|
650
650
|
*/
|
|
651
|
-
export declare const ingestFile: <ThrowOnError extends boolean = false>(options: Options<IngestFileData, ThrowOnError>) =>
|
|
651
|
+
export declare const ingestFile: <ThrowOnError extends boolean = false>(options: Options<IngestFileData, ThrowOnError>) => RequestResult<IngestFileResponses, IngestFileErrors, ThrowOnError>;
|
|
652
652
|
/**
|
|
653
653
|
* Delete a File
|
|
654
654
|
*
|
|
@@ -656,133 +656,133 @@ export declare const ingestFile: <ThrowOnError extends boolean = false>(options:
|
|
|
656
656
|
*
|
|
657
657
|
* **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.
|
|
658
658
|
*/
|
|
659
|
-
export declare const deleteFile: <ThrowOnError extends boolean = false>(options: Options<DeleteFileData, ThrowOnError>) =>
|
|
659
|
+
export declare const deleteFile: <ThrowOnError extends boolean = false>(options: Options<DeleteFileData, ThrowOnError>) => RequestResult<DeleteFileResponses, DeleteFileErrors, ThrowOnError>;
|
|
660
660
|
/**
|
|
661
661
|
* List Files in Graph
|
|
662
662
|
*
|
|
663
663
|
* Filter by `table_name` or upload `status`. Files are graph-scoped resources with S3 → DuckDB → Graph lifecycle tracking.
|
|
664
664
|
*/
|
|
665
|
-
export declare const listFiles: <ThrowOnError extends boolean = false>(options: Options<ListFilesData, ThrowOnError>) =>
|
|
665
|
+
export declare const listFiles: <ThrowOnError extends boolean = false>(options: Options<ListFilesData, ThrowOnError>) => RequestResult<ListFilesResponses, ListFilesErrors, ThrowOnError>;
|
|
666
666
|
/**
|
|
667
667
|
* Get File Information
|
|
668
668
|
*
|
|
669
669
|
* Returns per-layer status (`layers.s3`, `layers.duckdb`, `layers.graph`) for pipeline debugging.
|
|
670
670
|
*/
|
|
671
|
-
export declare const getFile: <ThrowOnError extends boolean = false>(options: Options<GetFileData, ThrowOnError>) =>
|
|
671
|
+
export declare const getFile: <ThrowOnError extends boolean = false>(options: Options<GetFileData, ThrowOnError>) => RequestResult<GetFileResponses, GetFileErrors, ThrowOnError>;
|
|
672
672
|
/**
|
|
673
673
|
* List User Graphs and Repositories
|
|
674
674
|
*/
|
|
675
|
-
export declare const getGraphs: <ThrowOnError extends boolean = false>(options?: Options<GetGraphsData, ThrowOnError>) =>
|
|
675
|
+
export declare const getGraphs: <ThrowOnError extends boolean = false>(options?: Options<GetGraphsData, ThrowOnError>) => RequestResult<GetGraphsResponses, GetGraphsErrors, ThrowOnError>;
|
|
676
676
|
/**
|
|
677
677
|
* Create New Graph Database
|
|
678
678
|
*
|
|
679
679
|
* Creates a graph asynchronously. Returns an `OperationEnvelope` with `operation_id` for SSE progress at `/v1/operations/{operation_id}/stream`. Entity graphs require `initial_entity`. Supports `Idempotency-Key` header.
|
|
680
680
|
*/
|
|
681
|
-
export declare const createGraph: <ThrowOnError extends boolean = false>(options: Options<CreateGraphData, ThrowOnError>) =>
|
|
681
|
+
export declare const createGraph: <ThrowOnError extends boolean = false>(options: Options<CreateGraphData, ThrowOnError>) => RequestResult<CreateGraphResponses, CreateGraphErrors, ThrowOnError>;
|
|
682
682
|
/**
|
|
683
683
|
* Get Available Schema Extensions
|
|
684
684
|
*/
|
|
685
|
-
export declare const getAvailableExtensions: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) =>
|
|
685
|
+
export declare const getAvailableExtensions: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => RequestResult<GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, ThrowOnError>;
|
|
686
686
|
/**
|
|
687
687
|
* Get Available Graph Tiers
|
|
688
688
|
*/
|
|
689
|
-
export declare const getAvailableGraphTiers: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableGraphTiersData, ThrowOnError>) =>
|
|
689
|
+
export declare const getAvailableGraphTiers: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableGraphTiersData, ThrowOnError>) => RequestResult<GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, ThrowOnError>;
|
|
690
690
|
/**
|
|
691
691
|
* Get Graph Tier Capacity
|
|
692
692
|
*
|
|
693
693
|
* Status per tier: `ready` (slot available) or `at_capacity` (contact support).
|
|
694
694
|
*/
|
|
695
|
-
export declare const getGraphCapacity: <ThrowOnError extends boolean = false>(options?: Options<GetGraphCapacityData, ThrowOnError>) =>
|
|
695
|
+
export declare const getGraphCapacity: <ThrowOnError extends boolean = false>(options?: Options<GetGraphCapacityData, ThrowOnError>) => RequestResult<GetGraphCapacityResponses, GetGraphCapacityErrors, ThrowOnError>;
|
|
696
696
|
/**
|
|
697
697
|
* Select Graph
|
|
698
698
|
*/
|
|
699
|
-
export declare const selectGraph: <ThrowOnError extends boolean = false>(options: Options<SelectGraphData, ThrowOnError>) =>
|
|
699
|
+
export declare const selectGraph: <ThrowOnError extends boolean = false>(options: Options<SelectGraphData, ThrowOnError>) => RequestResult<SelectGraphResponses, SelectGraphErrors, ThrowOnError>;
|
|
700
700
|
/**
|
|
701
701
|
* Validate Schema
|
|
702
702
|
*
|
|
703
703
|
* Validates a custom schema definition before deployment — checks structure, types, constraints, and relationship references. Returns errors and warnings without applying changes. Supports JSON, YAML, and dict formats.
|
|
704
704
|
*/
|
|
705
|
-
export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) =>
|
|
705
|
+
export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError>;
|
|
706
706
|
/**
|
|
707
707
|
* Get Service Offerings
|
|
708
708
|
*
|
|
709
709
|
* Returns all subscription tiers, shared repository plans, and AI credit costs. No authentication required.
|
|
710
710
|
*/
|
|
711
|
-
export declare const getServiceOfferings: <ThrowOnError extends boolean = false>(options?: Options<GetServiceOfferingsData, ThrowOnError>) =>
|
|
711
|
+
export declare const getServiceOfferings: <ThrowOnError extends boolean = false>(options?: Options<GetServiceOfferingsData, ThrowOnError>) => RequestResult<GetServiceOfferingsResponses, GetServiceOfferingsErrors, ThrowOnError>;
|
|
712
712
|
/**
|
|
713
713
|
* Stream Operation Events
|
|
714
714
|
*
|
|
715
715
|
* Server-Sent Events stream for real-time operation progress. Use `from_sequence` to replay missed events on reconnect. Max 5 concurrent SSE connections per user. Consumes no credits.
|
|
716
716
|
*/
|
|
717
|
-
export declare const streamOperationEvents: <ThrowOnError extends boolean = false>(options: Options<StreamOperationEventsData, ThrowOnError>) =>
|
|
717
|
+
export declare const streamOperationEvents: <ThrowOnError extends boolean = false>(options: Options<StreamOperationEventsData, ThrowOnError>) => RequestResult<StreamOperationEventsResponses, StreamOperationEventsErrors, ThrowOnError>;
|
|
718
718
|
/**
|
|
719
719
|
* Get Operation Status
|
|
720
720
|
*
|
|
721
721
|
* Point-in-time status check. Use `/stream` for real-time updates. Consumes no credits.
|
|
722
722
|
*/
|
|
723
|
-
export declare const getOperationStatus: <ThrowOnError extends boolean = false>(options: Options<GetOperationStatusData, ThrowOnError>) =>
|
|
723
|
+
export declare const getOperationStatus: <ThrowOnError extends boolean = false>(options: Options<GetOperationStatusData, ThrowOnError>) => RequestResult<GetOperationStatusResponses, GetOperationStatusErrors, ThrowOnError>;
|
|
724
724
|
/**
|
|
725
725
|
* Cancel Operation
|
|
726
726
|
*
|
|
727
727
|
* Cancels a pending or running operation. Emits a cancellation event to any active SSE connections. Cannot cancel completed or failed operations.
|
|
728
728
|
*/
|
|
729
|
-
export declare const cancelOperation: <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) =>
|
|
729
|
+
export declare const cancelOperation: <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) => RequestResult<CancelOperationResponses, CancelOperationErrors, ThrowOnError>;
|
|
730
730
|
/**
|
|
731
731
|
* Resume Operation
|
|
732
732
|
*
|
|
733
733
|
* Answers an operation that paused at a checkpoint (status `awaiting_input`) and puts it back on the worker queue with the answer. The operation keeps its id, so the stream, status and cancel links stay valid; reconnect to `/stream` to follow the resumed run. Consumes no credits.
|
|
734
734
|
*/
|
|
735
|
-
export declare const resumeOperation: <ThrowOnError extends boolean = false>(options: Options<ResumeOperationData, ThrowOnError>) =>
|
|
735
|
+
export declare const resumeOperation: <ThrowOnError extends boolean = false>(options: Options<ResumeOperationData, ThrowOnError>) => RequestResult<ResumeOperationResponses, ResumeOperationErrors, ThrowOnError>;
|
|
736
736
|
/**
|
|
737
737
|
* Get Organization Customer Info
|
|
738
738
|
*
|
|
739
739
|
* Payment method details are only visible to org owners.
|
|
740
740
|
*/
|
|
741
|
-
export declare const getOrgBillingCustomer: <ThrowOnError extends boolean = false>(options: Options<GetOrgBillingCustomerData, ThrowOnError>) =>
|
|
741
|
+
export declare const getOrgBillingCustomer: <ThrowOnError extends boolean = false>(options: Options<GetOrgBillingCustomerData, ThrowOnError>) => RequestResult<GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, ThrowOnError>;
|
|
742
742
|
/**
|
|
743
743
|
* Create Customer Portal Session
|
|
744
744
|
*
|
|
745
745
|
* Returns a Stripe Customer Portal URL for managing payment methods and billing history. Requires org owner role.
|
|
746
746
|
*/
|
|
747
|
-
export declare const createPortalSession: <ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>) =>
|
|
747
|
+
export declare const createPortalSession: <ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>) => RequestResult<CreatePortalSessionResponses, CreatePortalSessionErrors, ThrowOnError>;
|
|
748
748
|
/**
|
|
749
749
|
* List Organization Subscriptions
|
|
750
750
|
*/
|
|
751
|
-
export declare const listOrgSubscriptions: <ThrowOnError extends boolean = false>(options: Options<ListOrgSubscriptionsData, ThrowOnError>) =>
|
|
751
|
+
export declare const listOrgSubscriptions: <ThrowOnError extends boolean = false>(options: Options<ListOrgSubscriptionsData, ThrowOnError>) => RequestResult<ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, ThrowOnError>;
|
|
752
752
|
/**
|
|
753
753
|
* Get Organization Subscription Details
|
|
754
754
|
*/
|
|
755
|
-
export declare const getOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<GetOrgSubscriptionData, ThrowOnError>) =>
|
|
755
|
+
export declare const getOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<GetOrgSubscriptionData, ThrowOnError>) => RequestResult<GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, ThrowOnError>;
|
|
756
756
|
/**
|
|
757
757
|
* Cancel Organization Subscription
|
|
758
758
|
*
|
|
759
759
|
* Cancels a subscription. Default behavior cancels at period end (subscription stays active through the current cycle). Pass `immediate=true` with `confirm=<resource_id>` to terminate now and trigger fast-path deprovisioning of the underlying resource. Requires org owner role.
|
|
760
760
|
*/
|
|
761
|
-
export declare const cancelOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<CancelOrgSubscriptionData, ThrowOnError>) =>
|
|
761
|
+
export declare const cancelOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<CancelOrgSubscriptionData, ThrowOnError>) => RequestResult<CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ThrowOnError>;
|
|
762
762
|
/**
|
|
763
763
|
* List Organization Invoices
|
|
764
764
|
*
|
|
765
765
|
* Requires admin or owner role.
|
|
766
766
|
*/
|
|
767
|
-
export declare const listOrgInvoices: <ThrowOnError extends boolean = false>(options: Options<ListOrgInvoicesData, ThrowOnError>) =>
|
|
767
|
+
export declare const listOrgInvoices: <ThrowOnError extends boolean = false>(options: Options<ListOrgInvoicesData, ThrowOnError>) => RequestResult<ListOrgInvoicesResponses, ListOrgInvoicesErrors, ThrowOnError>;
|
|
768
768
|
/**
|
|
769
769
|
* Get Organization Upcoming Invoice
|
|
770
770
|
*
|
|
771
771
|
* Requires admin or owner role. Returns null if no billing activity yet.
|
|
772
772
|
*/
|
|
773
|
-
export declare const getOrgUpcomingInvoice: <ThrowOnError extends boolean = false>(options: Options<GetOrgUpcomingInvoiceData, ThrowOnError>) =>
|
|
773
|
+
export declare const getOrgUpcomingInvoice: <ThrowOnError extends boolean = false>(options: Options<GetOrgUpcomingInvoiceData, ThrowOnError>) => RequestResult<GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, ThrowOnError>;
|
|
774
774
|
/**
|
|
775
775
|
* Create Payment Checkout Session
|
|
776
776
|
*
|
|
777
777
|
* Initiates a Stripe checkout session for payment collection. Creates a pending subscription; the webhook activates it and provisions the resource after payment completes. Returns billing_disabled=true with no URL when billing is off. Requires org owner role.
|
|
778
778
|
*/
|
|
779
|
-
export declare const createCheckoutSession: <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionData, ThrowOnError>) =>
|
|
779
|
+
export declare const createCheckoutSession: <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionData, ThrowOnError>) => RequestResult<CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, ThrowOnError>;
|
|
780
780
|
/**
|
|
781
781
|
* Get Checkout Session Status
|
|
782
782
|
*
|
|
783
783
|
* Poll after returning from Stripe Checkout. Status progresses: pending_payment → provisioning → active. When active, resource_id is populated. `operation_id` is always null for webhook-driven provisioning and cannot be used to follow progress — poll this endpoint instead.
|
|
784
784
|
*/
|
|
785
|
-
export declare const getCheckoutStatus: <ThrowOnError extends boolean = false>(options: Options<GetCheckoutStatusData, ThrowOnError>) =>
|
|
785
|
+
export declare const getCheckoutStatus: <ThrowOnError extends boolean = false>(options: Options<GetCheckoutStatusData, ThrowOnError>) => RequestResult<GetCheckoutStatusResponses, GetCheckoutStatusErrors, ThrowOnError>;
|
|
786
786
|
/**
|
|
787
787
|
* Handle Http Get
|
|
788
788
|
*
|
|
@@ -792,7 +792,7 @@ export declare const getCheckoutStatus: <ThrowOnError extends boolean = false>(o
|
|
|
792
792
|
*
|
|
793
793
|
* **Error codes**: `LEDGER_NOT_INITIALIZED`, `INVESTOR_NOT_INITIALIZED`, and `UNAUTHENTICATED` surface in the GraphQL `errors[].extensions.code` field — see `graphql/README.md` for the full vocabulary.
|
|
794
794
|
*/
|
|
795
|
-
export declare const handleHttpGetExtensionsGraphIdGraphqlGet: <ThrowOnError extends boolean = false>(options: Options<HandleHttpGetExtensionsGraphIdGraphqlGetData, ThrowOnError>) =>
|
|
795
|
+
export declare const handleHttpGetExtensionsGraphIdGraphqlGet: <ThrowOnError extends boolean = false>(options: Options<HandleHttpGetExtensionsGraphIdGraphqlGetData, ThrowOnError>) => RequestResult<HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, ThrowOnError>;
|
|
796
796
|
/**
|
|
797
797
|
* Handle Http Post
|
|
798
798
|
*
|
|
@@ -802,7 +802,7 @@ export declare const handleHttpGetExtensionsGraphIdGraphqlGet: <ThrowOnError ext
|
|
|
802
802
|
*
|
|
803
803
|
* **Error codes**: `LEDGER_NOT_INITIALIZED`, `INVESTOR_NOT_INITIALIZED`, and `UNAUTHENTICATED` surface in the GraphQL `errors[].extensions.code` field — see `graphql/README.md` for the full vocabulary.
|
|
804
804
|
*/
|
|
805
|
-
export declare const handleHttpPostExtensionsGraphIdGraphqlPost: <ThrowOnError extends boolean = false>(options: Options<HandleHttpPostExtensionsGraphIdGraphqlPostData, ThrowOnError>) =>
|
|
805
|
+
export declare const handleHttpPostExtensionsGraphIdGraphqlPost: <ThrowOnError extends boolean = false>(options: Options<HandleHttpPostExtensionsGraphIdGraphqlPostData, ThrowOnError>) => RequestResult<HandleHttpPostExtensionsGraphIdGraphqlPostResponses, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, ThrowOnError>;
|
|
806
806
|
/**
|
|
807
807
|
* Initialize Ledger
|
|
808
808
|
*
|
|
@@ -810,7 +810,7 @@ export declare const handleHttpPostExtensionsGraphIdGraphqlPost: <ThrowOnError e
|
|
|
810
810
|
*
|
|
811
811
|
* **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.
|
|
812
812
|
*/
|
|
813
|
-
export declare const initializeLedger: <ThrowOnError extends boolean = false>(options: Options<InitializeLedgerData, ThrowOnError>) =>
|
|
813
|
+
export declare const initializeLedger: <ThrowOnError extends boolean = false>(options: Options<InitializeLedgerData, ThrowOnError>) => RequestResult<InitializeLedgerResponses, InitializeLedgerErrors, ThrowOnError>;
|
|
814
814
|
/**
|
|
815
815
|
* Update Entity
|
|
816
816
|
*
|
|
@@ -818,7 +818,7 @@ export declare const initializeLedger: <ThrowOnError extends boolean = false>(op
|
|
|
818
818
|
*
|
|
819
819
|
* **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.
|
|
820
820
|
*/
|
|
821
|
-
export declare const updateEntity: <ThrowOnError extends boolean = false>(options: Options<UpdateEntityData, ThrowOnError>) =>
|
|
821
|
+
export declare const updateEntity: <ThrowOnError extends boolean = false>(options: Options<UpdateEntityData, ThrowOnError>) => RequestResult<UpdateEntityResponses, UpdateEntityErrors, ThrowOnError>;
|
|
822
822
|
/**
|
|
823
823
|
* Change Reporting Style
|
|
824
824
|
*
|
|
@@ -826,7 +826,7 @@ export declare const updateEntity: <ThrowOnError extends boolean = false>(option
|
|
|
826
826
|
*
|
|
827
827
|
* **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.
|
|
828
828
|
*/
|
|
829
|
-
export declare const changeReportingStyle: <ThrowOnError extends boolean = false>(options: Options<ChangeReportingStyleData, ThrowOnError>) =>
|
|
829
|
+
export declare const changeReportingStyle: <ThrowOnError extends boolean = false>(options: Options<ChangeReportingStyleData, ThrowOnError>) => RequestResult<ChangeReportingStyleResponses, ChangeReportingStyleErrors, ThrowOnError>;
|
|
830
830
|
/**
|
|
831
831
|
* Create Taxonomy Block
|
|
832
832
|
*
|
|
@@ -834,7 +834,7 @@ export declare const changeReportingStyle: <ThrowOnError extends boolean = false
|
|
|
834
834
|
*
|
|
835
835
|
* **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.
|
|
836
836
|
*/
|
|
837
|
-
export declare const createTaxonomyBlock: <ThrowOnError extends boolean = false>(options: Options<CreateTaxonomyBlockData, ThrowOnError>) =>
|
|
837
|
+
export declare const createTaxonomyBlock: <ThrowOnError extends boolean = false>(options: Options<CreateTaxonomyBlockData, ThrowOnError>) => RequestResult<CreateTaxonomyBlockResponses, CreateTaxonomyBlockErrors, ThrowOnError>;
|
|
838
838
|
/**
|
|
839
839
|
* Update Taxonomy Block
|
|
840
840
|
*
|
|
@@ -842,7 +842,7 @@ export declare const createTaxonomyBlock: <ThrowOnError extends boolean = false>
|
|
|
842
842
|
*
|
|
843
843
|
* **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.
|
|
844
844
|
*/
|
|
845
|
-
export declare const updateTaxonomyBlock: <ThrowOnError extends boolean = false>(options: Options<UpdateTaxonomyBlockData, ThrowOnError>) =>
|
|
845
|
+
export declare const updateTaxonomyBlock: <ThrowOnError extends boolean = false>(options: Options<UpdateTaxonomyBlockData, ThrowOnError>) => RequestResult<UpdateTaxonomyBlockResponses, UpdateTaxonomyBlockErrors, ThrowOnError>;
|
|
846
846
|
/**
|
|
847
847
|
* Delete Taxonomy Block
|
|
848
848
|
*
|
|
@@ -850,7 +850,7 @@ export declare const updateTaxonomyBlock: <ThrowOnError extends boolean = false>
|
|
|
850
850
|
*
|
|
851
851
|
* **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.
|
|
852
852
|
*/
|
|
853
|
-
export declare const deleteTaxonomyBlock: <ThrowOnError extends boolean = false>(options: Options<DeleteTaxonomyBlockData, ThrowOnError>) =>
|
|
853
|
+
export declare const deleteTaxonomyBlock: <ThrowOnError extends boolean = false>(options: Options<DeleteTaxonomyBlockData, ThrowOnError>) => RequestResult<DeleteTaxonomyBlockResponses, DeleteTaxonomyBlockErrors, ThrowOnError>;
|
|
854
854
|
/**
|
|
855
855
|
* Link Entity to Taxonomy
|
|
856
856
|
*
|
|
@@ -858,7 +858,7 @@ export declare const deleteTaxonomyBlock: <ThrowOnError extends boolean = false>
|
|
|
858
858
|
*
|
|
859
859
|
* **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.
|
|
860
860
|
*/
|
|
861
|
-
export declare const linkEntityTaxonomy: <ThrowOnError extends boolean = false>(options: Options<LinkEntityTaxonomyData, ThrowOnError>) =>
|
|
861
|
+
export declare const linkEntityTaxonomy: <ThrowOnError extends boolean = false>(options: Options<LinkEntityTaxonomyData, ThrowOnError>) => RequestResult<LinkEntityTaxonomyResponses, LinkEntityTaxonomyErrors, ThrowOnError>;
|
|
862
862
|
/**
|
|
863
863
|
* Create Mapping Association
|
|
864
864
|
*
|
|
@@ -866,7 +866,7 @@ export declare const linkEntityTaxonomy: <ThrowOnError extends boolean = false>(
|
|
|
866
866
|
*
|
|
867
867
|
* **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.
|
|
868
868
|
*/
|
|
869
|
-
export declare const createMappingAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateMappingAssociationData, ThrowOnError>) =>
|
|
869
|
+
export declare const createMappingAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateMappingAssociationData, ThrowOnError>) => RequestResult<CreateMappingAssociationResponses, CreateMappingAssociationErrors, ThrowOnError>;
|
|
870
870
|
/**
|
|
871
871
|
* Delete Mapping Association
|
|
872
872
|
*
|
|
@@ -874,7 +874,7 @@ export declare const createMappingAssociation: <ThrowOnError extends boolean = f
|
|
|
874
874
|
*
|
|
875
875
|
* **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.
|
|
876
876
|
*/
|
|
877
|
-
export declare const deleteMappingAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteMappingAssociationData, ThrowOnError>) =>
|
|
877
|
+
export declare const deleteMappingAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteMappingAssociationData, ThrowOnError>) => RequestResult<DeleteMappingAssociationResponses, DeleteMappingAssociationErrors, ThrowOnError>;
|
|
878
878
|
/**
|
|
879
879
|
* Auto-Map Elements via AI (async)
|
|
880
880
|
*
|
|
@@ -882,7 +882,7 @@ export declare const deleteMappingAssociation: <ThrowOnError extends boolean = f
|
|
|
882
882
|
*
|
|
883
883
|
* **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.
|
|
884
884
|
*/
|
|
885
|
-
export declare const autoMapElements: <ThrowOnError extends boolean = false>(options: Options<AutoMapElementsData, ThrowOnError>) =>
|
|
885
|
+
export declare const autoMapElements: <ThrowOnError extends boolean = false>(options: Options<AutoMapElementsData, ThrowOnError>) => RequestResult<AutoMapElementsResponses, AutoMapElementsErrors, ThrowOnError>;
|
|
886
886
|
/**
|
|
887
887
|
* Create Information Block
|
|
888
888
|
*
|
|
@@ -890,7 +890,7 @@ export declare const autoMapElements: <ThrowOnError extends boolean = false>(opt
|
|
|
890
890
|
*
|
|
891
891
|
* **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.
|
|
892
892
|
*/
|
|
893
|
-
export declare const createInformationBlock: <ThrowOnError extends boolean = false>(options: Options<CreateInformationBlockData, ThrowOnError>) =>
|
|
893
|
+
export declare const createInformationBlock: <ThrowOnError extends boolean = false>(options: Options<CreateInformationBlockData, ThrowOnError>) => RequestResult<CreateInformationBlockResponses, CreateInformationBlockErrors, ThrowOnError>;
|
|
894
894
|
/**
|
|
895
895
|
* Update Information Block
|
|
896
896
|
*
|
|
@@ -898,7 +898,7 @@ export declare const createInformationBlock: <ThrowOnError extends boolean = fal
|
|
|
898
898
|
*
|
|
899
899
|
* **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.
|
|
900
900
|
*/
|
|
901
|
-
export declare const updateInformationBlock: <ThrowOnError extends boolean = false>(options: Options<UpdateInformationBlockData, ThrowOnError>) =>
|
|
901
|
+
export declare const updateInformationBlock: <ThrowOnError extends boolean = false>(options: Options<UpdateInformationBlockData, ThrowOnError>) => RequestResult<UpdateInformationBlockResponses, UpdateInformationBlockErrors, ThrowOnError>;
|
|
902
902
|
/**
|
|
903
903
|
* Delete Information Block
|
|
904
904
|
*
|
|
@@ -906,7 +906,7 @@ export declare const updateInformationBlock: <ThrowOnError extends boolean = fal
|
|
|
906
906
|
*
|
|
907
907
|
* **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.
|
|
908
908
|
*/
|
|
909
|
-
export declare const deleteInformationBlock: <ThrowOnError extends boolean = false>(options: Options<DeleteInformationBlockData, ThrowOnError>) =>
|
|
909
|
+
export declare const deleteInformationBlock: <ThrowOnError extends boolean = false>(options: Options<DeleteInformationBlockData, ThrowOnError>) => RequestResult<DeleteInformationBlockResponses, DeleteInformationBlockErrors, ThrowOnError>;
|
|
910
910
|
/**
|
|
911
911
|
* Evaluate Rules for an Information Block
|
|
912
912
|
*
|
|
@@ -914,7 +914,7 @@ export declare const deleteInformationBlock: <ThrowOnError extends boolean = fal
|
|
|
914
914
|
*
|
|
915
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.
|
|
916
916
|
*/
|
|
917
|
-
export declare const evaluateRules: <ThrowOnError extends boolean = false>(options: Options<EvaluateRulesData, ThrowOnError>) =>
|
|
917
|
+
export declare const evaluateRules: <ThrowOnError extends boolean = false>(options: Options<EvaluateRulesData, ThrowOnError>) => RequestResult<EvaluateRulesResponses, EvaluateRulesErrors, ThrowOnError>;
|
|
918
918
|
/**
|
|
919
919
|
* Compute Metrics for a Metric Block
|
|
920
920
|
*
|
|
@@ -922,7 +922,7 @@ export declare const evaluateRules: <ThrowOnError extends boolean = false>(optio
|
|
|
922
922
|
*
|
|
923
923
|
* **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.
|
|
924
924
|
*/
|
|
925
|
-
export declare const computeMetrics: <ThrowOnError extends boolean = false>(options: Options<ComputeMetricsData, ThrowOnError>) =>
|
|
925
|
+
export declare const computeMetrics: <ThrowOnError extends boolean = false>(options: Options<ComputeMetricsData, ThrowOnError>) => RequestResult<ComputeMetricsResponses, ComputeMetricsErrors, ThrowOnError>;
|
|
926
926
|
/**
|
|
927
927
|
* Assert Metrics for a Metric Block
|
|
928
928
|
*
|
|
@@ -930,7 +930,7 @@ export declare const computeMetrics: <ThrowOnError extends boolean = false>(opti
|
|
|
930
930
|
*
|
|
931
931
|
* **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.
|
|
932
932
|
*/
|
|
933
|
-
export declare const assertMetrics: <ThrowOnError extends boolean = false>(options: Options<AssertMetricsData, ThrowOnError>) =>
|
|
933
|
+
export declare const assertMetrics: <ThrowOnError extends boolean = false>(options: Options<AssertMetricsData, ThrowOnError>) => RequestResult<AssertMetricsResponses, AssertMetricsErrors, ThrowOnError>;
|
|
934
934
|
/**
|
|
935
935
|
* Compute Forecast for a Forecast Block
|
|
936
936
|
*
|
|
@@ -938,7 +938,7 @@ export declare const assertMetrics: <ThrowOnError extends boolean = false>(optio
|
|
|
938
938
|
*
|
|
939
939
|
* **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.
|
|
940
940
|
*/
|
|
941
|
-
export declare const computeForecast: <ThrowOnError extends boolean = false>(options: Options<ComputeForecastData, ThrowOnError>) =>
|
|
941
|
+
export declare const computeForecast: <ThrowOnError extends boolean = false>(options: Options<ComputeForecastData, ThrowOnError>) => RequestResult<ComputeForecastResponses, ComputeForecastErrors, ThrowOnError>;
|
|
942
942
|
/**
|
|
943
943
|
* Bind Text Block
|
|
944
944
|
*
|
|
@@ -946,7 +946,7 @@ export declare const computeForecast: <ThrowOnError extends boolean = false>(opt
|
|
|
946
946
|
*
|
|
947
947
|
* **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.
|
|
948
948
|
*/
|
|
949
|
-
export declare const bindTextBlock: <ThrowOnError extends boolean = false>(options: Options<BindTextBlockData, ThrowOnError>) =>
|
|
949
|
+
export declare const bindTextBlock: <ThrowOnError extends boolean = false>(options: Options<BindTextBlockData, ThrowOnError>) => RequestResult<BindTextBlockResponses, BindTextBlockErrors, ThrowOnError>;
|
|
950
950
|
/**
|
|
951
951
|
* Create Agent
|
|
952
952
|
*
|
|
@@ -954,7 +954,7 @@ export declare const bindTextBlock: <ThrowOnError extends boolean = false>(optio
|
|
|
954
954
|
*
|
|
955
955
|
* **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.
|
|
956
956
|
*/
|
|
957
|
-
export declare const createAgent: <ThrowOnError extends boolean = false>(options: Options<CreateAgentData, ThrowOnError>) =>
|
|
957
|
+
export declare const createAgent: <ThrowOnError extends boolean = false>(options: Options<CreateAgentData, ThrowOnError>) => RequestResult<CreateAgentResponses, CreateAgentErrors, ThrowOnError>;
|
|
958
958
|
/**
|
|
959
959
|
* Update Agent
|
|
960
960
|
*
|
|
@@ -962,7 +962,7 @@ export declare const createAgent: <ThrowOnError extends boolean = false>(options
|
|
|
962
962
|
*
|
|
963
963
|
* **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.
|
|
964
964
|
*/
|
|
965
|
-
export declare const updateAgent: <ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>) =>
|
|
965
|
+
export declare const updateAgent: <ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>) => RequestResult<UpdateAgentResponses, UpdateAgentErrors, ThrowOnError>;
|
|
966
966
|
/**
|
|
967
967
|
* Create Event Block
|
|
968
968
|
*
|
|
@@ -970,7 +970,7 @@ export declare const updateAgent: <ThrowOnError extends boolean = false>(options
|
|
|
970
970
|
*
|
|
971
971
|
* **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.
|
|
972
972
|
*/
|
|
973
|
-
export declare const createEventBlock: <ThrowOnError extends boolean = false>(options: Options<CreateEventBlockData, ThrowOnError>) =>
|
|
973
|
+
export declare const createEventBlock: <ThrowOnError extends boolean = false>(options: Options<CreateEventBlockData, ThrowOnError>) => RequestResult<CreateEventBlockResponses, CreateEventBlockErrors, ThrowOnError>;
|
|
974
974
|
/**
|
|
975
975
|
* Update Event Block
|
|
976
976
|
*
|
|
@@ -978,7 +978,7 @@ export declare const createEventBlock: <ThrowOnError extends boolean = false>(op
|
|
|
978
978
|
*
|
|
979
979
|
* **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.
|
|
980
980
|
*/
|
|
981
|
-
export declare const updateEventBlock: <ThrowOnError extends boolean = false>(options: Options<UpdateEventBlockData, ThrowOnError>) =>
|
|
981
|
+
export declare const updateEventBlock: <ThrowOnError extends boolean = false>(options: Options<UpdateEventBlockData, ThrowOnError>) => RequestResult<UpdateEventBlockResponses, UpdateEventBlockErrors, ThrowOnError>;
|
|
982
982
|
/**
|
|
983
983
|
* Execute Event Block (publish to source-of-truth system)
|
|
984
984
|
*
|
|
@@ -986,7 +986,7 @@ export declare const updateEventBlock: <ThrowOnError extends boolean = false>(op
|
|
|
986
986
|
*
|
|
987
987
|
* **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.
|
|
988
988
|
*/
|
|
989
|
-
export declare const executeEventBlock: <ThrowOnError extends boolean = false>(options: Options<ExecuteEventBlockData, ThrowOnError>) =>
|
|
989
|
+
export declare const executeEventBlock: <ThrowOnError extends boolean = false>(options: Options<ExecuteEventBlockData, ThrowOnError>) => RequestResult<ExecuteEventBlockResponses, ExecuteEventBlockErrors, ThrowOnError>;
|
|
990
990
|
/**
|
|
991
991
|
* Create Event Handler
|
|
992
992
|
*
|
|
@@ -994,7 +994,7 @@ export declare const executeEventBlock: <ThrowOnError extends boolean = false>(o
|
|
|
994
994
|
*
|
|
995
995
|
* **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.
|
|
996
996
|
*/
|
|
997
|
-
export declare const createEventHandler: <ThrowOnError extends boolean = false>(options: Options<CreateEventHandlerData, ThrowOnError>) =>
|
|
997
|
+
export declare const createEventHandler: <ThrowOnError extends boolean = false>(options: Options<CreateEventHandlerData, ThrowOnError>) => RequestResult<CreateEventHandlerResponses, CreateEventHandlerErrors, ThrowOnError>;
|
|
998
998
|
/**
|
|
999
999
|
* Update Event Handler
|
|
1000
1000
|
*
|
|
@@ -1002,7 +1002,7 @@ export declare const createEventHandler: <ThrowOnError extends boolean = false>(
|
|
|
1002
1002
|
*
|
|
1003
1003
|
* **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.
|
|
1004
1004
|
*/
|
|
1005
|
-
export declare const updateEventHandler: <ThrowOnError extends boolean = false>(options: Options<UpdateEventHandlerData, ThrowOnError>) =>
|
|
1005
|
+
export declare const updateEventHandler: <ThrowOnError extends boolean = false>(options: Options<UpdateEventHandlerData, ThrowOnError>) => RequestResult<UpdateEventHandlerResponses, UpdateEventHandlerErrors, ThrowOnError>;
|
|
1006
1006
|
/**
|
|
1007
1007
|
* Preview Event Block
|
|
1008
1008
|
*
|
|
@@ -1010,7 +1010,7 @@ export declare const updateEventHandler: <ThrowOnError extends boolean = false>(
|
|
|
1010
1010
|
*
|
|
1011
1011
|
* **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.
|
|
1012
1012
|
*/
|
|
1013
|
-
export declare const previewEventBlock: <ThrowOnError extends boolean = false>(options: Options<PreviewEventBlockData, ThrowOnError>) =>
|
|
1013
|
+
export declare const previewEventBlock: <ThrowOnError extends boolean = false>(options: Options<PreviewEventBlockData, ThrowOnError>) => RequestResult<PreviewEventBlockResponses, PreviewEventBlockErrors, ThrowOnError>;
|
|
1014
1014
|
/**
|
|
1015
1015
|
* Preview Reconciling Item
|
|
1016
1016
|
*
|
|
@@ -1018,7 +1018,7 @@ export declare const previewEventBlock: <ThrowOnError extends boolean = false>(o
|
|
|
1018
1018
|
*
|
|
1019
1019
|
* **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.
|
|
1020
1020
|
*/
|
|
1021
|
-
export declare const previewReconcilingItem: <ThrowOnError extends boolean = false>(options: Options<PreviewReconcilingItemData, ThrowOnError>) =>
|
|
1021
|
+
export declare const previewReconcilingItem: <ThrowOnError extends boolean = false>(options: Options<PreviewReconcilingItemData, ThrowOnError>) => RequestResult<PreviewReconcilingItemResponses, PreviewReconcilingItemErrors, ThrowOnError>;
|
|
1022
1022
|
/**
|
|
1023
1023
|
* Resolve Reconciling Item
|
|
1024
1024
|
*
|
|
@@ -1026,7 +1026,7 @@ export declare const previewReconcilingItem: <ThrowOnError extends boolean = fal
|
|
|
1026
1026
|
*
|
|
1027
1027
|
* **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.
|
|
1028
1028
|
*/
|
|
1029
|
-
export declare const resolveReconcilingItem: <ThrowOnError extends boolean = false>(options: Options<ResolveReconcilingItemData, ThrowOnError>) =>
|
|
1029
|
+
export declare const resolveReconcilingItem: <ThrowOnError extends boolean = false>(options: Options<ResolveReconcilingItemData, ThrowOnError>) => RequestResult<ResolveReconcilingItemResponses, ResolveReconcilingItemErrors, ThrowOnError>;
|
|
1030
1030
|
/**
|
|
1031
1031
|
* Update Journal Entry
|
|
1032
1032
|
*
|
|
@@ -1034,7 +1034,7 @@ export declare const resolveReconcilingItem: <ThrowOnError extends boolean = fal
|
|
|
1034
1034
|
*
|
|
1035
1035
|
* **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.
|
|
1036
1036
|
*/
|
|
1037
|
-
export declare const updateJournalEntry: <ThrowOnError extends boolean = false>(options: Options<UpdateJournalEntryData, ThrowOnError>) =>
|
|
1037
|
+
export declare const updateJournalEntry: <ThrowOnError extends boolean = false>(options: Options<UpdateJournalEntryData, ThrowOnError>) => RequestResult<UpdateJournalEntryResponses, UpdateJournalEntryErrors, ThrowOnError>;
|
|
1038
1038
|
/**
|
|
1039
1039
|
* Delete Journal Entry
|
|
1040
1040
|
*
|
|
@@ -1042,7 +1042,7 @@ export declare const updateJournalEntry: <ThrowOnError extends boolean = false>(
|
|
|
1042
1042
|
*
|
|
1043
1043
|
* **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.
|
|
1044
1044
|
*/
|
|
1045
|
-
export declare const deleteJournalEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteJournalEntryData, ThrowOnError>) =>
|
|
1045
|
+
export declare const deleteJournalEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteJournalEntryData, ThrowOnError>) => RequestResult<DeleteJournalEntryResponses, DeleteJournalEntryErrors, ThrowOnError>;
|
|
1046
1046
|
/**
|
|
1047
1047
|
* Promote Due Schedule Obligations
|
|
1048
1048
|
*
|
|
@@ -1050,7 +1050,7 @@ export declare const deleteJournalEntry: <ThrowOnError extends boolean = false>(
|
|
|
1050
1050
|
*
|
|
1051
1051
|
* **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.
|
|
1052
1052
|
*/
|
|
1053
|
-
export declare const promoteObligations: <ThrowOnError extends boolean = false>(options: Options<PromoteObligationsData, ThrowOnError>) =>
|
|
1053
|
+
export declare const promoteObligations: <ThrowOnError extends boolean = false>(options: Options<PromoteObligationsData, ThrowOnError>) => RequestResult<PromoteObligationsResponses, PromoteObligationsErrors, ThrowOnError>;
|
|
1054
1054
|
/**
|
|
1055
1055
|
* Rebuild Schedule In Place
|
|
1056
1056
|
*
|
|
@@ -1058,7 +1058,7 @@ export declare const promoteObligations: <ThrowOnError extends boolean = false>(
|
|
|
1058
1058
|
*
|
|
1059
1059
|
* **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.
|
|
1060
1060
|
*/
|
|
1061
|
-
export declare const rebuildSchedule: <ThrowOnError extends boolean = false>(options: Options<RebuildScheduleData, ThrowOnError>) =>
|
|
1061
|
+
export declare const rebuildSchedule: <ThrowOnError extends boolean = false>(options: Options<RebuildScheduleData, ThrowOnError>) => RequestResult<RebuildScheduleResponses, RebuildScheduleErrors, ThrowOnError>;
|
|
1062
1062
|
/**
|
|
1063
1063
|
* Terminate Schedule Early (No Entry)
|
|
1064
1064
|
*
|
|
@@ -1066,7 +1066,7 @@ export declare const rebuildSchedule: <ThrowOnError extends boolean = false>(opt
|
|
|
1066
1066
|
*
|
|
1067
1067
|
* **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.
|
|
1068
1068
|
*/
|
|
1069
|
-
export declare const terminateSchedule: <ThrowOnError extends boolean = false>(options: Options<TerminateScheduleData, ThrowOnError>) =>
|
|
1069
|
+
export declare const terminateSchedule: <ThrowOnError extends boolean = false>(options: Options<TerminateScheduleData, ThrowOnError>) => RequestResult<TerminateScheduleResponses, TerminateScheduleErrors, ThrowOnError>;
|
|
1070
1070
|
/**
|
|
1071
1071
|
* Set Close Target
|
|
1072
1072
|
*
|
|
@@ -1074,7 +1074,7 @@ export declare const terminateSchedule: <ThrowOnError extends boolean = false>(o
|
|
|
1074
1074
|
*
|
|
1075
1075
|
* **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.
|
|
1076
1076
|
*/
|
|
1077
|
-
export declare const setCloseTarget: <ThrowOnError extends boolean = false>(options: Options<SetCloseTargetData, ThrowOnError>) =>
|
|
1077
|
+
export declare const setCloseTarget: <ThrowOnError extends boolean = false>(options: Options<SetCloseTargetData, ThrowOnError>) => RequestResult<SetCloseTargetResponses, SetCloseTargetErrors, ThrowOnError>;
|
|
1078
1078
|
/**
|
|
1079
1079
|
* Close Fiscal Period
|
|
1080
1080
|
*
|
|
@@ -1082,7 +1082,7 @@ export declare const setCloseTarget: <ThrowOnError extends boolean = false>(opti
|
|
|
1082
1082
|
*
|
|
1083
1083
|
* **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.
|
|
1084
1084
|
*/
|
|
1085
|
-
export declare const closePeriod: <ThrowOnError extends boolean = false>(options: Options<ClosePeriodData, ThrowOnError>) =>
|
|
1085
|
+
export declare const closePeriod: <ThrowOnError extends boolean = false>(options: Options<ClosePeriodData, ThrowOnError>) => RequestResult<ClosePeriodResponses, ClosePeriodErrors, ThrowOnError>;
|
|
1086
1086
|
/**
|
|
1087
1087
|
* Reopen Fiscal Period
|
|
1088
1088
|
*
|
|
@@ -1090,7 +1090,7 @@ export declare const closePeriod: <ThrowOnError extends boolean = false>(options
|
|
|
1090
1090
|
*
|
|
1091
1091
|
* **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.
|
|
1092
1092
|
*/
|
|
1093
|
-
export declare const reopenPeriod: <ThrowOnError extends boolean = false>(options: Options<ReopenPeriodData, ThrowOnError>) =>
|
|
1093
|
+
export declare const reopenPeriod: <ThrowOnError extends boolean = false>(options: Options<ReopenPeriodData, ThrowOnError>) => RequestResult<ReopenPeriodResponses, ReopenPeriodErrors, ThrowOnError>;
|
|
1094
1094
|
/**
|
|
1095
1095
|
* Backfill Plan History
|
|
1096
1096
|
*
|
|
@@ -1098,7 +1098,7 @@ export declare const reopenPeriod: <ThrowOnError extends boolean = false>(option
|
|
|
1098
1098
|
*
|
|
1099
1099
|
* **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.
|
|
1100
1100
|
*/
|
|
1101
|
-
export declare const backfillPlanHistory: <ThrowOnError extends boolean = false>(options: Options<BackfillPlanHistoryData, ThrowOnError>) =>
|
|
1101
|
+
export declare const backfillPlanHistory: <ThrowOnError extends boolean = false>(options: Options<BackfillPlanHistoryData, ThrowOnError>) => RequestResult<BackfillPlanHistoryResponses, BackfillPlanHistoryErrors, ThrowOnError>;
|
|
1102
1102
|
/**
|
|
1103
1103
|
* Create Report
|
|
1104
1104
|
*
|
|
@@ -1106,7 +1106,7 @@ export declare const backfillPlanHistory: <ThrowOnError extends boolean = false>
|
|
|
1106
1106
|
*
|
|
1107
1107
|
* **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.
|
|
1108
1108
|
*/
|
|
1109
|
-
export declare const createReport: <ThrowOnError extends boolean = false>(options: Options<CreateReportData, ThrowOnError>) =>
|
|
1109
|
+
export declare const createReport: <ThrowOnError extends boolean = false>(options: Options<CreateReportData, ThrowOnError>) => RequestResult<CreateReportResponses, CreateReportErrors, ThrowOnError>;
|
|
1110
1110
|
/**
|
|
1111
1111
|
* Regenerate Report
|
|
1112
1112
|
*
|
|
@@ -1114,7 +1114,7 @@ export declare const createReport: <ThrowOnError extends boolean = false>(option
|
|
|
1114
1114
|
*
|
|
1115
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.
|
|
1116
1116
|
*/
|
|
1117
|
-
export declare const regenerateReport: <ThrowOnError extends boolean = false>(options: Options<RegenerateReportData, ThrowOnError>) =>
|
|
1117
|
+
export declare const regenerateReport: <ThrowOnError extends boolean = false>(options: Options<RegenerateReportData, ThrowOnError>) => RequestResult<RegenerateReportResponses, RegenerateReportErrors, ThrowOnError>;
|
|
1118
1118
|
/**
|
|
1119
1119
|
* Delete Report
|
|
1120
1120
|
*
|
|
@@ -1122,7 +1122,7 @@ export declare const regenerateReport: <ThrowOnError extends boolean = false>(op
|
|
|
1122
1122
|
*
|
|
1123
1123
|
* **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.
|
|
1124
1124
|
*/
|
|
1125
|
-
export declare const deleteReport: <ThrowOnError extends boolean = false>(options: Options<DeleteReportData, ThrowOnError>) =>
|
|
1125
|
+
export declare const deleteReport: <ThrowOnError extends boolean = false>(options: Options<DeleteReportData, ThrowOnError>) => RequestResult<DeleteReportResponses, DeleteReportErrors, ThrowOnError>;
|
|
1126
1126
|
/**
|
|
1127
1127
|
* Share Report
|
|
1128
1128
|
*
|
|
@@ -1130,7 +1130,7 @@ export declare const deleteReport: <ThrowOnError extends boolean = false>(option
|
|
|
1130
1130
|
*
|
|
1131
1131
|
* **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.
|
|
1132
1132
|
*/
|
|
1133
|
-
export declare const shareReport: <ThrowOnError extends boolean = false>(options: Options<ShareReportData, ThrowOnError>) =>
|
|
1133
|
+
export declare const shareReport: <ThrowOnError extends boolean = false>(options: Options<ShareReportData, ThrowOnError>) => RequestResult<ShareReportResponses, ShareReportErrors, ThrowOnError>;
|
|
1134
1134
|
/**
|
|
1135
1135
|
* Revoke Report Share
|
|
1136
1136
|
*
|
|
@@ -1138,7 +1138,7 @@ export declare const shareReport: <ThrowOnError extends boolean = false>(options
|
|
|
1138
1138
|
*
|
|
1139
1139
|
* **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.
|
|
1140
1140
|
*/
|
|
1141
|
-
export declare const revokeReportShare: <ThrowOnError extends boolean = false>(options: Options<RevokeReportShareData, ThrowOnError>) =>
|
|
1141
|
+
export declare const revokeReportShare: <ThrowOnError extends boolean = false>(options: Options<RevokeReportShareData, ThrowOnError>) => RequestResult<RevokeReportShareResponses, RevokeReportShareErrors, ThrowOnError>;
|
|
1142
1142
|
/**
|
|
1143
1143
|
* File Report
|
|
1144
1144
|
*
|
|
@@ -1146,7 +1146,7 @@ export declare const revokeReportShare: <ThrowOnError extends boolean = false>(o
|
|
|
1146
1146
|
*
|
|
1147
1147
|
* **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.
|
|
1148
1148
|
*/
|
|
1149
|
-
export declare const fileReport: <ThrowOnError extends boolean = false>(options: Options<FileReportData, ThrowOnError>) =>
|
|
1149
|
+
export declare const fileReport: <ThrowOnError extends boolean = false>(options: Options<FileReportData, ThrowOnError>) => RequestResult<FileReportResponses, FileReportErrors, ThrowOnError>;
|
|
1150
1150
|
/**
|
|
1151
1151
|
* Transition Filing Status
|
|
1152
1152
|
*
|
|
@@ -1154,7 +1154,7 @@ export declare const fileReport: <ThrowOnError extends boolean = false>(options:
|
|
|
1154
1154
|
*
|
|
1155
1155
|
* **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.
|
|
1156
1156
|
*/
|
|
1157
|
-
export declare const transitionFilingStatus: <ThrowOnError extends boolean = false>(options: Options<TransitionFilingStatusData, ThrowOnError>) =>
|
|
1157
|
+
export declare const transitionFilingStatus: <ThrowOnError extends boolean = false>(options: Options<TransitionFilingStatusData, ThrowOnError>) => RequestResult<TransitionFilingStatusResponses, TransitionFilingStatusErrors, ThrowOnError>;
|
|
1158
1158
|
/**
|
|
1159
1159
|
* Create Publish List
|
|
1160
1160
|
*
|
|
@@ -1162,7 +1162,7 @@ export declare const transitionFilingStatus: <ThrowOnError extends boolean = fal
|
|
|
1162
1162
|
*
|
|
1163
1163
|
* **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.
|
|
1164
1164
|
*/
|
|
1165
|
-
export declare const createPublishList: <ThrowOnError extends boolean = false>(options: Options<CreatePublishListData, ThrowOnError>) =>
|
|
1165
|
+
export declare const createPublishList: <ThrowOnError extends boolean = false>(options: Options<CreatePublishListData, ThrowOnError>) => RequestResult<CreatePublishListResponses, CreatePublishListErrors, ThrowOnError>;
|
|
1166
1166
|
/**
|
|
1167
1167
|
* Update Publish List
|
|
1168
1168
|
*
|
|
@@ -1170,7 +1170,7 @@ export declare const createPublishList: <ThrowOnError extends boolean = false>(o
|
|
|
1170
1170
|
*
|
|
1171
1171
|
* **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.
|
|
1172
1172
|
*/
|
|
1173
|
-
export declare const updatePublishList: <ThrowOnError extends boolean = false>(options: Options<UpdatePublishListData, ThrowOnError>) =>
|
|
1173
|
+
export declare const updatePublishList: <ThrowOnError extends boolean = false>(options: Options<UpdatePublishListData, ThrowOnError>) => RequestResult<UpdatePublishListResponses, UpdatePublishListErrors, ThrowOnError>;
|
|
1174
1174
|
/**
|
|
1175
1175
|
* Delete Publish List
|
|
1176
1176
|
*
|
|
@@ -1178,7 +1178,7 @@ export declare const updatePublishList: <ThrowOnError extends boolean = false>(o
|
|
|
1178
1178
|
*
|
|
1179
1179
|
* **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.
|
|
1180
1180
|
*/
|
|
1181
|
-
export declare const deletePublishList: <ThrowOnError extends boolean = false>(options: Options<DeletePublishListData, ThrowOnError>) =>
|
|
1181
|
+
export declare const deletePublishList: <ThrowOnError extends boolean = false>(options: Options<DeletePublishListData, ThrowOnError>) => RequestResult<DeletePublishListResponses, DeletePublishListErrors, ThrowOnError>;
|
|
1182
1182
|
/**
|
|
1183
1183
|
* Add Members to Publish List
|
|
1184
1184
|
*
|
|
@@ -1186,7 +1186,7 @@ export declare const deletePublishList: <ThrowOnError extends boolean = false>(o
|
|
|
1186
1186
|
*
|
|
1187
1187
|
* **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.
|
|
1188
1188
|
*/
|
|
1189
|
-
export declare const addPublishListMembers: <ThrowOnError extends boolean = false>(options: Options<AddPublishListMembersData, ThrowOnError>) =>
|
|
1189
|
+
export declare const addPublishListMembers: <ThrowOnError extends boolean = false>(options: Options<AddPublishListMembersData, ThrowOnError>) => RequestResult<AddPublishListMembersResponses, AddPublishListMembersErrors, ThrowOnError>;
|
|
1190
1190
|
/**
|
|
1191
1191
|
* Remove Member from Publish List
|
|
1192
1192
|
*
|
|
@@ -1194,7 +1194,7 @@ export declare const addPublishListMembers: <ThrowOnError extends boolean = fals
|
|
|
1194
1194
|
*
|
|
1195
1195
|
* **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.
|
|
1196
1196
|
*/
|
|
1197
|
-
export declare const removePublishListMember: <ThrowOnError extends boolean = false>(options: Options<RemovePublishListMemberData, ThrowOnError>) =>
|
|
1197
|
+
export declare const removePublishListMember: <ThrowOnError extends boolean = false>(options: Options<RemovePublishListMemberData, ThrowOnError>) => RequestResult<RemovePublishListMemberResponses, RemovePublishListMemberErrors, ThrowOnError>;
|
|
1198
1198
|
/**
|
|
1199
1199
|
* Block Source Graph
|
|
1200
1200
|
*
|
|
@@ -1202,7 +1202,7 @@ export declare const removePublishListMember: <ThrowOnError extends boolean = fa
|
|
|
1202
1202
|
*
|
|
1203
1203
|
* **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.
|
|
1204
1204
|
*/
|
|
1205
|
-
export declare const blockSourceGraph: <ThrowOnError extends boolean = false>(options: Options<BlockSourceGraphData, ThrowOnError>) =>
|
|
1205
|
+
export declare const blockSourceGraph: <ThrowOnError extends boolean = false>(options: Options<BlockSourceGraphData, ThrowOnError>) => RequestResult<BlockSourceGraphResponses, BlockSourceGraphErrors, ThrowOnError>;
|
|
1206
1206
|
/**
|
|
1207
1207
|
* Unblock Source Graph
|
|
1208
1208
|
*
|
|
@@ -1210,7 +1210,7 @@ export declare const blockSourceGraph: <ThrowOnError extends boolean = false>(op
|
|
|
1210
1210
|
*
|
|
1211
1211
|
* **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.
|
|
1212
1212
|
*/
|
|
1213
|
-
export declare const unblockSourceGraph: <ThrowOnError extends boolean = false>(options: Options<UnblockSourceGraphData, ThrowOnError>) =>
|
|
1213
|
+
export declare const unblockSourceGraph: <ThrowOnError extends boolean = false>(options: Options<UnblockSourceGraphData, ThrowOnError>) => RequestResult<UnblockSourceGraphResponses, UnblockSourceGraphErrors, ThrowOnError>;
|
|
1214
1214
|
/**
|
|
1215
1215
|
* Live Financial Statement
|
|
1216
1216
|
*
|
|
@@ -1218,7 +1218,7 @@ export declare const unblockSourceGraph: <ThrowOnError extends boolean = false>(
|
|
|
1218
1218
|
*
|
|
1219
1219
|
* **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.
|
|
1220
1220
|
*/
|
|
1221
|
-
export declare const liveFinancialStatement: <ThrowOnError extends boolean = false>(options: Options<LiveFinancialStatementData, ThrowOnError>) =>
|
|
1221
|
+
export declare const liveFinancialStatement: <ThrowOnError extends boolean = false>(options: Options<LiveFinancialStatementData, ThrowOnError>) => RequestResult<LiveFinancialStatementResponses, LiveFinancialStatementErrors, ThrowOnError>;
|
|
1222
1222
|
/**
|
|
1223
1223
|
* Build Fact Grid
|
|
1224
1224
|
*
|
|
@@ -1226,7 +1226,7 @@ export declare const liveFinancialStatement: <ThrowOnError extends boolean = fal
|
|
|
1226
1226
|
*
|
|
1227
1227
|
* **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.
|
|
1228
1228
|
*/
|
|
1229
|
-
export declare const buildFactGrid: <ThrowOnError extends boolean = false>(options: Options<BuildFactGridData, ThrowOnError>) =>
|
|
1229
|
+
export declare const buildFactGrid: <ThrowOnError extends boolean = false>(options: Options<BuildFactGridData, ThrowOnError>) => RequestResult<BuildFactGridResponses, BuildFactGridErrors, ThrowOnError>;
|
|
1230
1230
|
/**
|
|
1231
1231
|
* Financial Statement Analysis
|
|
1232
1232
|
*
|
|
@@ -1234,7 +1234,7 @@ export declare const buildFactGrid: <ThrowOnError extends boolean = false>(optio
|
|
|
1234
1234
|
*
|
|
1235
1235
|
* **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.
|
|
1236
1236
|
*/
|
|
1237
|
-
export declare const financialStatementAnalysis: <ThrowOnError extends boolean = false>(options: Options<FinancialStatementAnalysisData, ThrowOnError>) =>
|
|
1237
|
+
export declare const financialStatementAnalysis: <ThrowOnError extends boolean = false>(options: Options<FinancialStatementAnalysisData, ThrowOnError>) => RequestResult<FinancialStatementAnalysisResponses, FinancialStatementAnalysisErrors, ThrowOnError>;
|
|
1238
1238
|
/**
|
|
1239
1239
|
* Create Portfolio Block
|
|
1240
1240
|
*
|
|
@@ -1242,7 +1242,7 @@ export declare const financialStatementAnalysis: <ThrowOnError extends boolean =
|
|
|
1242
1242
|
*
|
|
1243
1243
|
* **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.
|
|
1244
1244
|
*/
|
|
1245
|
-
export declare const createPortfolioBlock: <ThrowOnError extends boolean = false>(options: Options<CreatePortfolioBlockData, ThrowOnError>) =>
|
|
1245
|
+
export declare const createPortfolioBlock: <ThrowOnError extends boolean = false>(options: Options<CreatePortfolioBlockData, ThrowOnError>) => RequestResult<CreatePortfolioBlockResponses, CreatePortfolioBlockErrors, ThrowOnError>;
|
|
1246
1246
|
/**
|
|
1247
1247
|
* Update Portfolio Block
|
|
1248
1248
|
*
|
|
@@ -1250,7 +1250,7 @@ export declare const createPortfolioBlock: <ThrowOnError extends boolean = false
|
|
|
1250
1250
|
*
|
|
1251
1251
|
* **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.
|
|
1252
1252
|
*/
|
|
1253
|
-
export declare const updatePortfolioBlock: <ThrowOnError extends boolean = false>(options: Options<UpdatePortfolioBlockData, ThrowOnError>) =>
|
|
1253
|
+
export declare const updatePortfolioBlock: <ThrowOnError extends boolean = false>(options: Options<UpdatePortfolioBlockData, ThrowOnError>) => RequestResult<UpdatePortfolioBlockResponses, UpdatePortfolioBlockErrors, ThrowOnError>;
|
|
1254
1254
|
/**
|
|
1255
1255
|
* Delete Portfolio Block
|
|
1256
1256
|
*
|
|
@@ -1258,7 +1258,7 @@ export declare const updatePortfolioBlock: <ThrowOnError extends boolean = false
|
|
|
1258
1258
|
*
|
|
1259
1259
|
* **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.
|
|
1260
1260
|
*/
|
|
1261
|
-
export declare const deletePortfolioBlock: <ThrowOnError extends boolean = false>(options: Options<DeletePortfolioBlockData, ThrowOnError>) =>
|
|
1261
|
+
export declare const deletePortfolioBlock: <ThrowOnError extends boolean = false>(options: Options<DeletePortfolioBlockData, ThrowOnError>) => RequestResult<DeletePortfolioBlockResponses, DeletePortfolioBlockErrors, ThrowOnError>;
|
|
1262
1262
|
/**
|
|
1263
1263
|
* Create Security
|
|
1264
1264
|
*
|
|
@@ -1266,7 +1266,7 @@ export declare const deletePortfolioBlock: <ThrowOnError extends boolean = false
|
|
|
1266
1266
|
*
|
|
1267
1267
|
* **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.
|
|
1268
1268
|
*/
|
|
1269
|
-
export declare const createSecurity: <ThrowOnError extends boolean = false>(options: Options<CreateSecurityData, ThrowOnError>) =>
|
|
1269
|
+
export declare const createSecurity: <ThrowOnError extends boolean = false>(options: Options<CreateSecurityData, ThrowOnError>) => RequestResult<CreateSecurityResponses, CreateSecurityErrors, ThrowOnError>;
|
|
1270
1270
|
/**
|
|
1271
1271
|
* Update Security
|
|
1272
1272
|
*
|
|
@@ -1274,7 +1274,7 @@ export declare const createSecurity: <ThrowOnError extends boolean = false>(opti
|
|
|
1274
1274
|
*
|
|
1275
1275
|
* **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.
|
|
1276
1276
|
*/
|
|
1277
|
-
export declare const updateSecurity: <ThrowOnError extends boolean = false>(options: Options<UpdateSecurityData, ThrowOnError>) =>
|
|
1277
|
+
export declare const updateSecurity: <ThrowOnError extends boolean = false>(options: Options<UpdateSecurityData, ThrowOnError>) => RequestResult<UpdateSecurityResponses, UpdateSecurityErrors, ThrowOnError>;
|
|
1278
1278
|
/**
|
|
1279
1279
|
* Delete Security
|
|
1280
1280
|
*
|
|
@@ -1282,4 +1282,4 @@ export declare const updateSecurity: <ThrowOnError extends boolean = false>(opti
|
|
|
1282
1282
|
*
|
|
1283
1283
|
* **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.
|
|
1284
1284
|
*/
|
|
1285
|
-
export declare const deleteSecurity: <ThrowOnError extends boolean = false>(options: Options<DeleteSecurityData, ThrowOnError>) =>
|
|
1285
|
+
export declare const deleteSecurity: <ThrowOnError extends boolean = false>(options: Options<DeleteSecurityData, ThrowOnError>) => RequestResult<DeleteSecurityResponses, DeleteSecurityErrors, ThrowOnError>;
|